Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions .chloggen/profiles-location-folded.yaml
Original file line number Diff line number Diff line change
@@ -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:
9 changes: 9 additions & 0 deletions docs/registry/attributes/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,19 @@ Attributes specific to pprof that helps to convert Profiling signals.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="profile-pprof-location" href="#profile-pprof-location">`profile.pprof.location`</a> | string | Describes the relation between symbols and a location. | `is_folded` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="profile-pprof-mapping" href="#profile-pprof-mapping">`profile.pprof.mapping`</a> | 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 |
Expand Down
2 changes: 2 additions & 0 deletions model/profile/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ groups:
attributes:
- ref: profile.pprof.mapping
requirement_level: recommended
- ref: profile.pprof.location
requirement_level: recommended
16 changes: 16 additions & 0 deletions model/profile/registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: 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
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