opentelemetry-specification icon indicating copy to clipboard operation
opentelemetry-specification copied to clipboard

Introduce specification for OTel Profiles

Open florianl opened this issue 1 year ago • 8 comments

Changes

Proposed change along with https://github.com/open-telemetry/semantic-conventions/pull/1329 to clarify the use of build_id in the context of OTel Profiles.

FYI: @open-telemetry/profiling-maintainers

florianl avatar Aug 27 '24 13:08 florianl

We don't yet have anything about profiles in the spec, this would be the first. I think we need to decide what sections about profiling we want in the spec. Is it going to be data model description?

Is data model going to be decoupled from its OTLP representation like we do for other signals (see log data model vs log proto or metric data model vs metric proto)?

Or do we think that OTLP representation is all we care about? In that case this clarification about Mappings could be added to proto.

@open-telemetry/profiling-maintainers @open-telemetry/spec-sponsors thoughts?

tigrannajaryan avatar Aug 27 '24 16:08 tigrannajaryan

Is data model going to be decoupled from its OTLP representation like we do for other signals [...]

Or do we think that OTLP representation is all we care about? In that case this clarification about Mappings could be added to proto.

My initial preference would be to not maintain a separate data model description and focus on the OTLP representation. I'm assuming we can always come back to it and add an abstract data model description later?

felixge avatar Aug 28 '24 08:08 felixge

My initial preference would be to not maintain a separate data model description and focus on the OTLP representation. I'm assuming we can always come back to it and add an abstract data model description later?

In my mind they're effectively the same thing, but the data model is a bit richer / filled with descriptions on usage and advanced concepts that may not be in the protocol.

E.g. a description on how to associate symbols back to profiles outside of the raw OTLP send is in your data model.

I agree that focusing on OTLP representaiton is priority #1 - but that's effectively working on the data model. You need a location to put information about how to consume and interpret the OTLP that goes beyond just "here's what this one message means".

jsuereth avatar Aug 28 '24 12:08 jsuereth

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions[bot] avatar Sep 06 '24 03:09 github-actions[bot]

Added the hash specification for process.executable.build_id.profiling` for https://github.com/open-telemetry/semantic-conventions/pull/1329.

florianl avatar Sep 10 '24 09:09 florianl

As https://github.com/open-telemetry/semantic-conventions/pull/1329 got merged, is there something I can do to continue with this specification? The hash algorithm as described in this document is essential for process.executable.build_id.profiling.

florianl avatar Sep 23 '24 07:09 florianl

is there something I can do to continue with this specification?

hey @florianl! stuck spec PRs are not uncommon 😅 and there is some general guidance here: https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#how-to-get-your-pr-merged

in this case I'd recommend reaching out to the profiling folks in the Profiling SIG meeting and in the #otel-profiling slack channel if you haven't already

trask avatar Sep 26 '24 22:09 trask

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions[bot] avatar Oct 04 '24 03:10 github-actions[bot]

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions[bot] avatar Oct 24 '24 03:10 github-actions[bot]

friendly ping @open-telemetry/technical-committee - can you provide some feedback why this change shouldn't move forward?

florianl avatar Oct 24 '24 05:10 florianl

friendly ping @open-telemetry/technical-committee - can you provide some feedback why this change shouldn't move forward?

AFAIK no such decision was made. Github will mark PRs stale based on activity and close them after a few days. Usually someone with permissions to do so manually removes the label before that happens but we can always reopen the closed PR.

christos68k avatar Oct 24 '24 07:10 christos68k

This has enough approvals, including 2 from @open-telemetry/profiling-maintainers, so I am merging.

tigrannajaryan avatar Oct 24 '24 14:10 tigrannajaryan