Rename EventEmitter to EventLogger in the Events API (#4568)

* renamed EventEmitter to EventLogger

* updated changelog

* renamed remaining references to emitter

* lint

Author: martinkuba

experimental/CHANGELOG.md

@@ -20,6 +20,7 @@ All notable changes to experimental packages in this project will be documented
     * `compression`
       * was used internally to keep track of the compression to use but was unintentionally exposed to the users. It allowed to read and write the value, writing, however, would have no effect.
 * feat(api-events)!: removed domain from the Events API [#4569](https://github.com/open-telemetry/opentelemetry-js/pull/4569)
+* fix(events-api)!: renamed EventEmitter to EventLogger in the Events API [#4569](https://github.com/open-telemetry/opentelemetry-js/pull/4568)
 
 ### :rocket: (Enhancement)
 

experimental/packages/api-events/README.md

@@ -28,18 +28,18 @@ If you are writing an instrumentation library, or prefer to call the API methods
 ```javascript
 const api = require("@opentelemetry/api-events");
 
-/* A specific implementation of EventEmitterProvider comes from an SDK */
-const eventEmitterProvider = createEventEmitterProvider();
+/* A specific implementation of EventLoggerProvider comes from an SDK */
+const eventLoggerProvider = createEventLoggerProvider();
 
-/* Initialize EventEmitterProvider */
-api.events.setGlobalEventEmitterProvider(eventEmitterProvider);
-/* returns eventEmitterProvider (no-op if a working provider has not been initialized) */
-api.events.getEventEmitterProvider();
-/* returns an event emitter from the registered global event emitter provider (no-op if a working provider has not been initialized) */
-const eventEmitter = api.events.getEventEmitter(name, version);
+/* Initialize EventLoggerProvider */
+api.events.setGlobalEventLoggerProvider(eventLoggerProvider);
+/* returns eventLoggerProvider (no-op if a working provider has not been initialized) */
+api.events.getEventLoggerProvider();
+/* returns an event logger from the registered global event logger provider (no-op if a working provider has not been initialized) */
+const eventLogger = api.events.getEventLogger(name, version);
 
 // logging an event in an instrumentation library
-eventEmitter.emit({ name: 'event-name' });
+eventLogger.emit({ name: 'event-name' });
 ```
 
 ## Useful links

experimental/packages/api-events/src/NoopEventEmitter.ts renamed to experimental/packages/api-events/src/NoopEventLogger.ts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { EventEmitter } from './types/EventEmitter';
+import { EventLogger } from './types/EventLogger';
 import { Event } from './types/Event';
 
-export class NoopEventEmitter implements EventEmitter {
+export class NoopEventLogger implements EventLogger {
   emit(_event: Event): void {}
 }

experimental/packages/api-events/src/NoopEventEmitterProvider.ts renamed to experimental/packages/api-events/src/NoopEventLoggerProvider.ts

@@ -14,19 +14,19 @@
  * limitations under the License.
  */
 
-import { EventEmitterProvider } from './types/EventEmitterProvider';
-import { EventEmitter } from './types/EventEmitter';
-import { EventEmitterOptions } from './types/EventEmitterOptions';
-import { NoopEventEmitter } from './NoopEventEmitter';
+import { EventLoggerProvider } from './types/EventLoggerProvider';
+import { EventLogger } from './types/EventLogger';
+import { EventLoggerOptions } from './types/EventLoggerOptions';
+import { NoopEventLogger } from './NoopEventLogger';
 
-export class NoopEventEmitterProvider implements EventEmitterProvider {
-  getEventEmitter(
+export class NoopEventLoggerProvider implements EventLoggerProvider {
+  getEventLogger(
     _name: string,
     _version?: string | undefined,
-    _options?: EventEmitterOptions | undefined
-  ): EventEmitter {
-    return new NoopEventEmitter();
+    _options?: EventLoggerOptions | undefined
+  ): EventLogger {
+    return new NoopEventLogger();
   }
 }
 
-export const NOOP_EVENT_EMITTER_PROVIDER = new NoopEventEmitterProvider();
+export const NOOP_EVENT_LOGGER_PROVIDER = new NoopEventLoggerProvider();

experimental/packages/api-events/src/api/events.ts

@@ -20,10 +20,10 @@ import {
   _global,
   makeGetter,
 } from '../internal/global-utils';
-import { EventEmitterProvider } from '../types/EventEmitterProvider';
-import { NOOP_EVENT_EMITTER_PROVIDER } from '../NoopEventEmitterProvider';
-import { EventEmitter } from '../types/EventEmitter';
-import { EventEmitterOptions } from '../types/EventEmitterOptions';
+import { EventLoggerProvider } from '../types/EventLoggerProvider';
+import { NOOP_EVENT_LOGGER_PROVIDER } from '../NoopEventLoggerProvider';
+import { EventLogger } from '../types/EventLogger';
+import { EventLoggerOptions } from '../types/EventLoggerOptions';
 
 export class EventsAPI {
   private static _instance?: EventsAPI;
@@ -38,52 +38,48 @@ export class EventsAPI {
     return this._instance;
   }
 
-  public setGlobalEventEmitterProvider(
-    provider: EventEmitterProvider
-  ): EventEmitterProvider {
+  public setGlobalEventLoggerProvider(
+    provider: EventLoggerProvider
+  ): EventLoggerProvider {
     if (_global[GLOBAL_EVENTS_API_KEY]) {
-      return this.getEventEmitterProvider();
+      return this.getEventLoggerProvider();
     }
 
-    _global[GLOBAL_EVENTS_API_KEY] = makeGetter<EventEmitterProvider>(
+    _global[GLOBAL_EVENTS_API_KEY] = makeGetter<EventLoggerProvider>(
       API_BACKWARDS_COMPATIBILITY_VERSION,
       provider,
-      NOOP_EVENT_EMITTER_PROVIDER
+      NOOP_EVENT_LOGGER_PROVIDER
     );
 
     return provider;
   }
 
   /**
-   * Returns the global event emitter provider.
+   * Returns the global event logger provider.
    *
-   * @returns EventEmitterProvider
+   * @returns EventLoggerProvider
    */
-  public getEventEmitterProvider(): EventEmitterProvider {
+  public getEventLoggerProvider(): EventLoggerProvider {
     return (
       _global[GLOBAL_EVENTS_API_KEY]?.(API_BACKWARDS_COMPATIBILITY_VERSION) ??
-      NOOP_EVENT_EMITTER_PROVIDER
+      NOOP_EVENT_LOGGER_PROVIDER
     );
   }
 
   /**
-   * Returns a event emitter from the global event emitter provider.
+   * Returns a event logger from the global event logger provider.
    *
-   * @returns EventEmitter
+   * @returns EventLogger
    */
-  public getEventEmitter(
+  public getEventLogger(
     name: string,
     version?: string,
-    options?: EventEmitterOptions
-  ): EventEmitter {
-    return this.getEventEmitterProvider().getEventEmitter(
-      name,
-      version,
-      options
-    );
+    options?: EventLoggerOptions
+  ): EventLogger {
+    return this.getEventLoggerProvider().getEventLogger(name, version, options);
   }
 
-  /** Remove the global event emitter provider */
+  /** Remove the global event logger provider */
   public disable(): void {
     delete _global[GLOBAL_EVENTS_API_KEY];
   }

experimental/packages/api-events/src/index.ts

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-export * from './types/EventEmitter';
-export * from './types/EventEmitterProvider';
+export * from './types/EventLogger';
+export * from './types/EventLoggerProvider';
 export * from './types/Event';
-export * from './types/EventEmitterOptions';
+export * from './types/EventLoggerOptions';
 
 import { EventsAPI } from './api/events';
 export const events = EventsAPI.getInstance();

experimental/packages/api-events/src/internal/global-utils.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { EventEmitterProvider } from '../types/EventEmitterProvider';
+import { EventLoggerProvider } from '../types/EventLoggerProvider';
 import { _globalThis } from '../platform';
 
 export const GLOBAL_EVENTS_API_KEY = Symbol.for(
@@ -23,7 +23,7 @@ export const GLOBAL_EVENTS_API_KEY = Symbol.for(
 
 type Get<T> = (version: number) => T;
 type OtelGlobal = Partial<{
-  [GLOBAL_EVENTS_API_KEY]: Get<EventEmitterProvider>;
+  [GLOBAL_EVENTS_API_KEY]: Get<EventLoggerProvider>;
 }>;
 
 export const _global = _globalThis as OtelGlobal;

experimental/packages/api-events/src/types/EventEmitter.ts renamed to experimental/packages/api-events/src/types/EventLogger.ts

@@ -16,7 +16,7 @@
 
 import { Event } from './Event';
 
-export interface EventEmitter {
+export interface EventLogger {
   /**
    * Emit an event. This method should only be used by instrumentations emitting events.
    *

experimental/packages/api-events/src/types/EventEmitterOptions.ts renamed to experimental/packages/api-events/src/types/EventLoggerOptions.ts

@@ -16,7 +16,7 @@
 
 import { Attributes } from '@opentelemetry/api';
 
-export interface EventEmitterOptions {
+export interface EventLoggerOptions {
   /**
    * The schemaUrl of the tracer or instrumentation library
    * @default ''

experimental/packages/api-events/src/types/EventEmitterProvider.ts renamed to experimental/packages/api-events/src/types/EventLoggerProvider.ts

@@ -14,25 +14,25 @@
  * limitations under the License.
  */
 
-import { EventEmitter } from './EventEmitter';
-import { EventEmitterOptions } from './EventEmitterOptions';
+import { EventLogger } from './EventLogger';
+import { EventLoggerOptions } from './EventLoggerOptions';
 
 /**
- * A registry for creating named {@link EventEmitter}s.
+ * A registry for creating named {@link EventLogger}s.
  */
-export interface EventEmitterProvider {
+export interface EventLoggerProvider {
   /**
-   * Returns an EventEmitter, creating one if one with the given name, version, and
+   * Returns an EventLogger, creating one if one with the given name, version, and
    * schemaUrl pair is not already created.
    *
-   * @param name The name of the event emitter or instrumentation library.
-   * @param version The version of the event emitter or instrumentation library.
-   * @param options The options of the event emitter or instrumentation library.
-   * @returns EventEmitter An event emitter with the given name and version.
+   * @param name The name of the event logger or instrumentation library.
+   * @param version The version of the event logger or instrumentation library.
+   * @param options The options of the event logger or instrumentation library.
+   * @returns EventLogger An event logger with the given name and version.
    */
-  getEventEmitter(
+  getEventLogger(
     name: string,
     version?: string,
-    options?: EventEmitterOptions
-  ): EventEmitter;
+    options?: EventLoggerOptions
+  ): EventLogger;
 }

experimental/packages/api-events/test/api/api.test.ts

@@ -15,57 +15,57 @@
  */
 
 import * as assert from 'assert';
-import { EventEmitter, events } from '../../src';
-import { NoopEventEmitter } from '../../src/NoopEventEmitter';
-import { NoopEventEmitterProvider } from '../../src/NoopEventEmitterProvider';
+import { EventLogger, events } from '../../src';
+import { NoopEventLogger } from '../../src/NoopEventLogger';
+import { NoopEventLoggerProvider } from '../../src/NoopEventLoggerProvider';
 
 describe('API', () => {
-  const dummyEventEmitter = new NoopEventEmitter();
+  const dummyEventLogger = new NoopEventLogger();
 
-  it('should expose a event emitter provider via getEventEmitterProvider', () => {
-    const provider = events.getEventEmitterProvider();
+  it('should expose a event logger provider via getEventLoggerProvider', () => {
+    const provider = events.getEventLoggerProvider();
     assert.ok(provider);
     assert.strictEqual(typeof provider, 'object');
   });
 
-  describe('GlobalEventEmitterProvider', () => {
+  describe('GlobalEventLoggerProvider', () => {
     beforeEach(() => {
       events.disable();
     });
 
-    it('should use the global event emitter provider', () => {
-      events.setGlobalEventEmitterProvider(new TestEventEmitterProvider());
-      const eventEmitter = events
-        .getEventEmitterProvider()
-        .getEventEmitter('name');
-      assert.deepStrictEqual(eventEmitter, dummyEventEmitter);
+    it('should use the global event logger provider', () => {
+      events.setGlobalEventLoggerProvider(new TestEventLoggerProvider());
+      const eventLogger = events
+        .getEventLoggerProvider()
+        .getEventLogger('name');
+      assert.deepStrictEqual(eventLogger, dummyEventLogger);
     });
 
     it('should not allow overriding global provider if already set', () => {
-      const provider1 = new TestEventEmitterProvider();
-      const provider2 = new TestEventEmitterProvider();
-      events.setGlobalEventEmitterProvider(provider1);
-      assert.equal(events.getEventEmitterProvider(), provider1);
-      events.setGlobalEventEmitterProvider(provider2);
-      assert.equal(events.getEventEmitterProvider(), provider1);
+      const provider1 = new TestEventLoggerProvider();
+      const provider2 = new TestEventLoggerProvider();
+      events.setGlobalEventLoggerProvider(provider1);
+      assert.equal(events.getEventLoggerProvider(), provider1);
+      events.setGlobalEventLoggerProvider(provider2);
+      assert.equal(events.getEventLoggerProvider(), provider1);
     });
   });
 
-  describe('getEventEmitter', () => {
+  describe('getEventLogger', () => {
     beforeEach(() => {
       events.disable();
     });
 
-    it('should return a event emitter instance from global provider', () => {
-      events.setGlobalEventEmitterProvider(new TestEventEmitterProvider());
-      const eventEmitter = events.getEventEmitter('myEventEmitter');
-      assert.deepStrictEqual(eventEmitter, dummyEventEmitter);
+    it('should return a event logger instance from global provider', () => {
+      events.setGlobalEventLoggerProvider(new TestEventLoggerProvider());
+      const eventLogger = events.getEventLogger('myEventLogger');
+      assert.deepStrictEqual(eventLogger, dummyEventLogger);
     });
   });
 
-  class TestEventEmitterProvider extends NoopEventEmitterProvider {
-    override getEventEmitter(): EventEmitter {
-      return dummyEventEmitter;
+  class TestEventLoggerProvider extends NoopEventLoggerProvider {
+    override getEventLogger(): EventLogger {
+      return dummyEventLogger;
     }
   }
 });