pprof: add pprof.profile.comment (#2861)

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

Author: florianl

.chloggen/pprof-comments.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 attribute pprof.profile.comment.
+
+# 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: [2861]
+
+# (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,7 @@ They may be used in any Profiles record they apply to.
 | [`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) |
+| [`pprof.profile.comment`](/docs/registry/attributes/pprof.md) | 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"]` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->

docs/registry/attributes/pprof.md

@@ -14,3 +14,4 @@ Attributes specific to pprof that help convert from pprof to Profiling signal.
 | <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) |
+| <a id="pprof-profile-comment" href="#pprof-profile-comment">`pprof.profile.comment`</a> | 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"]` | ![Development](https://img.shields.io/badge/-development-blue) |

model/pprof/common.yaml

@@ -15,3 +15,5 @@ groups:
         requirement_level: recommended
       - ref: pprof.location.is_folded
         requirement_level: recommended
+      - ref: pprof.profile.comment
+        requirement_level: recommended

model/pprof/registry.yaml

@@ -35,3 +35,12 @@ groups:
           profile changes.
         stability: development
         type: boolean
+      - id: pprof.profile.comment
+        brief: >
+          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.
+        type: string[]
+        examples:
+          - ["hello world", "bazinga"]
+        stability: development