Packages

object ZIOMetric

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZIOMetric
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract class Counter[-A] extends ZIOMetric[A]

    A Counter is a metric representing a single numerical value that may be incremented over time.

    A Counter is a metric representing a single numerical value that may be incremented over time. A typical use of this metric would be to track the number of a certain type of request received. With a counter the quantity of interest is the cumulative value over time, as opposed to a gauge where the quantity of interest is the value as of a specific point in time.

  2. abstract class Gauge[A] extends ZIOMetric[A]

    A Gauge is a metric representing a single numerical value that may be set or adjusted.

    A Gauge is a metric representing a single numerical value that may be set or adjusted. A typical use of this metric would be to track the current memory usage. With a guage the quantity of interest is the current value, as opposed to a counter where the quantity of interest is the cumulative values over time.

  3. abstract 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 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.

  4. abstract class SetCount[A] extends ZIOMetric[A]

    A SetCount represents the number of occurrences of specified values.

    A SetCount represents the number of occurrences of specified values. You can think of a dry vpimy as like a set of counters associated with each value except that new counters will automatically be created when new values are observed. This could be used to track the frequency of different types of failures, for example.

  5. abstract 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.

    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.

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 adjustGauge(name: String, tags: MetricLabel*): Gauge[Double]

    A metric aspect that adjusts a gauge each time the effect it is applied to succeeds.

  5. def adjustGaugeWith[A](name: String, tags: MetricLabel*)(f: (A) ⇒ Double): Gauge[A]

    A metric aspect that adjusts a gauge each time the effect it is applied to succeeds, using the specified function to transform the value returned by the effect to the value to adjust the gauge with.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def count(name: String, tags: MetricLabel*): Counter[Any]

    A metric aspect that increments the specified counter each time the effect it is applied to succeeds.

  9. def countErrors(name: String, tags: MetricLabel*): Counter[Any]

    A metric aspect that increments the specified counter each time the effect it is applied to fails.

  10. def countValue(name: String, tags: MetricLabel*): Counter[Double]

    A metric aspect that increments the specified counter by a given value.

  11. def countValueWith[A](name: String, tags: MetricLabel*)(f: (A) ⇒ Double): Counter[A]

    A metric aspect that increments the specified counter by a given value.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def observeDurations[A](name: String, boundaries: Boundaries, tags: MetricLabel*)(f: (zio.Duration) ⇒ Double): Histogram[A]

    A metric aspect that tracks how long the effect it is applied to takes to complete execution, recording the results in a histogram.

  22. def observeHistogram(name: String, boundaries: Boundaries, tags: MetricLabel*): Histogram[Double]

    A metric aspect that adds a value to a histogram each time the effect it is applied to succeeds.

  23. def observeHistogramWith[A](name: String, boundaries: Boundaries, tags: MetricLabel*)(f: (A) ⇒ Double): Histogram[A]

    A metric aspect that adds a value to a histogram each time the effect it is applied to succeeds, using the specified function to transform the value returned by the effect to the value to add to the histogram.

  24. def observeSummary(name: String, maxAge: zio.Duration, maxSize: Int, error: Double, quantiles: Chunk[Double], tags: MetricLabel*): Summary[Double]

    A metric aspect that adds a value to a summary each time the effect it is applied to succeeds.

  25. def observeSummaryWith[A](name: String, maxAge: zio.Duration, maxSize: Int, error: Double, quantiles: Chunk[Double], tags: MetricLabel*)(f: (A) ⇒ Double): Summary[A]

    A metric aspect that adds a value to a summary each time the effect it is applied to succeeds, using the specified function to transform the value returned by the effect to the value to add to the summary.

  26. def occurrences(name: String, setTag: String, tags: MetricLabel*): SetCount[String]

    A metric aspect that counts the number of occurrences of each distinct value returned by the effect it is applied to.

  27. def occurrencesWith[A](name: String, setTag: String, tags: MetricLabel*)(f: (A) ⇒ String): SetCount[A]

    A metric aspect that counts the number of occurrences of each distinct value returned by the effect it is applied to, using the specified function to transform the value returned by the effect to the value to count the occurrences of.

  28. def setGauge(name: String, tags: MetricLabel*): Gauge[Double]

    A metric aspect that sets a gauge each time the effect it is applied to succeeds.

  29. def setGaugeWith[A](name: String, tags: MetricLabel*)(f: (A) ⇒ Double): Gauge[A]

    A metric aspect that sets a gauge each time the effect it is applied to succeeds, using the specified function to transform the value returned by the effect to the value to set the gauge to.

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. object Histogram

Inherited from AnyRef

Inherited from Any

Ungrouped