fix: deprecate pprof MergeNoClone #3251
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kolesnikovae
force-pushed
the
chore/deprecate-merge-no-clone
branch
from
c0d797d
to
4121d1b
Compare
kolesnikovae
commented
Apr 25, 2024
kolesnikovae
commented
Apr 25, 2024
Comment on lines
24
to
+37
| p, err := OpenFile("testdata/go.cpu.labels.pprof") | ||
| require.NoError(t, err) | ||
| var m ProfileMerge | ||
| require.NoError(t, m.Merge(p.Profile)) | ||
| require.NoError(t, m.Merge(p.Profile.CloneVT())) | ||
| sortLabels(p.Profile) | ||
| testhelper.EqualProto(t, p.Profile, m.Profile()) | ||
| } | ||
|
|
||
| func sortLabels(p *profilev1.Profile) { | ||
| for _, s := range p.Sample { | ||
| sort.Sort(LabelsByKeyValue(s.Label)) | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Note that Merge modifies profiles in place. Therefore, some tests were incorrect. MergeNoClone in addition retains the objects; it's quite hard to use the function correctly.
kolesnikovae
changed the title
korniltsev
approved these changes
May 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
pprof.MergeNoClonehas particularly tricky semantics which is very easy to misuse: specifically, it may cause duplication of samples. Although the function is significantly cheaper thanpprof.Mergeand can be fixed, I think it's better to deprecate it in favour of safety