@ThreadSafe public interface DoubleCounter extends SynchronousInstrument<DoubleCounter.BoundDoubleCounter>
add(double, Labels)
` function for reporting an increment, and is restricted to non-negative
increments. The default aggregation is `Sum`.
Example:
class YourClass {
private static final Meter meter = OpenTelemetry.getMeterProvider().get("my_library_name");
private static final DoubleCounter counter =
meter.
.doubleCounterBuilder("allocated_resources")
.setDescription("Total allocated resources")
.setUnit("1")
.build();
// It is recommended that the API user keep references to a Bound Counters.
private static final BoundDoubleCounter someWorkBound =
counter.bind("work_name", "some_work");
void doSomeWork() {
someWorkBound.add(10.2); // Resources needed for this task.
// Your code here.
}
}
Modifier and Type | Interface and Description |
---|---|
static interface |
DoubleCounter.BoundDoubleCounter
A
Bound Instrument for a DoubleCounter . |
static interface |
DoubleCounter.Builder
Builder class for
DoubleCounter . |
SynchronousInstrument.BoundInstrument
Modifier and Type | Method and Description |
---|---|
void |
add(double increment)
Adds the given
increment to the current value. |
void |
add(double increment,
Labels labels)
Adds the given
increment to the current value. |
DoubleCounter.BoundDoubleCounter |
bind(Labels labels)
Returns a
Bound Instrument associated with the specified labels. |
void add(double increment, Labels labels)
increment
to the current value. The values cannot be negative.
The value added is associated with the current Context
and provided set of labels.
increment
- the value to add.labels
- the labels to be associated to this recording.void add(double increment)
increment
to the current value. The values cannot be negative.
The value added is associated with the current Context
and with empty labels.
increment
- the value to add.DoubleCounter.BoundDoubleCounter bind(Labels labels)
SynchronousInstrument
Bound Instrument
associated with the specified labels. Multiples requests
with the same set of labels may return the same Bound Instrument
instance.
It is recommended that callers keep a reference to the Bound Instrument instead of always calling this method for every operation.
bind
in interface SynchronousInstrument<DoubleCounter.BoundDoubleCounter>
labels
- the set of labels, as key-value pairs.Bound Instrument