@ThreadSafe public interface LongCounter extends SynchronousInstrument<LongCounter.BoundLongCounter>
add(long,
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 LongCounter counter =
meter.
.longCounterBuilder("processed_jobs")
.setDescription("Processed jobs")
.setUnit("1")
.build();
// It is recommended that the API user keep a reference to a Bound Counter.
private static final BoundLongCounter someWorkBound =
counter.bind("work_name", "some_work");
void doSomeWork() {
// Your code here.
someWorkBound.add(10);
}
}
Modifier and Type | Interface and Description |
---|---|
static interface |
LongCounter.BoundLongCounter
A
Bound Instrument for a LongCounter . |
static interface |
LongCounter.Builder
Builder class for
LongCounter . |
SynchronousInstrument.BoundInstrument
Modifier and Type | Method and Description |
---|---|
void |
add(long increment)
Adds the given
increment to the current value. |
void |
add(long increment,
Labels labels)
Adds the given
increment to the current value. |
LongCounter.BoundLongCounter |
bind(Labels labels)
Returns a
Bound Instrument associated with the specified labels. |
void add(long 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 set of labels to be associated to this recording.void add(long increment)
increment
to the current value. The values cannot be negative.
The value added is associated with the current Context
and empty labels.
increment
- the value to add.LongCounter.BoundLongCounter 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<LongCounter.BoundLongCounter>
labels
- the set of labels, as key-value pairs.Bound Instrument