Fix bad error log #7662
Fix bad error log #7662
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7662 +/- ##
======================================
Coverage ? 86.2%
======================================
Files ? 302
Lines ? 21999
Branches ? 0
======================================
Hits ? 18972
Misses ? 2646
Partials ? 381
🚀 New features to boost your workflow:
|
mexirica
requested review from
MrAlias,
XSAM,
dashpole,
dmathieu,
flc1125 and
pellared
as code owners
Clarify log message fix for dropped key-value pairs.
There was a problem hiding this comment.
The new tests looks like created with help of GenAI. Can you check it there is no redundancy and try to minimize the amount of new tests? At the same time I do not want to increase the complexity of existing tests (I think it is better to have more tests then fewer that are more complex).
| func (r *Record) setDropped(n int) { | ||
| logAttrDropped() | ||
| r.dropped = n | ||
| if n > 0 { |
There was a problem hiding this comment.
This is another fix that should have a changelog entry.
There was a problem hiding this comment.
|
@mexirica , are you able to address the comments? |
Hi, sorry for the delay, Will fix they |
Reduced the number of tests. If that's still not okay, I can clean up more. |
|
|
||
| - Fix bad log message when key-value pairs are dropped because of key duplication in `go.opentelemetry.io/otel/sdk/log`. (#7662) | ||
| - Fix `DroppedAttributes` in `go.opentelemetry.io/otel/sdk/log` to not count the non-attribute key-value pairs dropped because of key duplication. (#7662) | ||
| - Fix `setDropped` in `go.opentelemetry.io/otel/sdk/log` to log dropped keys only when the input quantity is greater than zero. (#7662) |
There was a problem hiding this comment.
| - Fix `setDropped` in `go.opentelemetry.io/otel/sdk/log` to log dropped keys only when the input quantity is greater than zero. (#7662) | |
| - Fix `SetAttributes` in `go.opentelemetry.io/otel/sdk/log` to not log that attributes are dropped when they are actually not dropped. (#7662) | |
| } | ||
| } | ||
|
|
||
| func (r *Record) setDropped(n int) { |
There was a problem hiding this comment.
I think we can now remove setDropped and simply replace it with r.dropped = 0 in SetAttributes method.
| } | ||
| } | ||
|
|
||
| func TestDroppedLoggingOnlyWhenNonZero(t *testing.T) { |
There was a problem hiding this comment.
These test the internals, I do not see any value of these tests as other seem to already cover these cases. This would only make refactoring harder.
2 participants
Fixes: #6983
This pull request enhances logging and error reporting in the log record attribute handling code, specifically around dropped attributes and duplicate key-value pairs. The main focus is to provide clearer warnings when key-value pairs are dropped due to duplication, and to ensure warnings are only logged when actual drops occur.
Improved logging and error handling for dropped attributes and duplicate keys:
logKeyValuePairDroppedwarning (usingsync.OnceFunc) to log a warning message when key-value pairs are dropped due to key duplication. This ensures that duplicate key drops are clearly reported.addDropped,setDropped) to only log attribute drop warnings when the number of dropped attributes is greater than zero, preventing unnecessary log spam.Enhancements to attribute deduplication logic:
logKeyValuePairDroppedin multiple places withinAddAttributes,SetAttributes, andapplyValueLimitsAndDedupto log a warning whenever key-value pairs are dropped due to duplication, ensuring better visibility into attribute handling issues.Code cleanup:
addDroppedafter deduplication, as the logging is now handled directly where drops occur.