Skip to content
22 changes: 22 additions & 0 deletions .chloggen/profiles-symb-level.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 Profile pprof attributes.

# 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: [2522]

# (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:
31 changes: 31 additions & 0 deletions docs/registry/attributes/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@

# Profile

- [Profile Frame Attributes](#profile-frame-attributes)
- [Pprof specific attributes for the Profiling signal](#pprof-specific-attributes-for-the-profiling-signal)

## Profile Frame Attributes

Describes the origin of a single frame in a Profile.
Expand All @@ -29,3 +32,31 @@ Describes the origin of a single frame in a Profile.
| `ruby` | [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) | ![Development](https://img.shields.io/badge/-development-blue) |
| `rust` | [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) | ![Development](https://img.shields.io/badge/-development-blue) |
| `v8js` | [V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) | ![Development](https://img.shields.io/badge/-development-blue) |

## Pprof specific attributes for the Profiling signal
Comment thread
florianl marked this conversation as resolved.
Outdated

Attributes specific to pprof that helps to convert Profiling signals.
Comment thread
florianl marked this conversation as resolved.
Outdated

| 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 |
|---|---|---|
| `has_filenames` | Indicates that there are filenames related to this mapping. | ![Development](https://img.shields.io/badge/-development-blue) |
| `has_functions` | Indicates that there are functions related to this mapping. | ![Development](https://img.shields.io/badge/-development-blue) |
| `has_inline_frames` | Indicates that there are inlined frames related to this mapping. | ![Development](https://img.shields.io/badge/-development-blue) |
| `has_line_numbers` | Indicates that there are line numbers related to this mapping. | ![Development](https://img.shields.io/badge/-development-blue) |
10 changes: 10 additions & 0 deletions model/profile/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,13 @@ groups:
attributes:
- ref: profile.frame.type
requirement_level: recommended

- id: profile.pprof
type: attribute_group
brief: >
Describes the relationship between pprof and a Profile.
Comment thread
florianl marked this conversation as resolved.
Outdated
attributes:
- ref: profile.pprof.mapping
Comment thread
florianl marked this conversation as resolved.
Outdated
requirement_level: recommended
- ref: profile.pprof.location
requirement_level: recommended
49 changes: 49 additions & 0 deletions model/profile/registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,52 @@ groups:
[Rust](https://wikipedia.org/wiki/Rust_(programming_language))
value: "rust"
stability: development
- id: registry.profile.pprof
type: attribute_group
Comment thread
florianl marked this conversation as resolved.
Outdated
display_name: Pprof specific attributes for the Profiling signal
brief: >
Attributes specific to pprof that helps to convert Profiling signals.
Comment thread
florianl marked this conversation as resolved.
Outdated
attributes:
- id: profile.pprof.mapping
stability: development
brief: >
Describes the resolution of symbolic information.
examples: ['has_filenames']
type:
members:
- id: has_functions
brief: >
Indicates that there are functions related to this mapping.
value: "has_functions"
stability: development
- id: has_filenames
brief: >
Indicates that there are filenames related to this mapping.
value: "has_filenames"
stability: development
- id: has_line_numbers
brief: >
Indicates that there are line numbers related to this mapping.
value: "has_line_numbers"
stability: development
- id: has_inline_frames
brief: >
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
Loading