Skip to content

Commit fec6286

Browse files
Remove domain from the Events API (#4569)
* removed domain from the events API * lint * updated changelog --------- Co-authored-by: Marc Pichler <[email protected]>
1 parent 5fb65b4 commit fec6286

File tree

8 files changed

+10
-23
lines changed

8 files changed

+10
-23
lines changed

experimental/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ All notable changes to experimental packages in this project will be documented
1919
* was used internally to keep track of the service client used by the exporter, as a side effect it allowed end-users to modify the gRPC service client that was used
2020
* `compression`
2121
* 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.
22+
* feat(api-events)!: removed domain from the Events API [#4569](https://github.com/open-telemetry/opentelemetry-js/pull/4569)
2223

2324
### :rocket: (Enhancement)
2425

experimental/packages/api-events/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ api.events.getEventEmitterProvider();
3939
const eventEmitter = api.events.getEventEmitter(name, version);
4040

4141
// logging an event in an instrumentation library
42-
eventEmitter.emit({ name: 'event-name', domain: 'event-domain' });
42+
eventEmitter.emit({ name: 'event-name' });
4343
```
4444

4545
## Useful links

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

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ import { NoopEventEmitter } from './NoopEventEmitter';
2222
export class NoopEventEmitterProvider implements EventEmitterProvider {
2323
getEventEmitter(
2424
_name: string,
25-
_domain: string,
2625
_version?: string | undefined,
2726
_options?: EventEmitterOptions | undefined
2827
): EventEmitter {

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

-2
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,11 @@ export class EventsAPI {
7373
*/
7474
public getEventEmitter(
7575
name: string,
76-
domain: string,
7776
version?: string,
7877
options?: EventEmitterOptions
7978
): EventEmitter {
8079
return this.getEventEmitterProvider().getEventEmitter(
8180
name,
82-
domain,
8381
version,
8482
options
8583
);

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

-2
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,12 @@ export interface EventEmitterProvider {
2626
* schemaUrl pair is not already created.
2727
*
2828
* @param name The name of the event emitter or instrumentation library.
29-
* @param domain The domain for events created by the event emitter.
3029
* @param version The version of the event emitter or instrumentation library.
3130
* @param options The options of the event emitter or instrumentation library.
3231
* @returns EventEmitter An event emitter with the given name and version.
3332
*/
3433
getEventEmitter(
3534
name: string,
36-
domain: string,
3735
version?: string,
3836
options?: EventEmitterOptions
3937
): EventEmitter;

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ describe('API', () => {
3737
events.setGlobalEventEmitterProvider(new TestEventEmitterProvider());
3838
const eventEmitter = events
3939
.getEventEmitterProvider()
40-
.getEventEmitter('name', 'domain');
40+
.getEventEmitter('name');
4141
assert.deepStrictEqual(eventEmitter, dummyEventEmitter);
4242
});
4343

@@ -58,7 +58,7 @@ describe('API', () => {
5858

5959
it('should return a event emitter instance from global provider', () => {
6060
events.setGlobalEventEmitterProvider(new TestEventEmitterProvider());
61-
const eventEmitter = events.getEventEmitter('myEventEmitter', 'domain');
61+
const eventEmitter = events.getEventEmitter('myEventEmitter');
6262
assert.deepStrictEqual(eventEmitter, dummyEventEmitter);
6363
});
6464
});

experimental/packages/api-events/test/noop-implementations/noop-event-emitter-provider.test.ts

+4-7
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,15 @@ describe('NoopLoggerProvider', () => {
2323
const eventEmitterProvider = new NoopEventEmitterProvider();
2424

2525
assert.ok(
26-
eventEmitterProvider.getEventEmitter('emitter-name', 'domain') instanceof
26+
eventEmitterProvider.getEventEmitter('emitter-name') instanceof
2727
NoopEventEmitter
2828
);
2929
assert.ok(
30-
eventEmitterProvider.getEventEmitter(
31-
'emitter-name',
32-
'domain',
33-
'v1'
34-
) instanceof NoopEventEmitter
30+
eventEmitterProvider.getEventEmitter('emitter-name', 'v1') instanceof
31+
NoopEventEmitter
3532
);
3633
assert.ok(
37-
eventEmitterProvider.getEventEmitter('emitter-name', 'domain', 'v1', {
34+
eventEmitterProvider.getEventEmitter('emitter-name', 'v1', {
3835
schemaUrl: 'https://opentelemetry.io/schemas/1.7.0',
3936
}) instanceof NoopEventEmitter
4037
);

experimental/packages/api-events/test/noop-implementations/noop-event-emitter.test.ts

+2-8
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,12 @@ import { NoopEventEmitterProvider } from '../../src/NoopEventEmitterProvider';
2020

2121
describe('NoopEventEmitter', () => {
2222
it('constructor should not crash', () => {
23-
const logger = new NoopEventEmitterProvider().getEventEmitter(
24-
'test-noop',
25-
'test-domain'
26-
);
23+
const logger = new NoopEventEmitterProvider().getEventEmitter('test-noop');
2724
assert(logger instanceof NoopEventEmitter);
2825
});
2926

3027
it('calling emit should not crash', () => {
31-
const emitter = new NoopEventEmitterProvider().getEventEmitter(
32-
'test-noop',
33-
'test-domain'
34-
);
28+
const emitter = new NoopEventEmitterProvider().getEventEmitter('test-noop');
3529
emitter.emit({
3630
name: 'event name',
3731
});

0 commit comments

Comments
 (0)