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

Clarify parameters for emtting a log record #3354

Merged
merged 17 commits into from
Apr 8, 2023
Merged

Clarify parameters for emtting a log record #3354

Changes from 6 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
031a7bf
Clarify that context is available to Emit LogRecord API
alanwest Mar 31, 2023
9367cfe
Add context as a parameter to Emit
alanwest Mar 31, 2023
2c3635b
Fix typo
alanwest Mar 31, 2023
f8f1ab1
Too legit to emit
alanwest Apr 1, 2023
3727312
Refactor Emit a LogRecord API
alanwest Apr 3, 2023
a7bf061
Merge branch 'main' into alanwest/logs-and-context
alanwest Apr 3, 2023
8ea5db3
Collapse LogRecord section into Logger section
alanwest Apr 3, 2023
9080984
Fix TOC
alanwest Apr 3, 2023
c3bf888
Fix links
alanwest Apr 6, 2023
060ce37
Merge branch 'main' into alanwest/logs-and-context
alanwest Apr 6, 2023
79b67cc
Update specification/logs/bridge-api.md
alanwest Apr 6, 2023
089a54b
Fix links
alanwest Apr 6, 2023
0d8b98d
Merge branch 'alanwest/logs-and-context' of github.com:alanwest/opent…
alanwest Apr 6, 2023
e2a6a55
Merge branch 'main' into alanwest/logs-and-context
alanwest Apr 6, 2023
5f56d0f
Update specification/logs/bridge-api.md
alanwest Apr 6, 2023
7eab96d
Merge remote-tracking branch 'upstream/main' into alanwest/logs-and-c…
alanwest Apr 8, 2023
2ec1d95
Update changelog
alanwest Apr 8, 2023
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
26 changes: 12 additions & 14 deletions specification/logs/bridge-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
+ [Get a Logger](#get-a-logger)
- [Logger](#logger)
* [Logger operations](#logger-operations)
+ [Emit LogRecord](#emit-logrecord)
- [LogRecord](#logrecord)
* [Emit a LogRecord](#emit-a-logrecord)
- [Optional and required parameters](#optional-and-required-parameters)
- [Concurrency requirements](#concurrency-requirements)
- [Usage](#usage)
Expand Down Expand Up @@ -110,27 +110,25 @@ The `Logger` is responsible for emitting `LogRecord`s.

The `Logger` MUST provide functions to:

#### Emit LogRecord
- [Emit a `LogRecord`](#emit-a-logrecord) (see the section on `LogRecord`)

Emit a `LogRecord` to the processing pipeline.

This function MAY be named `logRecord`.

**Parameters:**
## LogRecord
alanwest marked this conversation as resolved.
Show resolved Hide resolved

* `logRecord` - the [LogRecord](#logrecord) to emit.
`LogRecord`s encapsulate the fields identified in the `LogRecord`
[data model](data-model.md).

## LogRecord
### Emit a LogRecord
jack-berg marked this conversation as resolved.
Show resolved Hide resolved

The API emits [LogRecords](#emit-logrecord) using the `LogRecord` [data model](data-model.md).
`LogRecord`s are emitted to the processing pipeline using an API provided by
[`Logger`](#logger).

A function receiving this as an argument MUST be able to set the following
parameters:
The API MUST accept the following parameters:
jack-berg marked this conversation as resolved.
Show resolved Hide resolved

- [Timestamp](./data-model.md#field-timestamp)
- [Observed Timestamp](./data-model.md#field-observedtimestamp)
- [Context](../context/README.md) that contains the
[TraceContext](./data-model.md#trace-context-fields)
- The [Context](../context/README.md) associated with the `LogRecord`. The API
MAY also have an option for implicitly using the current Context as a default
alanwest marked this conversation as resolved.
Show resolved Hide resolved
behavior.
- [Severity Number](./data-model.md#field-severitynumber)
- [Severity Text](./data-model.md#field-severitytext)
- [Body](./data-model.md#field-body)
Expand Down