Skip to content

profiles: improve attribute encoding in ProfilesDictionary #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tigrannajaryan merged 5 commits into from
Aug 21, 2025
Merged

profiles: improve attribute encoding in ProfilesDictionary #672

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
69ad563
profiles dictionary table encoding consistency improvement.
jhalliday Jun 13, 2025
238863f
Revert "profiles dictionary table encoding consistency improvement."
jhalliday Jul 25, 2025
08f7903
profiles: improve attribute encoding in ProfilesDictionary
jhalliday Jul 25, 2025
127d1cb
profiles: improve attribute encoding in ProfilesDictionary
jhalliday Jul 28, 2025
8b0c02b
Merge branch 'main' into profiles-p
jhalliday Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions opentelemetry/proto/profiles/v1development/profiles.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ option go_package = "go.opentelemetry.io/proto/otlp/profiles/v1development";
// │ n-1
// │ 1-n ┌───────────────────────────────────────┐
// ▼ │ ▽
// ┌──────────────────┐ 1-n ┌──────────────┐ ┌──────────┐
// │ Sample │ ──────▷ │ KeyValue │ │ Link │
// └──────────────────┘ └──────────────┘ └──────────┘
// ┌──────────────────┐ 1-n ┌─────────────────┐ ┌──────────┐
// │ Sample │ ──────▷ │ KeyValueAndUnit │ │ Link │
// └──────────────────┘ └─────────────────┘ └──────────┘
// │ 1-n △ △
// │ 1-n ┌─────────────────┘ │ 1-n
// ▽ │ │
Expand Down Expand Up @@ -124,9 +124,6 @@ message ProfilesDictionary {
// "abc.com/myattribute": true
// "abc.com/score": 10.239
//
// Attribute keys MUST be unique (it is not allowed to have more than one
// attribute with the same key).
//
// The attribute values SHOULD NOT contain empty values.
// The attribute values SHOULD NOT contain bytes values.
// The attribute values SHOULD NOT contain array values different than array of string values, bool values, int values,
Expand All @@ -136,10 +133,7 @@ message ProfilesDictionary {
// These restrictions can change in a minor release.
// The restrictions take origin from the OpenTelemetry specification:
// https://github.com/open-telemetry/opentelemetry-specification/blob/v1.47.0/specification/common/README.md#attribute.
repeated opentelemetry.proto.common.v1.KeyValue attribute_table = 6;

// Represents a mapping between Attribute Keys and Units.
repeated AttributeUnit attribute_units = 7;
Comment thread
jhalliday marked this conversation as resolved.
repeated KeyValueAndUnit attribute_table = 6;
Comment thread
jhalliday marked this conversation as resolved.
Comment thread
tigrannajaryan marked this conversation as resolved.
}

// ProfilesData represents the profiles data that can be stored in persistent storage,
Expand Down Expand Up @@ -296,14 +290,6 @@ message Profile {
repeated int32 attribute_indices = 13;
}

// Represents a mapping between Attribute Keys and Units.
message AttributeUnit {
// Index into string table.
int32 attribute_key_strindex = 1;
// Index into string table.
int32 unit_strindex = 2;
}

// A pointer from a profile Sample to a trace Span.
// Connects a profile sample to a trace span, identified by unique trace and span IDs.
message Link {
Expand Down Expand Up @@ -497,3 +483,12 @@ message Function {
// Line number in source file. 0 means unset.
int64 start_line = 4;
}

// A custom 'dictionary native' style of encoding attributes which is more convenient
// for profiles than opentelemetry.proto.common.v1.KeyValue
// Specifically, uses the string table for keys and allows optional unit information.
message KeyValueAndUnit {
int32 key_strindex = 1;
opentelemetry.proto.common.v1.AnyValue value = 2;
int32 unit_strindex = 3; // zero indicates implicit (by semconv) or non-defined unit.
}