-
Notifications
You must be signed in to change notification settings - Fork 253
[profiles] introduce semantic convention #1188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
AlexanderWert
merged 25 commits into
open-telemetry:main
from
florianl:profiles-convention
Sep 3, 2024
Merged
Changes from 24 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
77a7f14
[profiles] introduce semantic convention
florianl 412f7e7
fixup: update dropdown areas
florianl e0a5bf2
fixup: yamllint
florianl 5d9951c
fixup: add PR number to changelog
florianl 1580868
fixup: apply feedback from @trisch-me
florianl d38386d
fixup: apply feedback from @trask
florianl ffecd92
fixup: apply feedback from @trask
florianl 377193e
fixup: apply feedback from @trask
florianl bec7ce7
fixup: run markdown-toc
florianl 9870057
fixup: markdown
florianl 9f65c24
fixup: remove reserved attributes
florianl f632512
fixup: drop link attributes
florianl ff6aaa2
fixup: fix missing DocumentStatus link
florianl 7dbce84
fixup: drop prefix in attribute
florianl 2ae1ac9
fixup: drop build_id
florianl 823d1d4
Merge branch 'main' into profiles-convention
florianl aeb2739
Merge branch 'main' into profiles-convention
florianl cbf4bc1
Update model/registry/profile.yaml
florianl fd301ac
fixup: linter
florianl 6160731
fixup: linter
florianl c85ae3e
Merge branch 'main' into profiles-convention
florianl 608fb5c
fixup: use cpython
florianl 7b8cbc5
Merge branch 'main' into profiles-convention
joaopgrassi b6aed34
fixup: run make fix
florianl 94bb7ed
fixup: set requirement level to recommended from opt-in
florianl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: new_component | ||
|
||
# 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: 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: [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. | ||
# Use pipe (|) for multiline entries. | ||
subtext: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -67,6 +67,7 @@ body: | |
- area:otel | ||
- area:peer | ||
- area:process | ||
- area:profile | ||
- area:rpc | ||
- area:server | ||
- area:service | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,6 +59,7 @@ body: | |
- area:otel | ||
- area:peer | ||
- area:process | ||
- area:profile | ||
- area:rpc | ||
- area:server | ||
- area:service | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -68,6 +68,7 @@ body: | |
- area:otel | ||
- area:peer | ||
- area:process | ||
- area:profile | ||
- area:rpc | ||
- area:server | ||
- area:service | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!--- Hugo front matter used to generate the website version of this page: | ||
---> | ||
|
||
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
<!-- see templates/registry/markdown/attribute_namespace.md.j2 --> | ||
|
||
# Profile | ||
|
||
## 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. | `cpython` |  | | ||
|
||
`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)>) |  | | ||
| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) |  | | ||
| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) |  | | ||
| `kernel` | [Kernel](<https://wikipedia.org/wiki/Kernel_(operating_system)>) |  | | ||
| `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)>) |  | | ||
| `perl` | [Perl](https://wikipedia.org/wiki/Perl) |  | | ||
| `php` | [PHP](https://wikipedia.org/wiki/PHP) |  | | ||
| `ruby` | [Ruby](<https://wikipedia.org/wiki/Ruby_(programming_language)>) |  | | ||
| `v8js` | [V8JS](<https://wikipedia.org/wiki/V8_(JavaScript_engine)>) |  | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
<!--- Hugo front matter used to generate the website version of this page: | ||
linkTitle: Logs | ||
aliases: [docs/specs/semconv/general/profiles-general] | ||
---> | ||
|
||
# General Profiles Attributes | ||
|
||
**Status**: [Experimental][DocumentStatus] | ||
|
||
<!-- toc --> | ||
|
||
- [Frame types](#frame-types) | ||
|
||
<!-- tocstop --> | ||
|
||
The attributes described in this section are rather generic. | ||
They may be used in any Profiles record they apply to. | ||
|
||
## Frame types | ||
|
||
**Description:** Describes the origin of a single frame in a Profile. | ||
|
||
<!-- semconv profile.frame(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 | | ||
|---|---|---|---|---|---| | ||
| [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `cpython` | `Opt-In` |  | | ||
|
||
`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)) |  | | ||
| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) |  | | ||
| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) |  | | ||
| `kernel` | [Kernel](https://wikipedia.org/wiki/Kernel_(operating_system)) |  | | ||
| `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)) |  | | ||
| `perl` | [Perl](https://wikipedia.org/wiki/Perl) |  | | ||
| `php` | [PHP](https://wikipedia.org/wiki/PHP) |  | | ||
| `ruby` | [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) |  | | ||
| `v8js` | [V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) |  | | ||
|
||
|
||
|
||
<!-- markdownlint-restore --> | ||
<!-- prettier-ignore-end --> | ||
<!-- END AUTOGENERATED TEXT --> | ||
<!-- endsemconv --> | ||
|
||
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
groups: | ||
|
||
- id: registry.profile.frame | ||
type: attribute_group | ||
brief: > | ||
Describes the origin of a single frame in a Profile. | ||
attributes: | ||
- id: profile.frame.type | ||
stability: experimental | ||
brief: > | ||
Describes the interpreter or compiler of a single frame. | ||
examples: ['cpython'] | ||
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)) | ||
AlexanderWert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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: cpython | ||
brief: > | ||
[Python](https://wikipedia.org/wiki/Python_(programming_language)) | ||
value: "cpython" | ||
stability: experimental | ||
- id: ruby | ||
brief: > | ||
[Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) | ||
value: "ruby" | ||
stability: experimental | ||
- id: v8js | ||
brief: > | ||
[V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) | ||
value: "v8js" | ||
stability: experimental | ||
florianl marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.