pprof: add profile attribute (#3078)

Signed-off-by: Florian Lehner <[email protected]>

Author: florianl

.chloggen/pprof-profile.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: pprof
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: add various pprof attributes to support lossless conversion from and to OTel profiles.
+
+# 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: [3078]
+
+# (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:

docs/general/profiles.md

@@ -81,6 +81,11 @@ They may be used in any Profiles record they apply to.
 | [`pprof.mapping.has_inline_frames`](/docs/registry/attributes/pprof.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | boolean | Indicates that there are inline frames related to this mapping. | |
 | [`pprof.mapping.has_line_numbers`](/docs/registry/attributes/pprof.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | boolean | Indicates that there are line numbers related to this mapping. | |
 | [`pprof.profile.comment`](/docs/registry/attributes/pprof.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string[] | Free-form text associated with the profile. This field should not be used to store any machine-readable information, it is only for human-friendly content. | `["hello world", "bazinga"]` |
+| [`pprof.profile.doc_url`](/docs/registry/attributes/pprof.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Documentation link for this profile type. [1] | `http://pprof.example.com/cpu-profile.html` |
+| [`pprof.profile.drop_frames`](/docs/registry/attributes/pprof.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Frames with Function.function_name fully matching the regexp will be dropped from the samples, along with their successors. | `/foobar/` |
+| [`pprof.profile.keep_frames`](/docs/registry/attributes/pprof.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Frames with Function.function_name fully matching the regexp will be kept, even if it matches drop_frames. | `/bazinga/` |
+
+**[1] `pprof.profile.doc_url`:** The URL must be absolute and may be missing if the profile was generated by code that did not supply a link
 
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->

docs/registry/attributes/pprof.md

@@ -17,3 +17,8 @@ Attributes specific to pprof that help convert from pprof to Profiling signal.
 | <a id="pprof-mapping-has-inline-frames" href="#pprof-mapping-has-inline-frames">`pprof.mapping.has_inline_frames`</a> | ![Development](https://img.shields.io/badge/-development-blue) | boolean | Indicates that there are inline frames related to this mapping. | |
 | <a id="pprof-mapping-has-line-numbers" href="#pprof-mapping-has-line-numbers">`pprof.mapping.has_line_numbers`</a> | ![Development](https://img.shields.io/badge/-development-blue) | boolean | Indicates that there are line numbers related to this mapping. | |
 | <a id="pprof-profile-comment" href="#pprof-profile-comment">`pprof.profile.comment`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Free-form text associated with the profile. This field should not be used to store any machine-readable information, it is only for human-friendly content. | `["hello world", "bazinga"]` |
+| <a id="pprof-profile-doc-url" href="#pprof-profile-doc-url">`pprof.profile.doc_url`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | Documentation link for this profile type. [1] | `http://pprof.example.com/cpu-profile.html` |
+| <a id="pprof-profile-drop-frames" href="#pprof-profile-drop-frames">`pprof.profile.drop_frames`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | Frames with Function.function_name fully matching the regexp will be dropped from the samples, along with their successors. | `/foobar/` |
+| <a id="pprof-profile-keep-frames" href="#pprof-profile-keep-frames">`pprof.profile.keep_frames`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | Frames with Function.function_name fully matching the regexp will be kept, even if it matches drop_frames. | `/bazinga/` |
+
+**[1] `pprof.profile.doc_url`:** The URL must be absolute and may be missing if the profile was generated by code that did not supply a link

model/pprof/common.yaml

@@ -17,3 +17,9 @@ groups:
         requirement_level: recommended
       - ref: pprof.profile.comment
         requirement_level: recommended
+      - ref: pprof.profile.drop_frames
+        requirement_level: recommended
+      - ref: pprof.profile.keep_frames
+        requirement_level: recommended
+      - ref: pprof.profile.doc_url
+        requirement_level: recommended

model/pprof/registry.yaml

@@ -44,3 +44,29 @@ groups:
         examples:
           - ["hello world", "bazinga"]
         stability: development
+      - id: pprof.profile.drop_frames
+        brief: >
+          Frames with Function.function_name fully matching the regexp will be
+          dropped from the samples, along with their successors.
+        type: string
+        examples:
+          - "/foobar/"
+        stability: development
+      - id: pprof.profile.keep_frames
+        brief: >
+          Frames with Function.function_name fully matching the regexp will be
+          kept, even if it matches drop_frames.
+        type: string
+        examples:
+          - "/bazinga/"
+        stability: development
+      - id: pprof.profile.doc_url
+        brief: >
+          Documentation link for this profile type.
+        type: string
+        note: >
+          The URL must be absolute and may be missing if the profile was
+          generated by code that did not supply a link
+        examples:
+          - "http://pprof.example.com/cpu-profile.html"
+        stability: development