Update profiles specification README.md and pprof.md#4932
Conversation
This update take into account the recent introduction of a profiles signal concepts page, removes duplicate information and adds more relevant documentation.
Co-authored-by: Felix Geisendörfer <felix@felixge.de>
Co-authored-by: Felix Geisendörfer <felix@felixge.de>
Co-authored-by: Felix Geisendörfer <felix@felixge.de>
|
I pushed a commit to update status from Development to Alpha. |
|
Closing/opening to trigger the build. |
|
@open-telemetry/specs-approvers PTAL |
1 similar comment
|
@open-telemetry/specs-approvers PTAL |
|
This PR was marked stale. It will be closed in 14 days without additional activity. |
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
|
@tigrannajaryan Everything is resolved now and should be ready for merge |
|
@christos68k please check the build errors. |
The markdown lint error is due to the missing We can either merge #4932 now, or wait until #4965 gets merged first (hopefully we get a second approval there soon). |
|
This PR was marked stale. It will be closed in 14 days without additional activity. |
f1c6078
…4932) ## Changes This update takes into account the [recent introduction](https://github.com/open-telemetry/opentelemetry.io/pull/9339/changes) of a profiles signal concepts [page](https://opentelemetry.io/docs/concepts/signals/profiles/), removes duplicate information and adds more relevant documentation. There is a follow-up PR [here](open-telemetry#4965) that adds the current data format page. CC: @theletterf @open-telemetry/profiling-maintainers @open-telemetry/profiling-approvers * [X] Related issues: [#7874](open-telemetry/opentelemetry.io#7874) * [X] [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md) file updated for non-trivial changes * For trivial changes, include `[chore]` in the PR title to skip the changelog check --------- Co-authored-by: Felix Geisendörfer <felix@felixge.de>
### Context - Clarify that environment variable propagation carriers normalize requested keys, carrier keys, and returned keys. ([open-telemetry#5102](open-telemetry#5102)) - Specify that environment variable propagation carriers only read and return normalized environment variable names. ([open-telemetry#5144](open-telemetry#5144)) - Specify that an empty environment variable propagation name is non-normalized and normalizes to `_`. ([open-telemetry#5163](open-telemetry#5163)) ### Profiles - Remove duplicate information from and extend Profiles documentation (README.md, pprof.md). ([open-telemetry#4932](open-telemetry#4932)) ### Entities - Add specification for communicating entity information as structured log events. ([open-telemetry#4836](open-telemetry#4836)) ### Common - Add an in-development [SDK self-observability](specification/self-observability.md) section, referenced from the Tracing, Metrics, and Logs SDK specs. ([open-telemetry#5087](open-telemetry#5087)) - Clarify non-OTLP representation guidance for nested `AnyValue` values in arrays and maps. ([open-telemetry#5053](open-telemetry#5053)) - Add in-development guidance recommending a JSON object as the string representation for an attribute in non-OTLP protocols. ([open-telemetry#5028](open-telemetry#5028)) - Add in-development guidance recommending a JSON object as the string representation for an attribute collection in non-OTLP protocols. ([open-telemetry#5110](open-telemetry#5110)) ### Compatibility - Deprecate OpenCensus compatibility requirements in the specification. ([open-telemetry#5138](open-telemetry#5138)) - Stabilize sections of Prometheus Metrics Exporter. - Clarify resource attributes configuration. ([open-telemetry#5084](open-telemetry#5084)) - Stabilize the conversion of OTLP Summaries into Prometheus Summaries. ([open-telemetry#5107](open-telemetry#5107)) - Stabilize client libs section. ([open-telemetry#5106](open-telemetry#5106)) - Stabilize Prometheus Metrics Exporter default aggregation configuration. ([open-telemetry#5113](open-telemetry#5113)) - Stabilize sections of Prometheus and OpenMetrics Compatibility. - Stabilize OpenTelemetry Histogram to Prometheus Histogram transformation. ([open-telemetry#5091](open-telemetry#5091)) - Add optional OpenTelemetry Histogram to Prometheus Native Histogram with Custom Buckets transformation. ([open-telemetry#5091](open-telemetry#5091)) ### SDK Configuration - Add link to declarative config IdGenerator type ([open-telemetry#5133](open-telemetry#5133)) ### OTEPs - Context-scoped Attributes. ([open-telemetry#4931](open-telemetry#4931)) --------- Co-authored-by: Reiley Yang <reyang@microsoft.com>
## Changes Adds a data format description for OpenTelemetry profiles. I took some content from the old [OTEP](https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/profiles/0239-profiles-data-model.md) but decided to leave all of the historical information out, both for clarity/focus and to improve readability (a technical specification doesn't read very well by nature). We could add additional references and expand on design decisions in a future `data-format-appendix.md` document. Also see: open-telemetry#4932 (This PR is a follow-up) CC: @theletterf @tigrannajaryan @open-telemetry/profiling-maintainers @open-telemetry/profiling-approvers For non-trivial changes, follow the [change proposal process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change). * [X] Related issues: [#7874](open-telemetry/opentelemetry.io#7874) * [X] [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md) file updated for non-trivial changes * For trivial changes, include `[chore]` in the PR title to skip the changelog check --------- Co-authored-by: Roger Coll <roger.coll@elastic.co> Co-authored-by: Fabrizio Ferri-Benedetti <fabri.ferribenedetti@elastic.co> Co-authored-by: Alexey Alexandrov <aalexand@users.noreply.github.com> Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com> Co-authored-by: Florian Lehner <florianl@users.noreply.github.com>
Changes
This update takes into account the recent introduction of a profiles signal concepts page, removes duplicate information and adds more relevant documentation.
There is a follow-up PR here that adds the current data format page.
CC: @theletterf @open-telemetry/profiling-maintainers @open-telemetry/profiling-approvers
CHANGELOG.mdfile updated for non-trivial changes[chore]in the PR title to skip the changelog check