fix(profiling)!: ensure a single label per sample has key "local root span id" #88
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.
What does this PR do?
This enforces that only a single label on a sample may contain a key of "local root span id". This means a
Profile::add
can now return an error case where it wouldn't before if multiple labels with keys of "local root span id" are sent. This is inherited by the FFI equivalent function as well, which returns 0 for such cases.Motivation
I had a conversation with Ivo in #80 and continued over Slack in which he convinced me the code would be overall simpler if we did this. Aside from being non-sensical to have multiple local root span id labels, it's also an implementation optimization.
Additional Notes
I like having Ivo on the team :)
How to test the change?
Upgrade, and run tests as normal. Unless you are sending multiple labels with keys of "local root span id", then this will behave the same.