From 77a7f1439d05cc0185ca8d0c745ddbcd6af5fe62 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 24 Jun 2024 12:39:46 +0200 Subject: [PATCH 01/21] [profiles] introduce semantic convention Signed-off-by: Florian Lehner --- .chloggen/profiles-convention.yaml | 22 ++++++ docs/attributes-registry/README.md | 1 + docs/attributes-registry/profile.md | 51 +++++++++++++ docs/general/profiles.md | 110 ++++++++++++++++++++++++++++ model/profiles/executable.yaml | 10 +++ model/profiles/frame.yaml | 8 ++ model/profiles/link.yaml | 10 +++ model/registry/profile.yaml | 99 +++++++++++++++++++++++++ 8 files changed, 311 insertions(+) create mode 100755 .chloggen/profiles-convention.yaml create mode 100644 docs/attributes-registry/profile.md create mode 100644 docs/general/profiles.md create mode 100644 model/profiles/executable.yaml create mode 100644 model/profiles/frame.yaml create mode 100644 model/profiles/link.yaml create mode 100644 model/registry/profile.yaml diff --git a/.chloggen/profiles-convention.yaml b/.chloggen/profiles-convention.yaml new file mode 100755 index 0000000000..083d8b0f2a --- /dev/null +++ b/.chloggen/profiles-convention.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: profiles + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Introduce semantic convention for 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: [] + +# (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: diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index f4a53171a0..fbe19b5eb5 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -78,6 +78,7 @@ Currently, the following namespaces exist: - [OTel](otel.md) - [Peer](peer.md) - [Process](process.md) +- [Profile](profile.md) - [RPC](rpc.md) - [Server](server.md) - [Service](service.md) diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md new file mode 100644 index 0000000000..c6f939ad99 --- /dev/null +++ b/docs/attributes-registry/profile.md @@ -0,0 +1,51 @@ + + + + + +# Profile + +- [Profile Build Id](#profile-build-id-attributes) +- [Profile Frame](#profile-frame-attributes) +- [Profile Link](#profile-link-attributes) + +## Profile Build Id Attributes + +Unique identifier for an executable. + +| Attribute | Type | Description | Examples | Stability | +| ---------------------- | ------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| `profile.build_id.gnu` | string | The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. | `c89b11207f6479603b0d49bf291c092c2b719293` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `profile.build_id.go` | string | The Go build ID. | `foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +## Profile Frame Attributes + +Describes the origin of a single frame in a Profile. + +| Attribute | Type | Description | Examples | Stability | +| -------------------- | ------ | -------------------------------------------------------- | -------- | ---------------------------------------------------------------- | +| `profile.frame.type` | string | Describes the interpreter or compiler of a single frame. | `python` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +`profile.frame.type` 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 | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| `dotnet` | [.Net](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `kernel` | [Kernel]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `native` | [C](), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](), [Rust]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `perl` | [Perl](https://wikipedia.org/wiki/Perl) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `python` | [Python]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `ruby` | [Ruby]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `v8` | [V8]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +## Profile Link Attributes + +Connect Profile information to Spans and Traces. + +| Attribute | Type | Description | Examples | Stability | +| ----------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ---------------------------------------------------------------- | +| `profile.link.span_id` | string | A 8-byte array identifier for a span as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `00f067aa0ba902b7` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `profile.link.trace_id` | string | A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `4bf92f3577b34da6a3ce929d0e0e4736` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/docs/general/profiles.md b/docs/general/profiles.md new file mode 100644 index 0000000000..c714b97b13 --- /dev/null +++ b/docs/general/profiles.md @@ -0,0 +1,110 @@ + + +# General Profiles Attributes + +**Status**: [Experimental][DocumentStatus] + + + +- [Build ID](#build-id) +- [Spans and Traces](#spans-and-traces) +- [Frametypes](#frametypes) +- [Reserved attributes](#reserved-attributes) + + + +The attributes described in this section are rather generic. +They may be used in any Profiles record they apply to. + +## Build ID + +**Description:** Unique identifier for an executable. + + + + + + + + +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | +|---|---|---|---|---|---| +| [`profile.build_id.gnu`](/docs/attributes-registry/profile.md) | string | The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. | `c89b11207f6479603b0d49bf291c092c2b719293` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`profile.build_id.go`](/docs/attributes-registry/profile.md) | string | The Go build ID. | `foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + + + + + + + +## Spans and Traces + +**Description:** Connect Profile information to Spans and Traces. + + + + + + + + +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | +|---|---|---|---|---|---| +| [`profile.link.span_id`](/docs/attributes-registry/profile.md) | string | A 8-byte array identifier for a span as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `00f067aa0ba902b7` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`profile.link.trace_id`](/docs/attributes-registry/profile.md) | string | A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `4bf92f3577b34da6a3ce929d0e0e4736` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + + + + + + + +## Frametypes + +**Description:** Describes the origin of a single frame in a Profile. + + + + + + + + +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | +|---|---|---|---|---|---| +| [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `python` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +`profile.frame.type` 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 | +|---|---|---| +| `dotnet` | [.Net](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `kernel` | [Kernel](https://wikipedia.org/wiki/Kernel_(operating_system)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `native` | [C](https://wikipedia.org/wiki/C_(programming_language)), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](https://wikipedia.org/wiki/Go_(programming_language)), [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `perl` | [Perl](https://wikipedia.org/wiki/Perl) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `python` | [Python](https://wikipedia.org/wiki/Python_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `ruby` | [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `v8` | [V8](https://wikipedia.org/wiki/V8_(JavaScript_engine)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + + + + + + + + +## Reserved attributes + +**Description:** For cross tooling compatibility the following attributes SHOULD be avoided. + +| Attribute | Type | Description | Examples | +|---|---|---|---| +| `pprof::*` | string | Special indicator for [pprof](https://github.com/google/pprof). | `pprof::base` | + +[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/model/profiles/executable.yaml b/model/profiles/executable.yaml new file mode 100644 index 0000000000..e3788e29b3 --- /dev/null +++ b/model/profiles/executable.yaml @@ -0,0 +1,10 @@ +groups: + - id: profile.build_id + type: attribute_group + brief: > + Unique identifier for an executable. + attributes: + - ref: profile.build_id.gnu + requirement_level: opt_in + - ref: profile.build_id.go + requirement_level: opt_in diff --git a/model/profiles/frame.yaml b/model/profiles/frame.yaml new file mode 100644 index 0000000000..44cf31063d --- /dev/null +++ b/model/profiles/frame.yaml @@ -0,0 +1,8 @@ +groups: + - id: profile.frame + type: attribute_group + brief: > + Describes the origin of a single frame in a Profile. + attributes: + - ref: profile.frame.type + requirement_level: opt_in diff --git a/model/profiles/link.yaml b/model/profiles/link.yaml new file mode 100644 index 0000000000..79cdbc4295 --- /dev/null +++ b/model/profiles/link.yaml @@ -0,0 +1,10 @@ +groups: + - id: profile.link + type: attribute_group + brief: > + Unique identifier for an executable. + attributes: + - ref: profile.link.trace_id + requirement_level: opt_in + - ref: profile.link.span_id + requirement_level: opt_in diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml new file mode 100644 index 0000000000..3ca691a368 --- /dev/null +++ b/model/registry/profile.yaml @@ -0,0 +1,99 @@ +groups: + + - id: registry.profile.build_id + type: attribute_group + prefix: profile.build_id + brief: > + Unique identifier for an executable. + attributes: + - id: gnu + stability: experimental + type: string + brief: > + The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. + examples: ['c89b11207f6479603b0d49bf291c092c2b719293'] + - id: go + stability: experimental + type: string + brief: > + The Go build ID. + examples: ['foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY'] + + - id: registry.profile.link + type: attribute_group + prefix: profile.link + brief: > + Connect Profile information to Spans and Traces. + attributes: + - id: trace_id + stability: experimental + type: string + brief: > + A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). + examples: ['4bf92f3577b34da6a3ce929d0e0e4736'] + - id: span_id + stability: experimental + type: string + brief: > + A 8-byte array identifier for a span as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). + examples: ['00f067aa0ba902b7'] + + - id: registry.profile.frame + type: attribute_group + prefix: profile.frame + brief: > + Describes the origin of a single frame in a Profile. + attributes: + - id: type + stability: experimental + brief: > + Describes the interpreter or compiler of a single frame. + examples: ['python'] + type: + allow_custom_values: true + members: + - id: dotnet + brief: > + [.Net](https://wikipedia.org/wiki/.NET) + value: "dotnet" + stability: experimental + - id: jvm + brief: > + [JVM](https://wikipedia.org/wiki/Java_virtual_machine) + value: "jvm" + stability: experimental + - id: kernel + brief: > + [Kernel](https://wikipedia.org/wiki/Kernel_(operating_system)) + value: "kernel" + stability: experimental + - id: native + brief: > + [C](https://wikipedia.org/wiki/C_(programming_language)), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](https://wikipedia.org/wiki/Go_(programming_language)), [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) + value: "native" + stability: experimental + - id: perl + brief: > + [Perl](https://wikipedia.org/wiki/Perl) + value: "perl" + stability: experimental + - id: php + brief: > + [PHP](https://wikipedia.org/wiki/PHP) + value: "php" + stability: experimental + - id: python + brief: > + [Python](https://wikipedia.org/wiki/Python_(programming_language)) + value: "python" + stability: experimental + - id: ruby + brief: > + [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) + value: "ruby" + stability: experimental + - id: v8 + brief: > + [V8](https://wikipedia.org/wiki/V8_(JavaScript_engine)) + value: "v8" + stability: experimental From 412f7e706c42a6064682db4a7a962c3b5b7d0d80 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Thu, 27 Jun 2024 18:07:19 +0200 Subject: [PATCH 02/21] fixup: update dropdown areas Signed-off-by: Florian Lehner --- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/change_proposal.yaml | 1 + .github/ISSUE_TEMPLATE/new-conventions.yaml | 1 + 3 files changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 8a7e8aee67..1f05008ea7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -65,6 +65,7 @@ body: - area:otel - area:peer - area:process + - area:profile - area:rpc - area:server - area:service diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index d924b6fe58..61d2d0ecaf 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -57,6 +57,7 @@ body: - area:otel - area:peer - area:process + - area:profile - area:rpc - area:server - area:service diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index ca0f864b07..fc5b66dcb7 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -66,6 +66,7 @@ body: - area:otel - area:peer - area:process + - area:profile - area:rpc - area:server - area:service From e0a5bf2984c146b53044d8be18287da18614b809 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Thu, 27 Jun 2024 18:17:10 +0200 Subject: [PATCH 03/21] fixup: yamllint Signed-off-by: Florian Lehner --- model/registry/profile.yaml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index 3ca691a368..dc18ad0ee4 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -5,7 +5,7 @@ groups: prefix: profile.build_id brief: > Unique identifier for an executable. - attributes: + attributes: - id: gnu stability: experimental type: string @@ -25,13 +25,13 @@ groups: brief: > Connect Profile information to Spans and Traces. attributes: - - id: trace_id + - id: trace_id stability: experimental type: string brief: > A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). examples: ['4bf92f3577b34da6a3ce929d0e0e4736'] - - id: span_id + - id: span_id stability: experimental type: string brief: > @@ -69,7 +69,10 @@ groups: stability: experimental - id: native brief: > - [C](https://wikipedia.org/wiki/C_(programming_language)), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](https://wikipedia.org/wiki/Go_(programming_language)), [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) + [C](https://wikipedia.org/wiki/C_(programming_language)), + [C++](https://wikipedia.org/wiki/C%2B%2B), + [Go](https://wikipedia.org/wiki/Go_(programming_language)), + [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) value: "native" stability: experimental - id: perl @@ -87,7 +90,7 @@ groups: [Python](https://wikipedia.org/wiki/Python_(programming_language)) value: "python" stability: experimental - - id: ruby + - id: ruby brief: > [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) value: "ruby" From 5d9951ced349dad78d8502371d1d73c4ecac11b0 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Thu, 27 Jun 2024 18:23:54 +0200 Subject: [PATCH 04/21] fixup: add PR number to changelog Signed-off-by: Florian Lehner --- .chloggen/profiles-convention.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.chloggen/profiles-convention.yaml b/.chloggen/profiles-convention.yaml index 083d8b0f2a..448f6b24ab 100755 --- a/.chloggen/profiles-convention.yaml +++ b/.chloggen/profiles-convention.yaml @@ -14,7 +14,7 @@ note: Introduce semantic convention for 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: [] +issues: [1188] # (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. From 1580868268fe18b75056dc24300faa3b7b2b6a31 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Fri, 28 Jun 2024 07:54:00 +0200 Subject: [PATCH 05/21] fixup: apply feedback from @trisch-me Signed-off-by: Florian Lehner --- .chloggen/profiles-convention.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.chloggen/profiles-convention.yaml b/.chloggen/profiles-convention.yaml index 448f6b24ab..d778733484 100755 --- a/.chloggen/profiles-convention.yaml +++ b/.chloggen/profiles-convention.yaml @@ -4,10 +4,10 @@ # your pull request title with [chore] or use the "Skip Changelog" label. # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' -change_type: enhancement +change_type: new_component # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) -component: profiles +component: profile # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). note: Introduce semantic convention for OTel Profiles. From d38386dffcf8b5f08cc6a3523e419a76394b8b26 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Fri, 28 Jun 2024 07:56:41 +0200 Subject: [PATCH 06/21] fixup: apply feedback from @trask Signed-off-by: Florian Lehner --- model/profiles/link.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/profiles/link.yaml b/model/profiles/link.yaml index 79cdbc4295..9c73b4a715 100644 --- a/model/profiles/link.yaml +++ b/model/profiles/link.yaml @@ -2,7 +2,7 @@ groups: - id: profile.link type: attribute_group brief: > - Unique identifier for an executable. + Connect Profile information to Spans and Traces. attributes: - ref: profile.link.trace_id requirement_level: opt_in From ffecd9236349798f6ea8259bd14ad7c9dd9f5ffb Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Fri, 28 Jun 2024 08:32:16 +0200 Subject: [PATCH 07/21] fixup: apply feedback from @trask Signed-off-by: Florian Lehner --- docs/general/profiles.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index c714b97b13..63d01d6200 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -11,7 +11,7 @@ aliases: [docs/specs/semconv/general/profiles-general] - [Build ID](#build-id) - [Spans and Traces](#spans-and-traces) -- [Frametypes](#frametypes) +- [Frame types](#frame-types) - [Reserved attributes](#reserved-attributes) @@ -63,7 +63,7 @@ They may be used in any Profiles record they apply to. -## Frametypes +## Frame types **Description:** Describes the origin of a single frame in a Profile. From 377193eb38a1d82f3f3c191cd28852a0eb1c2f45 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Fri, 28 Jun 2024 16:30:07 +0200 Subject: [PATCH 08/21] fixup: apply feedback from @trask Signed-off-by: Florian Lehner --- model/registry/profile.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index dc18ad0ee4..628184486e 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -95,8 +95,8 @@ groups: [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) value: "ruby" stability: experimental - - id: v8 + - id: v8js brief: > - [V8](https://wikipedia.org/wiki/V8_(JavaScript_engine)) - value: "v8" + [V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) + value: "v8js" stability: experimental From bec7ce7ea90dd66ee70d068d1aefa13c24c3099d Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 1 Jul 2024 07:58:53 +0200 Subject: [PATCH 09/21] fixup: run markdown-toc Signed-off-by: Florian Lehner --- docs/attributes-registry/profile.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index c6f939ad99..fc359fd7cd 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -39,7 +39,7 @@ Describes the origin of a single frame in a Profile. | `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `python` | [Python]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ruby` | [Ruby]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `v8` | [V8]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `v8js` | [V8JS]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | ## Profile Link Attributes From 9870057261e868154905a6f97fa140843b06400d Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 1 Jul 2024 08:12:06 +0200 Subject: [PATCH 10/21] fixup: markdown Signed-off-by: Florian Lehner --- docs/general/profiles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 63d01d6200..f576c655d0 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -90,7 +90,7 @@ They may be used in any Profiles record they apply to. | `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `python` | [Python](https://wikipedia.org/wiki/Python_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ruby` | [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `v8` | [V8](https://wikipedia.org/wiki/V8_(JavaScript_engine)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `v8js` | [V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | From 9f65c24a705dc44af74cb4db2d4dad7755ecd568 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Wed, 7 Aug 2024 08:05:58 +0200 Subject: [PATCH 11/21] fixup: remove reserved attributes Signed-off-by: Florian Lehner --- docs/general/profiles.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index f576c655d0..105853804c 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -98,13 +98,3 @@ They may be used in any Profiles record they apply to. - -## Reserved attributes - -**Description:** For cross tooling compatibility the following attributes SHOULD be avoided. - -| Attribute | Type | Description | Examples | -|---|---|---|---| -| `pprof::*` | string | Special indicator for [pprof](https://github.com/google/pprof). | `pprof::base` | - -[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status From f632512e420c4a9af8e70a8a8a6255ee23c581d8 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Thu, 8 Aug 2024 11:55:49 +0200 Subject: [PATCH 12/21] fixup: drop link attributes Signed-off-by: Florian Lehner --- docs/attributes-registry/profile.md | 10 ---------- docs/general/profiles.md | 24 ------------------------ model/profiles/link.yaml | 10 ---------- model/registry/profile.yaml | 19 ------------------- 4 files changed, 63 deletions(-) delete mode 100644 model/profiles/link.yaml diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index fc359fd7cd..40ce427f38 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -8,7 +8,6 @@ - [Profile Build Id](#profile-build-id-attributes) - [Profile Frame](#profile-frame-attributes) -- [Profile Link](#profile-link-attributes) ## Profile Build Id Attributes @@ -40,12 +39,3 @@ Describes the origin of a single frame in a Profile. | `python` | [Python]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ruby` | [Ruby]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `v8js` | [V8JS]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - -## Profile Link Attributes - -Connect Profile information to Spans and Traces. - -| Attribute | Type | Description | Examples | Stability | -| ----------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ---------------------------------------------------------------- | -| `profile.link.span_id` | string | A 8-byte array identifier for a span as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `00f067aa0ba902b7` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `profile.link.trace_id` | string | A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `4bf92f3577b34da6a3ce929d0e0e4736` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 105853804c..d63f156787 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -10,9 +10,7 @@ aliases: [docs/specs/semconv/general/profiles-general] - [Build ID](#build-id) -- [Spans and Traces](#spans-and-traces) - [Frame types](#frame-types) -- [Reserved attributes](#reserved-attributes) @@ -36,28 +34,6 @@ They may be used in any Profiles record they apply to. | [`profile.build_id.go`](/docs/attributes-registry/profile.md) | string | The Go build ID. | `foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - - - - - -## Spans and Traces - -**Description:** Connect Profile information to Spans and Traces. - - - - - - - - -| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | -|---|---|---|---|---|---| -| [`profile.link.span_id`](/docs/attributes-registry/profile.md) | string | A 8-byte array identifier for a span as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `00f067aa0ba902b7` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| [`profile.link.trace_id`](/docs/attributes-registry/profile.md) | string | A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). | `4bf92f3577b34da6a3ce929d0e0e4736` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - - diff --git a/model/profiles/link.yaml b/model/profiles/link.yaml deleted file mode 100644 index 9c73b4a715..0000000000 --- a/model/profiles/link.yaml +++ /dev/null @@ -1,10 +0,0 @@ -groups: - - id: profile.link - type: attribute_group - brief: > - Connect Profile information to Spans and Traces. - attributes: - - ref: profile.link.trace_id - requirement_level: opt_in - - ref: profile.link.span_id - requirement_level: opt_in diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index 628184486e..5bcd809c96 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -19,25 +19,6 @@ groups: The Go build ID. examples: ['foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY'] - - id: registry.profile.link - type: attribute_group - prefix: profile.link - brief: > - Connect Profile information to Spans and Traces. - attributes: - - id: trace_id - stability: experimental - type: string - brief: > - A 16-byte array identifier for a trace as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). - examples: ['4bf92f3577b34da6a3ce929d0e0e4736'] - - id: span_id - stability: experimental - type: string - brief: > - A 8-byte array identifier for a span as specified in [`SpanContext`](https://opentelemetry.io/docs/specs/otel/trace/api/#spancontext). - examples: ['00f067aa0ba902b7'] - - id: registry.profile.frame type: attribute_group prefix: profile.frame From ff6aaa2305d28e0fce6f1cd81b73dcc72cefa0d7 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Thu, 8 Aug 2024 11:56:17 +0200 Subject: [PATCH 13/21] fixup: fix missing DocumentStatus link Signed-off-by: Florian Lehner --- docs/general/profiles.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index d63f156787..9ca8c8ee7a 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -74,3 +74,5 @@ They may be used in any Profiles record they apply to. + +[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status From 7dbce841006dad6eb3a38cba44812671f01b8f7f Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Thu, 8 Aug 2024 12:25:07 +0200 Subject: [PATCH 14/21] fixup: drop prefix in attribute Signed-off-by: Florian Lehner --- docs/attributes-registry/profile.md | 4 ++-- model/registry/profile.yaml | 8 +++----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index 40ce427f38..c90152ac80 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -6,8 +6,8 @@ # Profile -- [Profile Build Id](#profile-build-id-attributes) -- [Profile Frame](#profile-frame-attributes) +- [Profile Build Id Attributes](#profile-build-id-attributes) +- [Profile Frame Attributes](#profile-frame-attributes) ## Profile Build Id Attributes diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index 5bcd809c96..9ad20afcc5 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -2,17 +2,16 @@ groups: - id: registry.profile.build_id type: attribute_group - prefix: profile.build_id brief: > Unique identifier for an executable. attributes: - - id: gnu + - id: profile.build_id.gnu stability: experimental type: string brief: > The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. examples: ['c89b11207f6479603b0d49bf291c092c2b719293'] - - id: go + - id: profile.build_id.go stability: experimental type: string brief: > @@ -21,11 +20,10 @@ groups: - id: registry.profile.frame type: attribute_group - prefix: profile.frame brief: > Describes the origin of a single frame in a Profile. attributes: - - id: type + - id: profile.frame.type stability: experimental brief: > Describes the interpreter or compiler of a single frame. From 2ae1ac9c7156438f3698e9b0fb1f5ca182157926 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Fri, 9 Aug 2024 09:29:16 +0200 Subject: [PATCH 15/21] fixup: drop build_id Signed-off-by: Florian Lehner --- docs/attributes-registry/profile.md | 12 ------------ docs/general/profiles.md | 23 ----------------------- model/profiles/executable.yaml | 10 ---------- model/registry/profile.yaml | 18 ------------------ 4 files changed, 63 deletions(-) delete mode 100644 model/profiles/executable.yaml diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index c90152ac80..42e2d34404 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -6,18 +6,6 @@ # Profile -- [Profile Build Id Attributes](#profile-build-id-attributes) -- [Profile Frame Attributes](#profile-frame-attributes) - -## Profile Build Id Attributes - -Unique identifier for an executable. - -| Attribute | Type | Description | Examples | Stability | -| ---------------------- | ------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| `profile.build_id.gnu` | string | The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. | `c89b11207f6479603b0d49bf291c092c2b719293` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `profile.build_id.go` | string | The Go build ID. | `foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - ## Profile Frame Attributes Describes the origin of a single frame in a Profile. diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 9ca8c8ee7a..a92d944539 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -9,7 +9,6 @@ aliases: [docs/specs/semconv/general/profiles-general] -- [Build ID](#build-id) - [Frame types](#frame-types) @@ -17,28 +16,6 @@ aliases: [docs/specs/semconv/general/profiles-general] The attributes described in this section are rather generic. They may be used in any Profiles record they apply to. -## Build ID - -**Description:** Unique identifier for an executable. - - - - - - - - -| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | -|---|---|---|---|---|---| -| [`profile.build_id.gnu`](/docs/attributes-registry/profile.md) | string | The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. | `c89b11207f6479603b0d49bf291c092c2b719293` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| [`profile.build_id.go`](/docs/attributes-registry/profile.md) | string | The Go build ID. | `foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - - - - - - - ## Frame types **Description:** Describes the origin of a single frame in a Profile. diff --git a/model/profiles/executable.yaml b/model/profiles/executable.yaml deleted file mode 100644 index e3788e29b3..0000000000 --- a/model/profiles/executable.yaml +++ /dev/null @@ -1,10 +0,0 @@ -groups: - - id: profile.build_id - type: attribute_group - brief: > - Unique identifier for an executable. - attributes: - - ref: profile.build_id.gnu - requirement_level: opt_in - - ref: profile.build_id.go - requirement_level: opt_in diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index 9ad20afcc5..0c0fbdb236 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -1,23 +1,5 @@ groups: - - id: registry.profile.build_id - type: attribute_group - brief: > - Unique identifier for an executable. - attributes: - - id: profile.build_id.gnu - stability: experimental - type: string - brief: > - The GNU build ID as can be found in the `.note.gnu.build-id` ELF section. - examples: ['c89b11207f6479603b0d49bf291c092c2b719293'] - - id: profile.build_id.go - stability: experimental - type: string - brief: > - The Go build ID. - examples: ['foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY'] - - id: registry.profile.frame type: attribute_group brief: > From cbf4bc15835219c1fa8302de1100fc336dd7a09f Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 26 Aug 2024 07:41:29 +0200 Subject: [PATCH 16/21] Update model/registry/profile.yaml Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> --- model/registry/profile.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index 0c0fbdb236..c00a497d99 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -15,7 +15,7 @@ groups: members: - id: dotnet brief: > - [.Net](https://wikipedia.org/wiki/.NET) + [.NET](https://wikipedia.org/wiki/.NET) value: "dotnet" stability: experimental - id: jvm From fd301acc5ec7d157171c47793e2b99be2dcda20d Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 26 Aug 2024 08:24:41 +0200 Subject: [PATCH 17/21] fixup: linter Signed-off-by: Florian Lehner --- docs/attributes-registry/profile.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index 42e2d34404..dab6b06dcd 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -18,7 +18,7 @@ Describes the origin of a single frame in a Profile. | Value | Description | Stability | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| `dotnet` | [.Net](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `kernel` | [Kernel]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `native` | [C](), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](), [Rust]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | From 616073187240c3659cdfe2ca1dff978cd8dd6d49 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 26 Aug 2024 08:35:09 +0200 Subject: [PATCH 18/21] fixup: linter Signed-off-by: Florian Lehner --- docs/general/profiles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index a92d944539..617c08b8fa 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -35,7 +35,7 @@ They may be used in any Profiles record they apply to. | Value | Description | Stability | |---|---|---| -| `dotnet` | [.Net](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `kernel` | [Kernel](https://wikipedia.org/wiki/Kernel_(operating_system)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `native` | [C](https://wikipedia.org/wiki/C_(programming_language)), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](https://wikipedia.org/wiki/Go_(programming_language)), [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | From 608fb5c84773a3c7d060ebafd351677336e0839b Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Wed, 28 Aug 2024 15:49:21 +0200 Subject: [PATCH 19/21] fixup: use cpython Signed-off-by: Florian Lehner --- docs/attributes-registry/profile.md | 28 ++++++++++++++-------------- model/registry/profile.yaml | 6 +++--- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index dab6b06dcd..2f0ee59906 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -10,20 +10,20 @@ Describes the origin of a single frame in a Profile. -| Attribute | Type | Description | Examples | Stability | -| -------------------- | ------ | -------------------------------------------------------- | -------- | ---------------------------------------------------------------- | -| `profile.frame.type` | string | Describes the interpreter or compiler of a single frame. | `python` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| Attribute | Type | Description | Examples | Stability | +| -------------------- | ------ | -------------------------------------------------------- | --------- | ---------------------------------------------------------------- | +| `profile.frame.type` | string | Describes the interpreter or compiler of a single frame. | `cpython` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | `profile.frame.type` 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 | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `kernel` | [Kernel]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `native` | [C](), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](), [Rust]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `perl` | [Perl](https://wikipedia.org/wiki/Perl) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `python` | [Python]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `ruby` | [Ruby]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `v8js` | [V8JS]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| Value | Description | Stability | +| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| `cpython` | [Python]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `kernel` | [Kernel]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `native` | [C](), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](), [Rust]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `perl` | [Perl](https://wikipedia.org/wiki/Perl) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `ruby` | [Ruby]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `v8js` | [V8JS]() | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/model/registry/profile.yaml b/model/registry/profile.yaml index c00a497d99..8bbac2ef51 100644 --- a/model/registry/profile.yaml +++ b/model/registry/profile.yaml @@ -9,7 +9,7 @@ groups: stability: experimental brief: > Describes the interpreter or compiler of a single frame. - examples: ['python'] + examples: ['cpython'] type: allow_custom_values: true members: @@ -46,10 +46,10 @@ groups: [PHP](https://wikipedia.org/wiki/PHP) value: "php" stability: experimental - - id: python + - id: cpython brief: > [Python](https://wikipedia.org/wiki/Python_(programming_language)) - value: "python" + value: "cpython" stability: experimental - id: ruby brief: > From b6aed34588cc8313eb789884f87d7acc54a3f7c4 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Mon, 2 Sep 2024 17:14:16 +0200 Subject: [PATCH 20/21] fixup: run make fix Signed-off-by: Florian Lehner --- docs/general/profiles.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 617c08b8fa..33f129e183 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -29,19 +29,19 @@ They may be used in any Profiles record they apply to. | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| -| [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `python` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `cpython` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | `profile.frame.type` 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 | |---|---|---| +| `cpython` | [Python](https://wikipedia.org/wiki/Python_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `kernel` | [Kernel](https://wikipedia.org/wiki/Kernel_(operating_system)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `native` | [C](https://wikipedia.org/wiki/C_(programming_language)), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](https://wikipedia.org/wiki/Go_(programming_language)), [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perl` | [Perl](https://wikipedia.org/wiki/Perl) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `php` | [PHP](https://wikipedia.org/wiki/PHP) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `python` | [Python](https://wikipedia.org/wiki/Python_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ruby` | [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `v8js` | [V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | From 94bb7ed8f9f3288bffa02744058071c3d36ca4af Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Tue, 3 Sep 2024 11:48:11 +0200 Subject: [PATCH 21/21] fixup: set requirement level to recommended from opt-in Signed-off-by: Florian Lehner --- docs/general/profiles.md | 2 +- model/profiles/frame.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 33f129e183..93efd6a67c 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -29,7 +29,7 @@ They may be used in any Profiles record they apply to. | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| -| [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `cpython` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `cpython` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | `profile.frame.type` 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. diff --git a/model/profiles/frame.yaml b/model/profiles/frame.yaml index 44cf31063d..2c7994adfc 100644 --- a/model/profiles/frame.yaml +++ b/model/profiles/frame.yaml @@ -5,4 +5,4 @@ groups: Describes the origin of a single frame in a Profile. attributes: - ref: profile.frame.type - requirement_level: opt_in + requirement_level: recommended