io.opentelemetry.sdk.metrics.internal.instrument.BoundDoubleUpDownCounter Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.metrics.internal.instrument;
import io.opentelemetry.api.metrics.DoubleUpDownCounter;
import io.opentelemetry.context.Context;
import javax.annotation.concurrent.ThreadSafe;
/**
* An up-down-counter instrument with pre-bound attributes.
*
* This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
@ThreadSafe
public interface BoundDoubleUpDownCounter {
/**
* Records a value with pre-bound attributes.
*
*
Note: This may use {@code Context.current()} to pull the context associated with this
* measurement.
*
* @param value The increment amount. May be positive, negative or zero.
*/
void add(double value);
/**
* Records a value with a pre-bound attributes.
*
* @param value The increment amount. May be positive, negative or zero.
* @param context The explicit context to associate with this measurement.
*/
void add(double value, Context context);
/**
* Unbinds the current bound instance from the {@link DoubleUpDownCounter}.
*
*
After this method returns the current instance is considered invalid (not being managed by
* the instrument). This frees any reserved memory.
*/
void unbind();
}