From b062d4fe7a448c18a1e9e1810e72c1b726e0b002 Mon Sep 17 00:00:00 2001 From: Jonathan Halliday Date: Mon, 24 Nov 2025 13:43:49 +0000 Subject: [PATCH 1/2] profiles: clarify Sample message usage guidance docs. --- opentelemetry/proto/profiles/v1development/profiles.proto | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/opentelemetry/proto/profiles/v1development/profiles.proto b/opentelemetry/proto/profiles/v1development/profiles.proto index 507511237..1779bbd59 100644 --- a/opentelemetry/proto/profiles/v1development/profiles.proto +++ b/opentelemetry/proto/profiles/v1development/profiles.proto @@ -368,7 +368,7 @@ message ValueType { // as having a shared identity and an associated collection of per-observation data points. // Samples having the same identity SHOULD be combined by inserting timestamps and values to the data arrays. // -// Examples of different ways of representing a sample with the total value of 10: +// Examples of different ways ('shapes') of representing a sample with the total value of 10: // // Report of a stacktrace at 10 timestamps (consumers must assume the value is 1 for each point): // values: [] @@ -381,6 +381,10 @@ message ValueType { // Report of a stacktrace at 4 timestamps where each point records a specific value: // values: [2, 2, 3, 3] // timestamps_unix_nano: [1, 2, 3, 4] +// +// All Samples for a Profile SHOULD have the same shape, i.e. all data observation series should consistently +// adopt the same data recording style. +// message Sample { // A Sample's identity (i.e. 'primary key') is the tuple of {stack_index, set_of(attribute_indices), link_index} From e10fd6a70460abe29208825beb0d40428c1cd5ff Mon Sep 17 00:00:00 2001 From: Jonathan Halliday Date: Mon, 24 Nov 2025 13:53:46 +0000 Subject: [PATCH 2/2] profiles: clarify Sample message usage guidance docs. --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9592c8c51..1fb1fa155 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,9 @@ The full list of changes can be found in the compare view for the respective rel ### Changed +- profiles: clarify Sample message usage guidance docs. [#742](https://github.com/open-telemetry/opentelemetry-proto/pull/742) +- profiles: improve Sample message clarity and usage documentation. [#724](https://github.com/open-telemetry/opentelemetry-proto/pull/724) + ### Fixed - logs: `SEVERITY_NUMBER_UNSPECIFIED` can be used as the `severity_number` field is optional. [#736](https://github.com/open-telemetry/opentelemetry-proto/pull/736)