profiles: dictionary table encoding consistency improvement. #672
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
|
ref #659 (comment) |
christos68k
reviewed
Jun 13, 2025
| @@ -93,10 +93,15 @@ option go_package = "go.opentelemetry.io/proto/otlp/profiles/v1development"; | |||
| // ProfilesDictionary represents the profiles data shared across the | |||
| // entire message being sent. | |||
| message ProfilesDictionary { | |||
|
|
|||
| // Note all fields in this message MUST have a zero value encoded as the first element. | |||
There was a problem hiding this comment.
We don't have index lookups for attribute_units and a zero value encoded as the first element isn't needed for that field, so this is a little confusing as-is. Maybe we can say "all fields except attribute_units".
Comment on lines
+98
to
+101
| // This allows for _index fields pointing into the dictionary to use a 0 pointer value to indicate 'null' / 'not set' | ||
| // without requiring 'optional' encoding, which would be less compact. | ||
| // Unless otherwise defined, a 'zero value' message value is one with all default field values, | ||
| // so as to minimize wire encoded size. |
There was a problem hiding this comment.
I think we can trim this text down a bit:
Suggested change
| // This allows for _index fields pointing into the dictionary to use a 0 pointer value to indicate 'null' / 'not set' | |
| // without requiring 'optional' encoding, which would be less compact. | |
| // Unless otherwise defined, a 'zero value' message value is one with all default field values, | |
| // so as to minimize wire encoded size. | |
| // This allows for _index fields pointing into the dictionary to use a 0 pointer value | |
| // to indicate 'null' / 'not set'. Unless otherwise defined, a 'zero value' message value is one with all default field | |
| // values, so as to minimize wire encoded size. |
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.
Subsequent to #659 (profiles: avoid 'optional' keyword usage) and in accordance with discussions in the profiling SIG, this PR updates the dictionary message docs to impose a more consistent handling of 'null pointer' semantics in the encoding pattern.