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

Conversation

alanwest
Copy link
Member

Fixes #3147

Clarifies guidance with regards to logging when items (attributes, span links/events) are dropped or truncated on spans or log records.

I'm not certain what was originally intended to be communicated, so my initial proposal is to state that a message must only be printed once per Span/LogRecord regardless of how many items were dropped or truncated on the Span/LogRecord. However, some may argue this too may lead to excessive logging.

So the real question is what do we want to communicate here?

Another option may be to state something like:

To prevent excessive logging, an SDK SHOULD take measures to limit how often it notifies the user an attribute was discarded or truncated. The exact measures an SDK takes is not specified.

@alanwest alanwest requested review from a team January 27, 2023 00:59
@carlosalberto
Copy link
Contributor

Let's mention this in the maintainers meeting next Monday, so this is not a surprise, etc.

@tigrannajaryan
Copy link
Member

Let's mention this in the maintainers meeting next Monday, so this is not a surprise, etc.

Good point. I think this also requires a changelog entry.

@arminru arminru added area:sdk Related to the SDK area:error-reporting Related to error reporting labels Jan 31, 2023
@reyang reyang merged commit 17013e7 into open-telemetry:main Feb 4, 2023
@alanwest alanwest deleted the alanwest/excessive-logging branch February 7, 2023 18:10
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:error-reporting Related to error reporting area:sdk Related to the SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Guidelines to prevent excessive logging is confusing
7 participants