package metrics
- Alphabetic
- Public
- All
Type Members
-
sealed
trait
MetricKey extends AnyRef
A
MetricKeyis a unique key associated with each metric.A
MetricKeyis a unique key associated with each metric. The key is based on a combination of the metric type, the name and labels associated with the metric, and any other information to describe a a metric, such as the boundaries of a histogram. In this way, it is impossible to ever create metrics with conflicting keys. -
trait
MetricListener extends AnyRef
A
MetricListeneris capable of taking some action in response to a metric being recorded, such as sending that metric to a third party service. -
final
case class
MetricState(name: String, help: String, labels: Chunk[MetricLabel], details: MetricType) extends Product with Serializable
MetricStaterepresents a snapshot of the current state of a metric as of a poiint in time. -
sealed
trait
MetricType extends AnyRef
MetricTyperepresents information about the state of a metric that is particular to a certain type of metric, such as a histogram as opposed to a counter.
Value Members
-
object
MetricClient
A
MetricClientprovides the functionality to consume metrics produced by ZIO applications.A
MetricClientprovides the functionality to consume metrics produced by ZIO applications.MetricClientsupports two ways of consuming metrics, corresponding to the two ways that third party metrics services use metrics.First, metrics services can poll for the current state of all recorded metrics using the
unsafeSnapshotmethod, which provides a snapshot, as of a point in time, of all metrics recorded by the ZIO application.Second, metrics services can install a listener that will be notified every time a metric is updated.
MetricClientis a lower level interface and is intended to be used by implementers of integrations with third party metrics services but not by end users. - object MetricKey
- object MetricState extends Serializable
- object MetricType