92 lines
5.8 KiB
Markdown
92 lines
5.8 KiB
Markdown
<!--- Hugo front matter used to generate the website version of this page:
|
|
linkTitle: Profiles
|
|
--->
|
|
|
|
# Profiles attributes
|
|
|
|
**Status**: [Development][DocumentStatus]
|
|
|
|
<!-- toc -->
|
|
|
|
- [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
|
|
|
|
**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/registry/attributes/profile.md) | string | Describes the interpreter or compiler of a single frame. | `cpython` | `Recommended` |  |
|
|
|
|
---
|
|
|
|
`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 |
|
|
|---|---|---|
|
|
| `beam` | [Erlang](https://en.wikipedia.org/wiki/BEAM_(Erlang_virtual_machine)) |  |
|
|
| `cpython` | [Python](https://wikipedia.org/wiki/Python_(programming_language)) |  |
|
|
| `dotnet` | [.NET](https://wikipedia.org/wiki/.NET) |  |
|
|
| `go` | [Go](https://wikipedia.org/wiki/Go_(programming_language)), |  |
|
|
| `jvm` | [JVM](https://wikipedia.org/wiki/Java_virtual_machine) |  |
|
|
| `kernel` | [Kernel](https://wikipedia.org/wiki/Kernel_(operating_system)) |  |
|
|
| `native` | Can be one of but not limited to [C](https://wikipedia.org/wiki/C_(programming_language)), [C++](https://wikipedia.org/wiki/C%2B%2B), [Go](https://wikipedia.org/wiki/Go_(programming_language)) or [Rust](https://wikipedia.org/wiki/Rust_(programming_language)). If possible, a more precise value MUST be used. |  |
|
|
| `perl` | [Perl](https://wikipedia.org/wiki/Perl) |  |
|
|
| `php` | [PHP](https://wikipedia.org/wiki/PHP) |  |
|
|
| `ruby` | [Ruby](https://wikipedia.org/wiki/Ruby_(programming_language)) |  |
|
|
| `rust` | [Rust](https://wikipedia.org/wiki/Rust_(programming_language)) |  |
|
|
| `v8js` | [V8JS](https://wikipedia.org/wiki/V8_(JavaScript_engine)) |  |
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
<!-- 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` |  |
|
|
| [`pprof.mapping.has_filenames`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are filenames related to this mapping. | | `Recommended` |  |
|
|
| [`pprof.mapping.has_functions`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are functions related to this mapping. | | `Recommended` |  |
|
|
| [`pprof.mapping.has_inline_frames`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are inline frames related to this mapping. | | `Recommended` |  |
|
|
| [`pprof.mapping.has_line_numbers`](/docs/registry/attributes/pprof.md) | boolean | Indicates that there are line numbers related to this mapping. | | `Recommended` |  |
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
<!-- END AUTOGENERATED TEXT -->
|
|
<!-- endsemconv -->
|
|
|
|
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
|
|
[pprofLink]: https://github.com/google/pprof
|