Packages

o

zio.metrics

MetricClient

object MetricClient

A MetricClient provides the functionality to consume metrics produced by ZIO applications. MetricClient supports 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 unsafeSnapshot method, 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.

MetricClient is a lower level interface and is intended to be used by implementers of integrations with third party metrics services but not by end users.

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def unsafeInstallListener(listener: MetricListener): Unit

    Unsafely installs the specified metric listener.

  18. final def unsafeRemoveListener(listener: MetricListener): Unit

    Unsafely removed the specified metric listener.

  19. final def unsafeState(key: MetricKey): Option[MetricState]

    Unsafely looks up the state of a metric by its key.

  20. final def unsafeStates: Map[MetricKey, MetricState]

    Unsafely captures a snapshot of all metrics recorded by the application.

  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped