Skip to content

Bug 1822396: Update metric when Subscription is updated #1603

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 30, 2020
Merged

Bug 1822396: Update metric when Subscription is updated #1603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pkg/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,5 +267,7 @@ func UpdateSubsSyncCounterStorage(sub *olmv1alpha1.Subscription) {
counterValues.installedCSV = sub.Status.InstalledCSV
counterValues.pkg = sub.Spec.Package
counterValues.channel = sub.Spec.Channel

subscriptionSyncCounters[sub.GetName()] = counterValues
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it needs to block this bugfix, but there should really be some kind of synchronization around access to subscriptionSyncCounters. Would you be interested in making a separate PR with that change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@benluddy sure! I'm curious to see what you mean by synchronization, once we discuss that I'd be happy to open up a PR if needed.

}
}
24 changes: 24 additions & 0 deletions test/e2e/like_metric_matcher_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,30 @@ func WithLabel(n, v string) MetricPredicate {
}
}

func WithName(name string) MetricPredicate {
return WithLabel("name", name)
}

func WithChannel(channel string) MetricPredicate {
return WithLabel("channel", channel)
}

func WithPackage(pkg string) MetricPredicate {
return WithLabel("package", pkg)
}

func WithPhase(phase string) MetricPredicate {
return WithLabel("phase", phase)
}

func WithReason(reason string) MetricPredicate {
return WithLabel("reason", reason)
}

func WithVersion(version string) MetricPredicate {
return WithLabel("version", version)
}

func WithValue(v float64) MetricPredicate {
return MetricPredicate{
name: fmt.Sprintf("WithValue(%g)", v),
Expand Down
72 changes: 55 additions & 17 deletions test/e2e/metrics_e2e_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,15 @@ var _ = Describe("Metrics are generated for OLM managed resources", func() {
Expect(getMetricsFromPod(c, getPodWithLabel(c, "app=olm-operator"), "8081")).To(And(
ContainElement(LikeMetric(
WithFamily("csv_abnormal"),
WithLabel("name", failingCSV.Name),
WithLabel("phase", "Failed"),
WithLabel("reason", "UnsupportedOperatorGroup"),
WithLabel("version", "0.0.0"),
WithName(failingCSV.Name),
WithPhase("Failed"),
WithReason("UnsupportedOperatorGroup"),
WithVersion("0.0.0"),
)),
ContainElement(LikeMetric(
WithFamily("csv_succeeded"),
WithValue(0),
WithLabel("name", failingCSV.Name),
WithName(failingCSV.Name),
)),
))

Expand All @@ -101,8 +101,8 @@ var _ = Describe("Metrics are generated for OLM managed resources", func() {
It("deletes its associated CSV metrics", func() {
// Verify that when the csv has been deleted, it deletes the corresponding CSV metrics
Expect(getMetricsFromPod(c, getPodWithLabel(c, "app=olm-operator"), "8081")).ToNot(And(
ContainElement(LikeMetric(WithFamily("csv_abnormal"), WithLabel("name", failingCSV.Name))),
ContainElement(LikeMetric(WithFamily("csv_succeeded"), WithLabel("name", failingCSV.Name))),
ContainElement(LikeMetric(WithFamily("csv_abnormal"), WithName(failingCSV.Name))),
ContainElement(LikeMetric(WithFamily("csv_succeeded"), WithName(failingCSV.Name))),
))
})
})
Expand Down Expand Up @@ -133,9 +133,9 @@ var _ = Describe("Metrics are generated for OLM managed resources", func() {
return getMetricsFromPod(c, getPodWithLabel(c, "app=catalog-operator"), "8081")
}).Should(ContainElement(LikeMetric(
WithFamily("subscription_sync_total"),
WithLabel("name", "metric-subscription-for-create"),
WithLabel("channel", stableChannel),
WithLabel("package", testPackageName),
WithName("metric-subscription-for-create"),
WithChannel(stableChannel),
WithPackage(testPackageName),
)))
})
})
Expand All @@ -152,7 +152,7 @@ var _ = Describe("Metrics are generated for OLM managed resources", func() {
if err != nil {
return err
}
s.Spec.Channel = "beta"
s.Spec.Channel = betaChannel
_, err = crc.OperatorsV1alpha1().Subscriptions(s.GetNamespace()).Update(context.TODO(), s, metav1.UpdateOptions{})
return err
}).Should(Succeed())
Expand All @@ -170,17 +170,55 @@ var _ = Describe("Metrics are generated for OLM managed resources", func() {
}).Should(And(
Not(ContainElement(LikeMetric(
WithFamily("subscription_sync_total"),
WithLabel("name", "metric-subscription-for-update"),
WithLabel("channel", stableChannel),
WithName("metric-subscription-for-update"),
WithChannel(stableChannel),
WithPackage(testPackageName),
))),
ContainElement(LikeMetric(
WithFamily("subscription_sync_total"),
WithLabel("name", "metric-subscription-for-update"),
WithLabel("channel", "beta"),
WithLabel("package", testPackageName),
WithName("metric-subscription-for-update"),
WithChannel(betaChannel),
WithPackage(testPackageName),
)),
))
})
When("The subscription object is updated again", func() {

BeforeEach(func() {
Eventually(func() error {
s, err := crc.OperatorsV1alpha1().Subscriptions(subscription.GetNamespace()).Get(context.TODO(), subscription.GetName(), metav1.GetOptions{})
if err != nil {
return err
}
s.Spec.Channel = alphaChannel
_, err = crc.OperatorsV1alpha1().Subscriptions(s.GetNamespace()).Update(context.TODO(), s, metav1.UpdateOptions{})
return err
}).Should(Succeed())
})

It("deletes the old subscription metric and emits the new metric(there is only one metric for the subscription)", func() {
Eventually(func() []Metric {
return getMetricsFromPod(c, getPodWithLabel(c, "app=catalog-operator"), "8081")
}).Should(And(
Not(ContainElement(LikeMetric(
WithFamily("subscription_sync_total"),
WithName("metric-subscription-for-update"),
WithChannel(stableChannel),
))),
Not(ContainElement(LikeMetric(
WithFamily("subscription_sync_total"),
WithName("metric-subscription-for-update"),
WithChannel(betaChannel),
WithPackage(testPackageName),
))),
ContainElement(LikeMetric(
WithFamily("subscription_sync_total"),
WithName("metric-subscription-for-update"),
WithChannel(alphaChannel),
WithPackage(testPackageName),
))))
})
})
})

When("A subscription object is deleted after emitting metrics", func() {
Expand All @@ -205,7 +243,7 @@ var _ = Describe("Metrics are generated for OLM managed resources", func() {
It("deletes the Subscription metric", func() {
Eventually(func() []Metric {
return getMetricsFromPod(c, getPodWithLabel(c, "app=catalog-operator"), "8081")
}).ShouldNot(ContainElement(LikeMetric(WithFamily("subscription_sync_total"), WithLabel("name", "metric-subscription-for-delete"))))
}).ShouldNot(ContainElement(LikeMetric(WithFamily("subscription_sync_total"), WithName("metric-subscription-for-delete"))))
})
})
})
Expand Down