Skip to content
Merged
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: pprof

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Introduce 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:
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@
# Profiling semantic conventions
/docs/general/profiles.md @open-telemetry/specs-semconv-approvers @open-telemetry/profiling-approvers
/model/profile/ @open-telemetry/specs-semconv-approvers @open-telemetry/profiling-approvers
/model/pprof/ @open-telemetry/specs-semconv-approvers @open-telemetry/profiling-approvers

# SDK health semantic conventions
/docs/otel/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-sdk-health-approvers
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ body:
- area:os
- area:otel
- area:peer
- area:pprof
- area:process
- area:profile
- area:rpc
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ body:
- area:os
- area:otel
- area:peer
- area:pprof
- area:process
- area:profile
- area:rpc
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ body:
- area:os
- area:otel
- area:peer
- area:pprof
- area:process
- area:profile
- area:rpc
Expand Down
40 changes: 37 additions & 3 deletions docs/general/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,24 @@
linkTitle: Profiles
--->

# General profiles attributes
# Profiles attributes

**Status**: [Development][DocumentStatus]

<!-- toc -->

- [Frame types](#frame-types)
- [General profiles identification attributes](#general-profiles-identification-attributes)
- [Frame types](#frame-types)
- [Compatibility with pprof](#compatibility-with-pprof)

<!-- tocstop -->

## General profiles identification attributes

The attributes described in this section are rather generic.
They may be used in any Profiles record they apply to.

## Frame types
### Frame types

**Description:** Describes the origin of a single frame in a Profile.

Expand Down Expand Up @@ -54,4 +58,34 @@ They may be used in any Profiles record they apply to.
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## Compatibility with pprof

Existing [pprof][pprofLink] formats can be unambiguously mapped to this data
model. Reverse mapping from this data model is also possible to the extent that
the target profiles format has equivalent capabilities.

The attributes described in this section are specific to support convertibility.
They may be used in any Profiles record they apply to.

<!-- semconv pprof(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`pprof.location.is_folded`](/docs/registry/attributes/pprof.md) | boolean | 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. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
| [`pprof.mapping.has_filenames`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are filenames related to this mapping. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
| [`pprof.mapping.has_functions`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are functions related to this mapping. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
| [`pprof.mapping.has_inline_frames`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are inline frames related to this mapping. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
| [`pprof.mapping.has_line_numbers`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are line numbers related to this mapping. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
[pprofLink]: https://github.com/google/pprof
1 change: 1 addition & 0 deletions docs/registry/attributes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ Currently, the following namespaces exist:
- [OS](os.md)
- [OTel](otel.md)
- [Peer](peer.md)
- [Pprof](pprof.md)
- [Process](process.md)
- [Profile](profile.md)
- [RPC](rpc.md)
Expand Down
16 changes: 16 additions & 0 deletions docs/registry/attributes/pprof.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Pprof

## Pprof specific attributes for the Profiling signal

Attributes specific to pprof that help convert from pprof to Profiling signal.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="pprof-location-is-folded" href="#pprof-location-is-folded">`pprof.location.is_folded`</a> | boolean | 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) |
| <a id="pprof-mapping-has-filenames" href="#pprof-mapping-has-filenames">`pprof.mapping.has_filenames`</a> | boolean | Indicates that there are filenames related to this mapping. | | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="pprof-mapping-has-functions" href="#pprof-mapping-has-functions">`pprof.mapping.has_functions`</a> | boolean | Indicates that there are functions related to this mapping. | | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="pprof-mapping-has-inline-frames" href="#pprof-mapping-has-inline-frames">`pprof.mapping.has_inline_frames`</a> | boolean | Indicates that there are inline frames related to this mapping. | | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="pprof-mapping-has-line-numbers" href="#pprof-mapping-has-line-numbers">`pprof.mapping.has_line_numbers`</a> | boolean | Indicates that there are line numbers related to this mapping. | | ![Development](https://img.shields.io/badge/-development-blue) |
17 changes: 17 additions & 0 deletions model/pprof/common.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
groups:

- id: pprof
type: attribute_group
brief: >
Attributes specific to pprof that help convert from pprof to Profiling signal.
attributes:
- ref: pprof.mapping.has_functions
requirement_level: recommended
- ref: pprof.mapping.has_filenames
requirement_level: recommended
- ref: pprof.mapping.has_line_numbers
requirement_level: recommended
- ref: pprof.mapping.has_inline_frames
requirement_level: recommended
- ref: pprof.location.is_folded
requirement_level: recommended
37 changes: 37 additions & 0 deletions model/pprof/registry.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
groups:

- id: registry.pprof
type: attribute_group
display_name: Pprof specific attributes for the Profiling signal
brief: >
Attributes specific to pprof that help convert from pprof to Profiling signal.
attributes:
- id: pprof.mapping.has_functions
brief: >
Indicates that there are functions related to this mapping.
type: boolean
stability: development
- id: pprof.mapping.has_filenames
brief: >
Indicates that there are filenames related to this mapping.
type: boolean
stability: development
- id: pprof.mapping.has_line_numbers
brief: >
Indicates that there are line numbers related to this mapping.
type: boolean
stability: development
- id: pprof.mapping.has_inline_frames
brief: >
Indicates that there are inline frames related to this mapping.
type: boolean
stability: development
- id: pprof.location.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.
stability: development
type: boolean
Loading