Logs API to have ergonomics for reusing Standard Attributes #4373
+14
−1
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
carlosalberto
changed the title
lmolkova
reviewed
Jan 20, 2025
lmolkova
reviewed
Jan 20, 2025
trask
approved these changes
Jan 21, 2025
Co-authored-by: Trask Stalnaker <[email protected]>
reyang
approved these changes
Jan 21, 2025
reyang
reviewed
Jan 21, 2025
lmolkova
approved these changes
Jan 21, 2025
cijothomas
reviewed
Jan 21, 2025
cijothomas
reviewed
Jan 21, 2025
cijothomas
approved these changes
Jan 21, 2025
pellared
added a commit
to open-telemetry/opentelemetry-go
that referenced
this pull request
Jan 22, 2025
Fixes #6158 Related spec PR: open-telemetry/opentelemetry-specification#4373 Benchmark results: ``` goos: linux goarch: amd64 pkg: go.opentelemetry.io/otel/log cpu: 13th Gen Intel(R) Core(TM) i7-13800H BenchmarkKeyValueFromAttribute/Empty-20 72029505 16.47 ns/op 0 B/op 0 allocs/op BenchmarkKeyValueFromAttribute/Bool-20 68560222 16.99 ns/op 0 B/op 0 allocs/op BenchmarkKeyValueFromAttribute/BoolSlice-20 14647401 76.21 ns/op 50 B/op 2 allocs/op BenchmarkKeyValueFromAttribute/Int64-20 70737378 16.92 ns/op 0 B/op 0 allocs/op BenchmarkKeyValueFromAttribute/Int64Slice-20 16780069 96.87 ns/op 64 B/op 2 allocs/op BenchmarkKeyValueFromAttribute/Float64-20 59299638 16.93 ns/op 0 B/op 0 allocs/op BenchmarkKeyValueFromAttribute/Float64Slice-20 12691222 106.2 ns/op 64 B/op 2 allocs/op BenchmarkKeyValueFromAttribute/String-20 63837711 16.97 ns/op 0 B/op 0 allocs/op BenchmarkKeyValueFromAttribute/StringSlice-20 9251001 114.7 ns/op 80 B/op 2 allocs/op PASS ok go.opentelemetry.io/otel/log 14.776s ```
pellared
changed the title
MrAlias
reviewed
Jan 22, 2025
Comment on lines
+127
to
+133
| The API SHOULD provide ergonomics so that the caller can use | ||
| [Standard Attributes](../common/README.md#standard-attribute) | ||
| along with [Log Attributes](./data-model.md#field-attributes) | ||
| of [type `map<string, any>`](./data-model.md#type-mapstring-any). | ||
| This allows the reuse of [Standard Attributes](../common/README.md#standard-attribute) | ||
| across signals. | ||
| This can be converting functions, method overloads, etc. |
There was a problem hiding this comment.
Ergonomics is the study of people's efficiency in their working environment. Can we be more explicit about what is being recommended here?
Suggested change
| The API SHOULD provide ergonomics so that the caller can use | |
| [Standard Attributes](../common/README.md#standard-attribute) | |
| along with [Log Attributes](./data-model.md#field-attributes) | |
| of [type `map<string, any>`](./data-model.md#type-mapstring-any). | |
| This allows the reuse of [Standard Attributes](../common/README.md#standard-attribute) | |
| across signals. | |
| This can be converting functions, method overloads, etc. | |
| The API SHOULD provide functionality for users to convert from | |
| [Standard Attributes](../common/README.md#standard-attribute) | |
| to [Log Attributes](./data-model.md#field-attributes) | |
| of [type `map<string, any>`](./data-model.md#type-mapstring-any). | |
| This allows the reuse of [Standard Attributes](../common/README.md#standard-attribute) | |
| across signals. |
There was a problem hiding this comment.
TIL 👍
What do you think of
Suggested change
| The API SHOULD provide ergonomics so that the caller can use | |
| [Standard Attributes](../common/README.md#standard-attribute) | |
| along with [Log Attributes](./data-model.md#field-attributes) | |
| of [type `map<string, any>`](./data-model.md#type-mapstring-any). | |
| This allows the reuse of [Standard Attributes](../common/README.md#standard-attribute) | |
| across signals. | |
| This can be converting functions, method overloads, etc. | |
| The API SHOULD provide functionality so that the caller can use | |
| [Standard Attributes](../common/README.md#standard-attribute) | |
| along with [Log Attributes](./data-model.md#field-attributes) | |
| of [type `map<string, any>`](./data-model.md#type-mapstring-any). | |
| This allows the reuse of [Standard Attributes](../common/README.md#standard-attribute) | |
| across signals. | |
| This can be converting functions, method overloads, etc. |
There was a problem hiding this comment.
The last sentence is redundant. "Functionality" is used throughout the specification to imply what that sentence is saying.
Also, we do not plan for users to use standard attributes along with log attributes. We plan for them to convert standard attributes into log attributes and use those.
MrAlias
reviewed
Jan 22, 2025
Comment on lines
+126
to
+127
| [1]: **Status**: [Development](../document-status.md) - | ||
| The API SHOULD provide ergonomics so that the caller can use |
There was a problem hiding this comment.
Having a normative recommendation in a note makes this easy to miss. We should make it clear in its own paragraph.
Suggested change
| [1]: **Status**: [Development](../document-status.md) - | |
| The API SHOULD provide ergonomics so that the caller can use | |
| [1]: **Status**: [Development](../document-status.md) | |
| The API SHOULD provide ergonomics so that the caller can use |
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.
Fixes #4201
Reference implementations:
Related Slack thread: https://cloud-native.slack.com/archives/C062HUREGUV/p1736545245331779