org.apache.rocketmq.shaded.io.opentelemetry.api.metrics.MeterProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rocketmq-client-java

There is a newer version: 5.0.7

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

package org.apache.rocketmq.shaded.io.opentelemetry.api.metrics;

import javax.annotation.concurrent.ThreadSafe;

/**
 * A registry for creating named {@link Meter}s.
 *
 * A MeterProvider represents a configured (or noop) Metric collection system that can be used to
 * instrument code.
 *
 * The name Provider is for consistency with other languages and it is NOT loaded
 * using reflection.
 *
 * @see org.apache.rocketmq.shaded.io.opentelemetry.api.metrics.Meter
 */
@ThreadSafe
public interface MeterProvider {
  /**
   * Gets or creates a named and versioned meter instance.
   *
   * @param instrumentationScopeName A name uniquely identifying the instrumentation scope, such as
   *     the instrumentation library, package, or fully qualified class name. Must not be null.
   * @return a meter instance.
   */
  default Meter get(String instrumentationScopeName) {
    return meterBuilder(instrumentationScopeName).build();
  }

  /**
   * Creates a MeterBuilder for a named meter instance.
   *
   * @param instrumentationScopeName A name uniquely identifying the instrumentation scope, such as
   *     the instrumentation library, package, or fully qualified class name. Must not be null.
   * @return a MeterBuilder instance.
   * @since 1.4.0
   */
  MeterBuilder meterBuilder(String instrumentationScopeName);

  /** Returns a no-op {@link MeterProvider} which provides meters which do not record or emit. */
  static MeterProvider noop() {
    return DefaultMeterProvider.getInstance();
  }
}