add Events SDK #4629
add Events SDK #4629
Conversation
| ConsoleLogRecordExporter, | ||
| } = require('@opentelemetry/sdk-logs'); | ||
|
|
||
| // The Events SDK has a dependency on the Logs SDK |
There was a problem hiding this comment.
very nit: can you keep a consistency in the comments?
some start with capitalized letter and end with period, others don't. Some have a - between sentences on different lines, some don't.
There was a problem hiding this comment.
I have made a few changes in this file to make the comments more consistent.
| new SimpleLogRecordProcessor(new ConsoleLogRecordExporter()) | ||
| ); | ||
| logs.setGlobalLoggerProvider(loggerProvider); | ||
|
|
There was a problem hiding this comment.
@JamieDanielson you made a comment on the other file to add an example for OTLP exporter, do you think one should also exist here?
Or since there is a link to that example right below is enough?
There was a problem hiding this comment.
None of the other SDK READMEs include OTLP exporters. IMO, this is a good thing, so that the README is focused only on how the package is used. The example is different because users might actually want to run it as is.
|
|
||
| getEventLogger( | ||
| name: string, | ||
| version?: string | undefined, |
There was a problem hiding this comment.
you don't need to add undefined if you're using ? to mark as optional, since it will already be undefined if you don't pass anything.
Same for the options? below
| assert( | ||
| spy.calledWith( | ||
| sinon.match({ | ||
| severityNumber: 9, |
There was a problem hiding this comment.
can you use SeverityNumber.INFO here instead of 9? In case the value ever changes
| // emit a log record | ||
| const eventLogger = events.getEventLogger('example'); | ||
| eventLogger.emit({ | ||
| name: 'my-event', |
There was a problem hiding this comment.
| name: 'my-event', | |
| name: 'my-domain.my-event', |
Just to emphasise using a domain prefix as a recommendation.
This adds details to how EventLoggerProvider and EventLogger should be implemented in the default Events SDK. Prototypes - [JavaScript prototype](open-telemetry/opentelemetry-js#4629) - [Java prototype](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/internal/SdkEventLoggerProvider.java)
Which problem is this PR solving?
This adds an experimental implementation of the Events SDK.
As a related update, I have also updated the Events API with the following:
Type of change
Checklist: