Class ExtendedDefaultMeter.NoopLongGaugeBuilder
- java.lang.Object
-
- io.opentelemetry.api.incubator.metrics.ExtendedDefaultMeter.NoopLongGaugeBuilder
-
- All Implemented Interfaces:
ExtendedLongGaugeBuilder
,LongGaugeBuilder
- Enclosing class:
- ExtendedDefaultMeter
private static class ExtendedDefaultMeter.NoopLongGaugeBuilder extends java.lang.Object implements ExtendedLongGaugeBuilder
-
-
Field Summary
Fields Modifier and Type Field Description private static ExtendedDefaultMeter.NoopLongGauge
NOOP_GAUGE
private static ObservableLongGauge
NOOP_OBSERVABLE_GAUGE
-
Constructor Summary
Constructors Modifier Constructor Description private
NoopLongGaugeBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LongGauge
build()
Builds and returns a LongGauge instrument with the configuration.ObservableLongMeasurement
buildObserver()
Build an observer for this instrument to observe values from aBatchCallback
.ObservableLongGauge
buildWithCallback(java.util.function.Consumer<ObservableLongMeasurement> callback)
Builds an Asynchronous Gauge instrument with the given callback.LongGaugeBuilder
setDescription(java.lang.String description)
Sets the description for this instrument.LongGaugeBuilder
setUnit(java.lang.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
-
Methods inherited from interface io.opentelemetry.api.incubator.metrics.ExtendedLongGaugeBuilder
setAttributesAdvice
-
-
-
-
Field Detail
-
NOOP_OBSERVABLE_GAUGE
private static final ObservableLongGauge NOOP_OBSERVABLE_GAUGE
-
NOOP_GAUGE
private static final ExtendedDefaultMeter.NoopLongGauge NOOP_GAUGE
-
-
Method Detail
-
setDescription
public LongGaugeBuilder setDescription(java.lang.String description)
Description copied from interface:LongGaugeBuilder
Sets the description for this instrument.- Specified by:
setDescription
in interfaceLongGaugeBuilder
- Parameters:
description
- The description.- See Also:
- Instrument Description
-
setUnit
public LongGaugeBuilder setUnit(java.lang.String unit)
Description copied from interface:LongGaugeBuilder
Sets the unit of measure for this instrument.- Specified by:
setUnit
in interfaceLongGaugeBuilder
- Parameters:
unit
- The unit. Instrument units must be 63 or fewer ASCII characters.- See Also:
- Instrument Unit
-
buildWithCallback
public ObservableLongGauge buildWithCallback(java.util.function.Consumer<ObservableLongMeasurement> callback)
Description copied from interface:LongGaugeBuilder
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 interfaceLongGaugeBuilder
- Parameters:
callback
- A callback which observes measurements when invoked.
-
buildObserver
public ObservableLongMeasurement buildObserver()
Description copied from interface:LongGaugeBuilder
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 interfaceLongGaugeBuilder
- Returns:
- an observable measurement that batch callbacks use to observe values.
-
build
public LongGauge build()
Description copied from interface:LongGaugeBuilder
Builds and returns a LongGauge 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
LongGaugeBuilder.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 interfaceLongGaugeBuilder
- Returns:
- The LongGauge instrument.
-
-