Meter

zio.telemetry.opentelemetry.metrics.Meter
See theMeter companion object
trait Meter

Provides instruments used to record measurements which are aggregated to metrics.

Attributes

See also
Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def counter(name: String, unit: Option[String], description: Option[String])(implicit trace: Trace): UIO[Counter[Long]]

Constructs a Counter instrument.

Constructs a Counter instrument.

Value parameters

description

description is an optional free-form text provided by the author of the instrument. The API MUST treat it as an opaque string

name

the name of the Counter. Instrument names must consist of 255 or fewer characters including alphanumeric, _, ., -, and start with a letter

unit

instrument units must be 63 or fewer ASCII characters

Attributes

def histogram(name: String, unit: Option[String], description: Option[String], boundaries: Option[Chunk[Double]])(implicit trace: Trace): UIO[Histogram[Double]]

Constructs a Historgram instrument.

Constructs a Historgram instrument.

Value parameters

boundaries

the explicit bucket boundaries advice

description

description is an optional free-form text provided by the author of the instrument. The API MUST treat it as an opaque string

name

the name of the Counter. Instrument names must consist of 255 or fewer characters including alphanumeric, _, ., -, and start with a letter

unit

instrument units must be 63 or fewer ASCII characters

Attributes

def observableCounter(name: String, unit: Option[String], description: Option[String])(callback: (ObservableMeasurement[Long]) => Task[Unit])(implicit trace: Trace): RIO[Scope, Unit]

Builds an Asynchronous Counter instrument with the given callback.

Builds an Asynchronous Counter instrument with the given callback.

Value parameters

callback

callback which observes measurements when invoked

description

description is an optional free-form text provided by the author of the instrument. The API MUST treat it as an opaque string

name

the name of the Counter. Instrument names must consist of 255 or fewer characters including alphanumeric, _, ., -, and start with a letter

unit

instrument units must be 63 or fewer ASCII characters

Attributes

def observableGauge(name: String, unit: Option[String], description: Option[String])(callback: (ObservableMeasurement[Double]) => Task[Unit])(implicit trace: Trace): RIO[Scope, Unit]

Builds an Asynchronous Gauge instrument with the given callback.

Builds an Asynchronous Gauge instrument with the given callback.

Value parameters

callback

callback which observes measurements when invoked

description

description is an optional free-form text provided by the author of the instrument. The API MUST treat it as an opaque string

name

the name of the Counter. Instrument names must consist of 255 or fewer characters including alphanumeric, _, ., -, and start with a letter

unit

instrument units must be 63 or fewer ASCII characters

Attributes

def observableUpDownCounter(name: String, unit: Option[String], description: Option[String])(callback: (ObservableMeasurement[Long]) => Task[Unit])(implicit trace: Trace): RIO[Scope, Unit]

Builds an Asynchronous UpDownCounter instrument with the given callback.

Builds an Asynchronous UpDownCounter instrument with the given callback.

Value parameters

callback

callback which observes measurements when invoked

description

description is an optional free-form text provided by the author of the instrument. The API MUST treat it as an opaque string

name

the name of the Counter. Instrument names must consist of 255 or fewer characters including alphanumeric, _, ., -, and start with a letter

unit

instrument units must be 63 or fewer ASCII characters

Attributes

def upDownCounter(name: String, unit: Option[String], description: Option[String])(implicit trace: Trace): UIO[UpDownCounter[Long]]

Constructs a UpDownCounter instrument.

Constructs a UpDownCounter instrument.

Value parameters

description

description is an optional free-form text provided by the author of the instrument. The API MUST treat it as an opaque string

name

the name of the Counter. Instrument names must consist of 255 or fewer characters including alphanumeric, _, ., -, and start with a letter

unit

instrument units must be 63 or fewer ASCII characters

Attributes