io.opentelemetry.api.incubator.metrics.ExtendedDoubleGauge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentelemetry-api-incubator Show documentation

OpenTelemetry API Incubator

There is a newer version: 1.46.0-alpha

Show newest version

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.api.incubator.metrics;

import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.metrics.DoubleGauge;
import io.opentelemetry.context.Context;

/** Extended {@link DoubleGauge} with experimental APIs. */
public interface ExtendedDoubleGauge extends DoubleGauge {

  /**
   * Returns {@code true} if the gauge is enabled.
   *
   * This allows callers to avoid unnecessary compute when nothing is consuming the data. Because
   * the response is subject to change over the application, callers should call this before each
   * call to {@link #set(double)}, {@link #set(double, Attributes)}, or {@link #set(double,
   * Attributes, Context)}.
   */
  default boolean isEnabled() {
    return true;
  }
}