Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename EventLogger to EventEmitter #3869

Closed
wants to merge 2 commits into from
Closed

Rename EventLogger to EventEmitter #3869

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66a5e6f
rename EventLogger to EventEmitter
martinkuba Feb 7, 2024
e67affa
update TOC
martinkuba Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions specification/logs/event-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
<!-- toc -->

- [Overview](#overview)
- [EventLogger](#eventlogger)
* [EventLogger Operations](#eventlogger-operations)
+ [Create EventLogger](#create-eventlogger)
- [EventEmitter](#EventEmitter)
* [EventEmitter Operations](#EventEmitter-operations)
+ [Create EventEmitter](#create-EventEmitter)
+ [Emit Event](#emit-event)
- [Optional and required parameters](#optional-and-required-parameters)

Expand Down Expand Up @@ -48,19 +48,19 @@ to the [semantic conventions for Events](/~https://github.com/open-telemetry/seman
Unlike the [Logs Bridge API](./bridge-api.md), application developers and
instrumentation authors are encouraged to call this API directly.

## EventLogger
## EventEmitter

The `EventLogger` is the entrypoint of the Event API, and is responsible for
The `EventEmitter` is the entrypoint of the Event API, and is responsible for
emitting `Events` as `LogRecord`s.

### EventLogger Operations
### EventEmitter Operations

The `EventLogger` MUST provide functions to:
The `EventEmitter` MUST provide functions to:

#### Create EventLogger
#### Create EventEmitter

New `EventLogger` instances are created though a constructor or factory method
on `EventLogger`.
New `EventEmitter` instances are created though a constructor or factory method
on `EventEmitter`.

**Parameters:**

Expand Down Expand Up @@ -89,7 +89,7 @@ This function MAY be named `logEvent`.

The implementation MUST use the parameters
to [emit a logRecord](./bridge-api.md#emit-a-logrecord) using the `logger`
specified when [creating the EventLogger](#create-eventlogger) as follows:
specified when [creating the EventEmitter](#create-EventEmitter) as follows:

* The `Name` MUST be used to set
the `event.name` [Attribute](./data-model.md#field-attributes). If
Expand Down
Loading