Skip to content

Commit

Permalink
Clarify "Emit a LogRecord" API (open-telemetry#3383)
Browse files Browse the repository at this point in the history
We discussed in Log SIG today and the current was unclear since it could
be interpreted as API taking LogRecord as an input. This is not the
case. The effect of making this API call is to emit a LogRecord to the
pipeline, but the API does not take a LogRecord as an input. The input
parameters are described in a subsequent paragraph.
  • Loading branch information
tigrannajaryan authored and lmolkova committed Apr 20, 2023
1 parent 75d2c2b commit f4e0d15
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions specification/logs/bridge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,7 @@ The `Logger` MUST provide functions to:

#### Emit a LogRecord

`LogRecord`s encapsulate the fields identified in the [`LogRecord`
data model](data-model.md#log-and-event-record-definition) and are emitted to the processing pipeline using
this API.
The effect of calling this API is to emit a `LogRecord` to the processing pipeline.

The API MUST accept the following parameters:

Expand Down

0 comments on commit f4e0d15

Please sign in to comment.