Package io.opentelemetry.api.metrics
Interface DoubleGaugeBuilder
-
- All Known Subinterfaces:
ExtendedDoubleGaugeBuilder
- All Known Implementing Classes:
DefaultMeter.NoopDoubleGaugeBuilder
,ExtendedDefaultMeter.NoopDoubleGaugeBuilder
,SdkDoubleGauge.SdkDoubleGaugeBuilder
public interface DoubleGaugeBuilder
A builder for Gauge metric types. These can only be asynchronously collected.- Since:
- 1.10.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default DoubleGauge
build()
Builds and returns a DoubleGauge instrument with the configuration.default ObservableDoubleMeasurement
buildObserver()
Build an observer for this instrument to observe values from aBatchCallback
.ObservableDoubleGauge
buildWithCallback(java.util.function.Consumer<ObservableDoubleMeasurement> callback)
Builds an Asynchronous Gauge instrument with the given callback.LongGaugeBuilder
ofLongs()
Sets the Gauge for recordinglong
values.DoubleGaugeBuilder
setDescription(java.lang.String description)
Sets the description for this instrument.DoubleGaugeBuilder
setUnit(java.lang.String unit)
Sets the unit of measure for this instrument.
-
-
-
Method Detail
-
setDescription
DoubleGaugeBuilder setDescription(java.lang.String description)
Sets the description for this instrument.- Parameters:
description
- The description.- See Also:
- Instrument Description
-
setUnit
DoubleGaugeBuilder setUnit(java.lang.String unit)
Sets the unit of measure for this instrument.- Parameters:
unit
- The unit. Instrument units must be 63 or fewer ASCII characters.- See Also:
- Instrument Unit
-
ofLongs
LongGaugeBuilder ofLongs()
Sets the Gauge for recordinglong
values.
-
buildWithCallback
ObservableDoubleGauge buildWithCallback(java.util.function.Consumer<ObservableDoubleMeasurement> callback)
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.
- Parameters:
callback
- A callback which observes measurements when invoked.
-
buildObserver
default ObservableDoubleMeasurement buildObserver()
Build an observer for this instrument to observe values from aBatchCallback
.This observer MUST be registered when creating a
batchCallback
, which records to it. Values observed outside registered callbacks are ignored.- Returns:
- an observable measurement that batch callbacks use to observe values.
- Since:
- 1.15.0
-
build
default DoubleGauge build()
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
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.
- Returns:
- The DoubleGauge instrument.
- Since:
- 1.38.0
-
-