Class SdkDoubleGauge.SdkDoubleGaugeBuilder

java.lang.Object

io.opentelemetry.sdk.metrics.SdkDoubleGauge.SdkDoubleGaugeBuilder

All Implemented Interfaces:

ExtendedDoubleGaugeBuilder, DoubleGaugeBuilder

Enclosing class:

SdkDoubleGauge

static final class SdkDoubleGauge.SdkDoubleGaugeBuilder
extends Object
implements ExtendedDoubleGaugeBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private final InstrumentBuilder	builder

Constructor Summary

Constructors

Constructor	Description
SdkDoubleGaugeBuilder(SdkMeter sdkMeter, String name)

Method Summary

Modifier and Type	Method	Description
SdkDoubleGauge	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.
ExtendedDoubleGaugeBuilder	setAttributesAdvice(List<AttributeKey<?>> attributes)	Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this gauge.
DoubleGaugeBuilder	setDescription(String description)	Sets the description for this instrument.
DoubleGaugeBuilder	setUnit(String unit)	Sets the unit of measure for this instrument.
String	toString()

Methods inherited from class Object

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

Field Details

builder

private final InstrumentBuilder builder

Constructor Details

SdkDoubleGaugeBuilder

SdkDoubleGaugeBuilder(SdkMeter sdkMeter,
 String name)

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

build

public SdkDoubleGauge 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.

setAttributesAdvice

public ExtendedDoubleGaugeBuilder setAttributesAdvice(List<AttributeKey<?>> attributes)

Description copied from interface: ExtendedDoubleGaugeBuilder

Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this gauge.

Specified by:

setAttributesAdvice in interface ExtendedDoubleGaugeBuilder

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.

toString

public String toString()

Overrides:

toString in class Object