Package io.opentelemetry.api.metrics

Class DefaultMeter.NoopDoubleGaugeBuilder

java.lang.Object

io.opentelemetry.api.metrics.DefaultMeter.NoopDoubleGaugeBuilder

All Implemented Interfaces:

DoubleGaugeBuilder

Enclosing class:

DefaultMeter

private static class DefaultMeter.NoopDoubleGaugeBuilder
extends Object
implements DoubleGaugeBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private static final DefaultMeter.NoopDoubleGauge	NOOP_GAUGE
private static final LongGaugeBuilder	NOOP_LONG_GAUGE_BUILDER
private static final ObservableDoubleGauge	NOOP_OBSERVABLE_GAUGE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopDoubleGaugeBuilder()

Method Summary

Modifier and Type	Method	Description
DoubleGauge	build()	Builds and returns a DoubleGauge instrument with the configuration.
ObservableDoubleMeasurement	buildObserver()	Build an observer for this instrument to observe values from a BatchCallback.
ObservableDoubleGauge	buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)	Builds an Asynchronous Gauge instrument with the given callback.
LongGaugeBuilder	ofLongs()	Sets the Gauge for recording long values.
DoubleGaugeBuilder	setDescription(String description)	Sets the description for this instrument.
DoubleGaugeBuilder	setUnit(String unit)	Sets the unit of measure for this instrument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NOOP_OBSERVABLE_GAUGE

private static final ObservableDoubleGauge NOOP_OBSERVABLE_GAUGE

NOOP_LONG_GAUGE_BUILDER

private static final LongGaugeBuilder NOOP_LONG_GAUGE_BUILDER

NOOP_GAUGE

private static final DefaultMeter.NoopDoubleGauge NOOP_GAUGE

Constructor Details

NoopDoubleGaugeBuilder

private NoopDoubleGaugeBuilder()

Method Details

setDescription

public DoubleGaugeBuilder setDescription(String description)

Description copied from interface: DoubleGaugeBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface DoubleGaugeBuilder

Parameters:

description - The description.

See Also:

• Instrument Description

setUnit

public DoubleGaugeBuilder setUnit(String unit)

Description copied from interface: DoubleGaugeBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface DoubleGaugeBuilder

Parameters:

unit - The unit. Instrument units must be 63 or fewer ASCII characters.

See Also:

• Instrument Unit

ofLongs

public LongGaugeBuilder ofLongs()

Description copied from interface: DoubleGaugeBuilder

Sets the Gauge for recording long values.

Specified by:

ofLongs in interface DoubleGaugeBuilder

buildWithCallback

public ObservableDoubleGauge buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)

Description copied from interface: DoubleGaugeBuilder

Builds an Asynchronous Gauge instrument with the given callback.

The callback will be called when the instrument is being observed.

Callbacks are expected to abide by the following restrictions:

• Run in a finite amount of time.
• Safe to call repeatedly, across multiple threads.

Specified by:

buildWithCallback in interface DoubleGaugeBuilder

Parameters:

callback - A callback which observes measurements when invoked.

buildObserver

public ObservableDoubleMeasurement buildObserver()

Description copied from interface: DoubleGaugeBuilder

Build an observer for this instrument to observe values from a BatchCallback.

This observer MUST be registered when creating a batchCallback, which records to it. Values observed outside registered callbacks are ignored.

Specified by:

buildObserver in interface DoubleGaugeBuilder

Returns:

an observable measurement that batch callbacks use to observe values.

build

public DoubleGauge build()

Description copied from interface: DoubleGaugeBuilder

Builds and returns a DoubleGauge instrument with the configuration.

NOTE: This produces a synchronous gauge which records gauge values as they occur. Most users will want to instead register an DoubleGaugeBuilder.buildWithCallback(Consumer) to asynchronously observe the value of the gauge when metrics are collected.

If using the OpenTelemetry SDK, by default gauges use last value aggregation, such that only the value of the last recorded measurement is exported.

Specified by:

build in interface DoubleGaugeBuilder

Returns:

The DoubleGauge instrument.