Packages

final class Histogram[A] extends ZIOMetric[A]

A Histogram is a metric representing a collection of numerical values with the distribution of the cumulative values over time. A typical use of this metric would be to track the time to serve requests. Histograms allow visualizing not only the value of the quantity being measured but its distribution. Histograms are constructed with user specified boundaries which describe the buckets to aggregate values into.

Self Type
Histogram[A]
Linear Supertypes
ZIOMetric[A], ZIOAspect[Nothing, Any, Nothing, Any, Nothing, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Histogram
  2. ZIOMetric
  3. ZIOAspect
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Histogram(name: String, boundaries: Boundaries, tags: Chunk[MetricLabel], aspect: (Histogram[A]) => MetricAspect[A])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def >>>[LowerR1 >: Nothing, UpperR1 <: Any, LowerE1 >: Nothing, UpperE1 <: Any, LowerA1 >: Nothing, UpperA1 <: A](that: ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]): ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]
    Definition Classes
    ZIOAspect
  5. def @@[LowerR1 >: Nothing, UpperR1 <: Any, LowerE1 >: Nothing, UpperE1 <: Any, LowerA1 >: Nothing, UpperA1 <: A](that: ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]): ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]

    Returns a new aspect that represents the sequential composition of this aspect with the specified one.

    Returns a new aspect that represents the sequential composition of this aspect with the specified one.

    Definition Classes
    ZIOAspect
  6. def andThen[LowerR1 >: Nothing, UpperR1 <: Any, LowerE1 >: Nothing, UpperE1 <: Any, LowerA1 >: Nothing, UpperA1 <: A](that: ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]): ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]
    Definition Classes
    ZIOAspect
  7. def apply[R, E, A1 <: A](zio: ZIO[R, E, A1])(implicit trace: ZTraceElement): ZIO[R, E, A1]
    Definition Classes
    Histogram → ZIOAspect
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val boundaries: Boundaries
  10. def buckets(implicit trace: ZTraceElement): UIO[Chunk[(Double, Long)]]

    Returns the current sum and count of values in each bucket of this histogram.

  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def copy(name: String = name, boundaries: Boundaries = boundaries, tags: Chunk[MetricLabel] = tags): Histogram[A]

    Returns a copy of this histogram with the specified name, boundaries, and tags.

  13. def count(implicit trace: ZTraceElement): UIO[Long]

    Returns the current count of values in this histogram.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(that: Any): Boolean

    Returns whether this histogram is equal to the specified histogram.

    Returns whether this histogram is equal to the specified histogram.

    Definition Classes
    Histogram → AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int

    Returns the hash code of this histogram.

    Returns the hash code of this histogram.

    Definition Classes
    Histogram → AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. lazy val metricType: Class[_ <: (Histogram[A]) => MetricAspect[A]]

    The type of this histogram.

    The type of this histogram.

    Attributes
    protected
  21. val name: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def observe(value: Double)(implicit trace: ZTraceElement): UIO[Any]

    Adds the specified value to the distribution of values represented by this histogram.

  26. def sum(implicit trace: ZTraceElement): UIO[Double]

    Returns the current sum of values in this histogram.

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def taggedWith(f: (A) => Chunk[MetricLabel]): ZIOMetric[A]

    Converts this histogram metric to one where the tags depend on the measured effect's result value

  29. val tags: Chunk[MetricLabel]
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from ZIOMetric[A]

Inherited from ZIOAspect[Nothing, Any, Nothing, Any, Nothing, A]

Inherited from AnyRef

Inherited from Any

Ungrouped