Skip to content
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

profiles: drop Sample.stacktrace_id_index #575

Merged
merged 2 commits into from
Sep 4, 2024

Conversation

florianl
Copy link
Contributor

@florianl florianl commented Aug 22, 2024

The value for Sample.stacktrace_id_index is hardly defined except for its length. It is also not defined how this value should be generated, interpreted and could be used.

Some kind of stacktrace_id can be most efficient in stateful protocols, where transmitting duplicate information should be avoided. As the OTel Profiling protocol is a stateless protocol, this element can be droped.

The proposed change is a breaking change. As the OTel Profiling signal is still marked as experimental this should be fine? Please let me know.

FYI: @open-telemetry/profiling-maintainers

The value for Sample.stacktrace_id_index is hardly defined except for its length. It is also not defined how this value should be generated, interpreted and could be used.

Some kind of stacktrace_id can be most efficient in stateful protocols, where transmitting duplicate information should be avoided. As the OTel Profiling protocol is a stateless protocol, this element can be droped.
@florianl florianl requested review from a team August 22, 2024 07:02
Copy link
Member

@felixge felixge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Copy link

@simonswine simonswine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jhalliday
Copy link
Contributor

LGTM

@tigrannajaryan
Copy link
Member

Breaking change check fails since a filed is deleted: https://github.com/open-telemetry/opentelemetry-proto/actions/runs/10503389833/job/29096669193?pr=575

This is fine for Experimental status. We need to modify the breaking change detector to avoid profiling protos for now (or have a different/weaker checksfor profiling protos if that makes more sense).

I suggest to do it in a separate PR. If you propose a PR that fixes this I can merge it first, and that will unblock this PR.

@felixge
Copy link
Member

felixge commented Aug 23, 2024

I guess we should also update the model in the OTEP: open-telemetry/oteps@87b36a6/text/profiles/0239-profiles-data-model.md?plain=1#L528-L529

I'm actually not sure. I thought OTEPs are meant to capture consensus around technical decisions at a point in time, but are not intended to become evergreen documentation? 🤔

@florianl
Copy link
Contributor Author

@tigrannajaryan with #576 I have opened a PR to exclude the Profiles protocol from the breaking-changes check.

@tigrannajaryan
Copy link
Member

I guess we should also update the model in the OTEP: open-telemetry/oteps@87b36a6/text/profiles/0239-profiles-data-model.md?plain=1#L528-L529

I'm actually not sure. I thought OTEPs are meant to capture consensus around technical decisions at a point in time, but are not intended to become evergreen documentation? 🤔

Correct. Any substantial changes are typically done via a new OTEP (that can amend an old OTEP). If changes are not big enough to warrant a new OTEP, they are done directly on the impacted repository.

@tigrannajaryan
Copy link
Member

#576 is merged. Please rebase, it should fix the build.

@florianl
Copy link
Contributor Author

florianl commented Sep 4, 2024

friendly ping @yurishkuro

@tigrannajaryan
Copy link
Member

The PR has enough approvals, merging.

(@florianl when the PR is ready to be merged ping me I can merge it).

@tigrannajaryan tigrannajaryan merged commit 833a4eb into open-telemetry:main Sep 4, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants