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 guidance regarding excessive logging #3151

Merged
merged 5 commits into from
Feb 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,21 @@ release.

### Traces

- Clarify guidance regarding excessive logging when attributes are dropped
or truncated.
([#3151](https://github.com/open-telemetry/opentelemetry-specification/pull/3151))

### Metrics

### Logs

- Define BatchLogRecordProcessor default configuration values.
([#3002](https://github.com/open-telemetry/opentelemetry-specification/pull/3002))

- Clarify guidance regarding excessive logging when attributes are dropped
or truncated.
([#3151](https://github.com/open-telemetry/opentelemetry-specification/pull/3151))

### Resource

### Semantic Conventions
Expand Down
4 changes: 2 additions & 2 deletions specification/logs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ public interface LogRecordLimits {

There SHOULD be a message printed in the SDK's log to indicate to the user
that an attribute was discarded due to such a limit.
To prevent excessive logging, the message should not be printed once per
`LogRecord` or per discarded attribute.
To prevent excessive logging, the message MUST be printed at most once per
`LogRecord` (i.e., not per discarded attribute).

## LogRecordProcessor

Expand Down
7 changes: 4 additions & 3 deletions specification/trace/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,9 +412,10 @@ public final class SpanLimits {
* `AttributePerEventCountLimit` (Default=128) - Maximum allowed attribute per span event count;
* `AttributePerLinkCountLimit` (Default=128) - Maximum allowed attribute per span link count;

There SHOULD be a log emitted to indicate to the user that an attribute, event,
or link was discarded due to such a limit. To prevent excessive logging, the log
should not be emitted once per span, or per discarded attribute, event, or links.
There SHOULD be a message printed in the SDK's log to indicate to the user
that an attribute was discarded due to such a limit.
To prevent excessive logging, the message MUST be printed at most once per
span (i.e., not per discarded attribute, event, or link).

## Id Generators

Expand Down