From 5f60c275c411e65b6c0abd79121e877239af482e Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Wed, 30 Jul 2025 09:21:53 +0200 Subject: [PATCH 1/2] model/profile: add location information Signed-off-by: Florian Lehner --- .chloggen/profiles-location-folded.yaml | 22 ++++++++++++++++++++++ docs/registry/attributes/profile.md | 9 +++++++++ model/profile/common.yaml | 2 ++ model/profile/registry.yaml | 16 ++++++++++++++++ 4 files changed, 49 insertions(+) create mode 100755 .chloggen/profiles-location-folded.yaml diff --git a/.chloggen/profiles-location-folded.yaml b/.chloggen/profiles-location-folded.yaml new file mode 100755 index 0000000000..a9ac62bfa5 --- /dev/null +++ b/.chloggen/profiles-location-folded.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: profile + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: add pprof specific attribute for location. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/registry/attributes/profile.md b/docs/registry/attributes/profile.md index eab55c57bb..4d17b0a0ff 100644 --- a/docs/registry/attributes/profile.md +++ b/docs/registry/attributes/profile.md @@ -39,10 +39,19 @@ Attributes specific to pprof that helps to convert Profiling signals. | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| +| `profile.pprof.location` | string | Describes the relation between symbols and a location. | `is_folded` | ![Development](https://img.shields.io/badge/-development-blue) | | `profile.pprof.mapping` | string | Describes the resolution of symbolic information. | `has_filenames` | ![Development](https://img.shields.io/badge/-development-blue) | --- +`profile.pprof.location` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `is_folded` | Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes. | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + `profile.pprof.mapping` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/model/profile/common.yaml b/model/profile/common.yaml index 08995c2eff..ef29eea32a 100644 --- a/model/profile/common.yaml +++ b/model/profile/common.yaml @@ -14,3 +14,5 @@ groups: attributes: - ref: profile.pprof.mapping requirement_level: recommended + - ref: profile.pprof.location + requirement_level: recommended diff --git a/model/profile/registry.yaml b/model/profile/registry.yaml index 9c1c5b9331..6006e96025 100644 --- a/model/profile/registry.yaml +++ b/model/profile/registry.yaml @@ -111,3 +111,19 @@ groups: Indicates that there are inlined frames related to this mapping. value: "has_inline_frames" stability: development + - id: profile.pprof.location + stability: development + brief: > + Describes the relation between symbols and a location. + examples: ['is_folded'] + type: + members: + - id: has_functions + brief: > + Provides an indication that multiple symbols map to this location's + address, for example due to identical code folding by the linker. In + that case the line information represents one of the multiple symbols. + This field must be recomputed when the symbolization state of the + profile changes. + value: "is_folded" + stability: development From 076e3e0476583efb91fd9b9c75b93cc2dd11f123 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Wed, 30 Jul 2025 11:46:43 +0200 Subject: [PATCH 2/2] fix copy/paste typo Signed-off-by: Florian Lehner --- model/profile/registry.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/profile/registry.yaml b/model/profile/registry.yaml index 6006e96025..bad0df2e42 100644 --- a/model/profile/registry.yaml +++ b/model/profile/registry.yaml @@ -118,7 +118,7 @@ groups: examples: ['is_folded'] type: members: - - id: has_functions + - id: is_folded brief: > Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In