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

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def unsafeInstallListener(listener: MetricListener): Unit

Unsafely installs the specified metric listener.
final def unsafeRemoveListener(listener: MetricListener): Unit

Unsafely removed the specified metric listener.
final def unsafeState(key: MetricKey): Option[MetricState]

Unsafely looks up the state of a metric by its key.
final def unsafeStates: Map[MetricKey, MetricState]

Unsafely captures a snapshot of all metrics recorded by the application.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package metrics

object MetricClient

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def unsafeInstallListener(listener: MetricListener): Unit

final def unsafeRemoveListener(listener: MetricListener): Unit

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

final def unsafeStates: Map[MetricKey, MetricState]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped