This repository has been archived by the owner on May 23, 2023. It is now read-only.
improve documentation for log.Object() #219
Merged
Conversation
This file contains 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
…o pass immutable arguments
Codecov Report
@@ Coverage Diff @@
## master #219 +/- ##
=========================================
Coverage ? 59.32%
=========================================
Files ? 14
Lines ? 831
Branches ? 0
=========================================
Hits ? 493
Misses ? 298
Partials ? 40
Continue to review full report at Codecov.
|
jmacd
reviewed
Aug 29, 2019
| @@ -132,6 +132,9 @@ func Error(err error) Field { | |||
| } | |||
|
|
|||
| // Object adds an object-valued key:value pair to a Span.LogFields() record | |||
| // Please pass in an immutable object, otherwise there may be concurrency issues. | |||
| // Such as passing in the map, log.Object may result in "fatal error: concurrent map iteration and map write". | |||
| // Because span is sent asynchronously, it is possible that this map will also be modified. | |||
There was a problem hiding this comment.
FYI I view this as a bug, but we're trying to retire these libraries in favor of OpenTelemetry, where this will get addressed.
jmacd
approved these changes
Aug 29, 2019
|
Similar issue filed in OpenTelemetry: open-telemetry/opentelemetry-go#105 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
improve documentation for log.Object() to emphasize the requirement to pass immutable arguments
#218