feat: Use logger.warn for log attribute validation #1825
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the way users are notified about invalid log record attribute keys and values by using OpenTelemetry.logger.warn instead of OpenTelemetry.handle_error. Also, include the key with the invalid type in the message.
kaylareopelle
requested review from
fbogsany,
mwear,
robertlaurin,
dazuma,
ericmustin,
arielvalentin,
ahayworth,
plantfansam and
robbkidd
as code owners
| @@ -139,10 +139,10 @@ def validate_attributes(attrs) | |||
| # Future refactor opportunity: https://github.com/open-telemetry/opentelemetry-ruby/issues/1739 | |||
| attrs.keep_if do |k, v| | |||
| if !Internal.valid_key?(k) | |||
| OpenTelemetry.handle_error(message: "invalid log record attribute key type #{k.class} on record: '#{body}'") | |||
| OpenTelemetry.logger.warn("Invalid log record attribute key type #{k.class} for key #{k.inspect} on record: '#{body}'. Attribute keys must be Strings. Dropping attribute.") | |||
There was a problem hiding this comment.
This is going to produce very noisy log output.
Do we log warnings in the SDK for traces?
There was a problem hiding this comment.
Great point. The Trace SDK does not use the logger to warn, instead, we handle the error like the current behavior in the logger. I wonder if updating the message for the handle_error call would be sufficient to let people know about the problem?
Here's the equivalent Trace SDK code:
opentelemetry-ruby/sdk/lib/opentelemetry/sdk/internal.rb
Lines 51 to 63 in 98c629e
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the way users are notified about invalid log record attribute keys and values by using OpenTelemetry.logger.warn instead of OpenTelemetry.handle_error. Also, include the key with the invalid type in the message.
Relates to #1781