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

Add isolating log record processor #4062

Merged
merged 30 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
3cc32ab
Allow independent log processing pipelines
pellared May 28, 2024
e405c6d
Clarify
pellared May 28, 2024
91f47dc
Refactor
pellared May 28, 2024
ee539c5
Rephrase
pellared May 28, 2024
05e6061
Add changelog
pellared May 28, 2024
721f185
Format
pellared May 28, 2024
a6ee1e5
Remove junk
pellared May 28, 2024
bab1025
Merge branch 'main' into fix-4010
pellared May 28, 2024
f3ced5c
Update sdk.md
pellared May 31, 2024
ddeddbe
Update sdk.md
pellared May 31, 2024
d086e7c
Update sdk.md
pellared May 31, 2024
3c96487
Update CHANGELOG.md
pellared May 31, 2024
10db84e
Update CHANGELOG.md
pellared May 31, 2024
3627816
Update sdk.md
pellared May 31, 2024
62777a4
Update sdk.md
pellared May 31, 2024
69ef0f7
Isolated processor instead of fan-out processor
pellared May 31, 2024
c5f943d
Merge branch 'main' into fix-4010
pellared Jun 3, 2024
7ee16e9
Update sdk.md
pellared Jun 3, 2024
89ff3d5
Update sdk.md
pellared Jun 3, 2024
b6a14e9
Merge branch 'main' into fix-4010
pellared Jun 4, 2024
948e81a
Update sdk.md
pellared Jun 4, 2024
eef1f09
Update CHANGELOG.md
pellared Jun 4, 2024
49b0b86
Rename to isolating processor
pellared Jun 4, 2024
dfd03e9
Format
pellared Jun 4, 2024
1b911cc
Update CHANGELOG.md
pellared Jun 4, 2024
320bf6e
Merge branch 'main' into fix-4010
pellared Jun 5, 2024
6bacc83
experimental to development
pellared Jun 5, 2024
d3954d5
Fix typo
pellared Jun 5, 2024
e9925dd
Merge branch 'main' into fix-4010
pellared Jun 18, 2024
e95c895
Merge branch 'main' into fix-4010
pellared Jun 27, 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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ release.

### Logs

- SDK SHOULD allow independent log processing pipelines
([#4062](https://github.com/open-telemetry/opentelemetry-specification/pull/4062))
- SDK MAY offer a way to copy `ReadWriteLogRecord`
([#4062](https://github.com/open-telemetry/opentelemetry-specification/pull/4062))

### Events

- Add specification for EventLogger and EventLoggerProvider
Expand Down
12 changes: 12 additions & 0 deletions specification/logs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,9 @@ the following information added to the [LogRecord](data-model.md#log-and-event-r
* [`SpanId`](./data-model.md#field-spanid)
* [`TraceFlags`](./data-model.md#field-traceflags)

The SDK MAY offer a way to make a copy of `ReadWriteLogRecord`
so that the user can set up independent log processing pipelines.
pellared marked this conversation as resolved.
Show resolved Hide resolved

## LogRecord Limits

`LogRecord` attributes MUST adhere to
Expand Down Expand Up @@ -274,6 +277,11 @@ The SDK MUST allow users to implement and configure custom processors and
decorate built-in processors for advanced scenarios such as enriching with
attributes.

The SDK SHOULD allow users to set up independent processing pipelines.
For instance, the user should be able to make a log record modification in
a processor that is not visible to and does not affect the behavior of other
log record processors.
pellared marked this conversation as resolved.
Show resolved Hide resolved

The following diagram shows `LogRecordProcessor`'s relationship to other
components in the SDK:

Expand Down Expand Up @@ -313,6 +321,10 @@ A `LogRecordProcessor` may freely modify `logRecord` for the duration of
the `OnEmit` call. If `logRecord` is needed after `OnEmit` returns (i.e. for
asynchronous processing) only reads are permitted.

It is implementation specific whether `logRecord` modification are
also applied to the subsequent registered processors.
For instance, `logRecord` may be passed by value or by reference.
pellared marked this conversation as resolved.
Show resolved Hide resolved

#### ShutDown

Shuts down the processor. Called when the SDK is shut down. This is an
Expand Down
Loading