io.opentelemetry.api.events.EventEmitterProvider Maven / Gradle / Ivy

Go to download

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

OpenTelemetry Events API

There is a newer version: 1.36.0-alpha

Show newest version

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

package io.opentelemetry.api.events;

import javax.annotation.concurrent.ThreadSafe;

/**
 * A registry for creating scoped {@link EventEmitter}s. The name Provider is for consistency
 * with other languages and it is NOT loaded using reflection.
 *
 * @see EventEmitter
 */
@ThreadSafe
public interface EventEmitterProvider {

  /**
   * Gets or creates a named EventEmitter instance which emits events to the {@code eventDomain}.
   *
   * @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 Logger instance.
   */
  default EventEmitter get(String instrumentationScopeName) {
    return eventEmitterBuilder(instrumentationScopeName).build();
  }

  /**
   * Creates a LoggerBuilder for a named EventEmitter 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 LoggerBuilder instance.
   */
  EventEmitterBuilder eventEmitterBuilder(String instrumentationScopeName);

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