Class

zio.ZIOMetric

Summary

Related Doc: package ZIOMetric

Permalink

final class Summary[A] extends ZIOMetric[A]

A Summary represents a sliding window of a time series along with metrics for certain percentiles of the time series, referred to as quantiles. Quantiles describe specified percentiles of the sliding window that are of interest. For example, if we were using a summary to track the response time for requests over the last hour then we might be interested in the 50th percentile, 90th percentile, 95th percentile, and 99th percentile for response times.

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

Instance Constructors

  1. new Summary(name: String, maxAge: zio.Duration, maxSize: Int, error: Double, quantiles: Chunk[Double], tags: Chunk[MetricLabel], aspect: (Summary[A]) ⇒ MetricAspect[A])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    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]

    Permalink
    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]

    Permalink

    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]

    Permalink
    Definition Classes
    ZIOAspect
  7. def apply[R, E, A1 <: A](zio: ZIO[R, E, A1])(implicit trace: ZTraceElement): ZIO[R, E, A1]

    Permalink
    Definition Classes
    SummaryZIOAspect
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def copy(name: String = name, maxAge: zio.Duration = maxAge, maxSize: Int = maxSize, error: Double = error, quantiles: Chunk[Double] = quantiles, tags: Chunk[MetricLabel] = tags): Summary[A]

    Permalink

    Returns a copy of this summary with the specified name, maximum age, maximum size, error, quantiles, and tags.

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

    Permalink

    Returns the current count of all the values ever observed by this summary.

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(that: Any): Boolean

    Permalink

    Returns whether this summary is equal to the specified summary.

    Returns whether this summary is equal to the specified summary.

    Definition Classes
    Summary → AnyRef → Any
  14. val error: Double

    Permalink
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink

    Returns the hash code of this summary.

    Returns the hash code of this summary.

    Definition Classes
    Summary → AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val maxAge: zio.Duration

    Permalink
  20. val maxSize: Int

    Permalink
  21. lazy val metricType: Class[_ <: (Summary[A]) ⇒ MetricAspect[A]]

    Permalink

    The type of this summary.

    The type of this summary.

    Attributes
    protected
  22. val name: String

    Permalink
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def observe(value: Double)(implicit trace: ZTraceElement): UIO[Any]

    Permalink

    Adds the specified value to the time series represented by this summary, also recording the Instant when the value was observed.

  27. def quantileValues(implicit trace: ZTraceElement): UIO[Chunk[(Double, Option[Double])]]

    Permalink

    Returns the values corresponding to each quantile in this summary.

  28. val quantiles: Chunk[Double]

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

    Permalink

    Returns the current sum of all the values ever observed by this summary.

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def taggedWith(f: (A) ⇒ Chunk[MetricLabel]): ZIOMetric[A]

    Permalink

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

  32. val tags: Chunk[MetricLabel]

    Permalink
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ZIOMetric[A]

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

Inherited from AnyRef

Inherited from Any

Ungrouped