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

Jump to bottom

Clarify LogRecordProcessor OnEmit context parameter #3387

Closed
wants to merge 1 commit into from
Closed

Clarify LogRecordProcessor OnEmit context parameter #3387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions specification/logs/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,7 @@ therefore it SHOULD NOT block or throw exceptions.
* `logRecord` - a [ReadWriteLogRecord](#readwritelogrecord) for the
emitted `LogRecord`.
* `context` - the `Context` that the SDK determined (the explicitly
passed `Context`, the current `Context`, or an empty `Context` if
the [Logger](./bridge-api.md#get-a-logger) was obtained
with `include_trace_context=false`)
passed `Context` or the current `Context`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: does OnEmit need to know the value of include_trace_context?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related question: should a log's trace context fields be populated if include_trace_context=false and context is explicitly passed? I think yes. However, for languages that rely on explicit context because no implicit context is available, there's no point to having the include_trace_context parameter since it doesn't change any behavior.

We might actually consider removing include_trace_context, since setting it to true seems to only be syntactic sugar for explicitly setting an empty context.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, we should consider it, it is a source of confusion. Created a separate issue here: #3394


**Returns:** `Void`

Expand Down