Package io.opentelemetry.sdk.metrics
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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds and returns a DoubleGauge instrument with the configuration.Build an observer for this instrument to observe values from aBatchCallback
.buildWithCallback
(Consumer<ObservableDoubleMeasurement> callback) Builds an Asynchronous Gauge instrument with the given callback.ofLongs()
Sets the Gauge for recordinglong
values.setAttributesAdvice
(List<AttributeKey<?>> attributes) Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this gauge.setDescription
(String description) Sets the description for this instrument.Sets the unit of measure for this instrument.toString()
-
Field Details
-
builder
-
-
Constructor Details
-
SdkDoubleGaugeBuilder
-
-
Method Details
-
setDescription
Description copied from interface:DoubleGaugeBuilder
Sets the description for this instrument.- Specified by:
setDescription
in interfaceDoubleGaugeBuilder
- Parameters:
description
- The description.- See Also:
-
setUnit
Description copied from interface:DoubleGaugeBuilder
Sets the unit of measure for this instrument.- Specified by:
setUnit
in interfaceDoubleGaugeBuilder
- Parameters:
unit
- The unit. Instrument units must be 63 or fewer ASCII characters.- See Also:
-
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 interfaceDoubleGaugeBuilder
- Returns:
- The DoubleGauge instrument.
-
setAttributesAdvice
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 interfaceExtendedDoubleGaugeBuilder
-
ofLongs
Description copied from interface:DoubleGaugeBuilder
Sets the Gauge for recordinglong
values.- Specified by:
ofLongs
in interfaceDoubleGaugeBuilder
-
buildWithCallback
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 interfaceDoubleGaugeBuilder
- Parameters:
callback
- A callback which observes measurements when invoked.
-
buildObserver
Description copied from interface:DoubleGaugeBuilder
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.- Specified by:
buildObserver
in interfaceDoubleGaugeBuilder
- Returns:
- an observable measurement that batch callbacks use to observe values.
-
toString
-