This repository has been archived by the owner on Oct 9, 2023. It is now read-only.
Append the labels that don't exist in metricStringKeys #124
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
Signed-off-by: Kevin Su <[email protected]>
pingsutw
requested review from
EngHabu,
katrogan,
kumare3 and
wild-endeavor
as code owners
Codecov Report
@@ Coverage Diff @@
## master #124 +/- ##
==========================================
+ Coverage 68.54% 68.89% +0.34%
==========================================
Files 68 68
Lines 3332 3343 +11
==========================================
+ Hits 2284 2303 +19
+ Misses 882 871 -11
- Partials 166 169 +3
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
EngHabu
reviewed
Apr 1, 2022
promutils/labeled/counter.go
Outdated
Comment on lines
71
to
76
| var labels []string | ||
| for _, label := range additionalLabels.Labels { | ||
| if contains(metricStringKeys, label) == false { | ||
| labels = append(labels, label) | ||
| } | ||
| } |
There was a problem hiding this comment.
Nit:
Suggested change
| var labels []string | |
| for _, label := range additionalLabels.Labels { | |
| if contains(metricStringKeys, label) == false { | |
| labels = append(labels, label) | |
| } | |
| } | |
| labels := make([]string, 0, len(additionalLabels.Labels) | |
| metricKeysSet := sets.NewString(metricStringKeys...) | |
| for _, label := range additionalLabels.Labels { | |
| if !metricKeysSet.Contains(label) { | |
| labels = append(labels, label) | |
| } | |
| } |
There was a problem hiding this comment.
And then we can delete the contains function
There was a problem hiding this comment.
updated it, thank you @EngHabu
Signed-off-by: Kevin Su <[email protected]>
EngHabu
previously approved these changes
Apr 2, 2022
EngHabu
reviewed
Apr 2, 2022
Signed-off-by: Kevin Su <[email protected]>
honnix
reviewed
Jun 6, 2022
| c.additionalLabels = contextutils.MetricKeysFromStrings(additionalLabels.Labels) | ||
| labels := GetUniqueLabels(metricStringKeys, additionalLabels.Labels) | ||
| // Here we only append the labels that don't exist in metricStringKeys | ||
| c.CounterVec = scope.MustNewCounterVec(name, description, append(metricStringKeys, labels...)...) |
There was a problem hiding this comment.
This append here may modify the same underly array backing up metricStringKeys and cause corruption for a counter that was created previously.
A repro:
package labeled
import (
"context"
"testing"
"github.com/flyteorg/flytestdlib/contextutils"
"github.com/flyteorg/flytestdlib/promutils"
"github.com/stretchr/testify/assert"
)
func TestLabeledCounter(t *testing.T) {
UnsetMetricKeys()
assert.NotPanics(t, func() {
SetMetricKeys(contextutils.ProjectKey, contextutils.DomainKey, contextutils.WorkflowIDKey)
})
scope := promutils.NewTestScope()
c1 := NewCounter(
"handle_count1",
"c1",
/*scope=*/ scope,
/*opts=*/ AdditionalLabelsOption{Labels: []string{"foo"}},
)
c2 := NewCounter(
"handle_count2",
"c2",
/*scope=*/ scope,
/*opts=*/ AdditionalLabelsOption{Labels: []string{"tasktype"}}, // this corrupts c1
)
ctx := context.TODO()
ctx = contextutils.WithProjectDomain(ctx, "project", "domain")
ctx = contextutils.WithWorkflowID(ctx, "workflow")
ctx = contextutils.WithTaskID(ctx, "task")
ctx = contextutils.WithTaskType(ctx, "type")
ctx = context.WithValue(ctx, "foo", "foo")
c1.Inc(ctx) // <--- panic here
c2.Inc(ctx)
}cc @hamersaw
There was a problem hiding this comment.
It was not introduced by this PR though, the last change of this was ages ago in pingsutw@c811acb. :)
eapolinario
pushed a commit
that referenced
this pull request
Sep 6, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: Kevin Su [email protected]
TL;DR
We should append the labels that don't exist in metricStringKeys
Failed to start datacatalog in single binary because we attempted to register the same metric key.
Error message:
Type
Are all requirements met?
Complete description
How did you fix the bug, make the feature etc. Link to any design docs etc
Tracking Issue
flyteorg/flyte#2266
Follow-up issue
NA