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.

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 that ReadableLogRecord and ReadWriteLogRecord can be represented using a single type #3898

Merged
merged 14 commits into from
Mar 21, 2024
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ release.

- Refine description of Instrumentation Scope.
([#3855](https://github.com/open-telemetry/opentelemetry-specification/pull/3855))
- Clarify that `ReadableLogRecord` and `ReadWriteLogRecord` can be represented using a single type.
([#3898](https://github.com/open-telemetry/opentelemetry-specification/pull/3898))

### Events

Expand Down
6 changes: 3 additions & 3 deletions specification/logs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,7 @@ the responsibility of the `LoggerProvider` instead.

## Additional LogRecord interfaces

In addition to the [definition for LogRecord](data-model.md#log-and-event-record-definition), the
following `LogRecord`-like interfaces are defined in the SDK:
In this document we refer to `ReadableLogRecord` and `ReadWriteLogRecord`, defined as follows.

### ReadableLogRecord

Expand All @@ -150,7 +149,8 @@ the [transformation to non-OTLP formats](../common/mapping-to-non-otlp.md#droppe
specification.

Note: Typically this will be implemented with a new interface or (immutable)
value type.
pellared marked this conversation as resolved.
Show resolved Hide resolved
value type. The SDK may also use a single type to represent both `ReadableLogRecord`
and `ReadWriteLogRecord`.

### ReadWriteLogRecord

Expand Down
Loading