Skip to content

Commit 3b0767c

Browse files
author
Shawn Hurley
committed
addressing PR comments
1 parent aa0f930 commit 3b0767c

File tree

3 files changed

+24
-25
lines changed

3 files changed

+24
-25
lines changed

pkg/sdk/informer-sync.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ func (i *informer) sync(key string) error {
8888
}
8989
switch {
9090
case err == nil:
91-
i.metrics.SyncEvents.WithLabelValues(metrics.SyncResultSuccess).Inc()
91+
i.metrics.ReconcileResult.WithLabelValues(metrics.SyncResultSuccess).Inc()
9292
case err != nil:
93-
i.metrics.SyncEvents.WithLabelValues(metrics.SyncResultFailure).Inc()
93+
i.metrics.ReconcileResult.WithLabelValues(metrics.SyncResultFailure).Inc()
9494
}
9595
return err
9696
}

pkg/sdk/informer.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
"time"
2020

2121
"github.com/operator-framework/operator-sdk/pkg/sdk/metrics"
22+
2223
"github.com/sirupsen/logrus"
2324
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2425
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -99,7 +100,7 @@ func (i *informer) handleAddResourceEvent(obj interface{}) {
99100
if err != nil {
100101
panic(err)
101102
}
102-
i.metrics.Events.WithLabelValues(metrics.EventTypeAdd).Inc()
103+
i.metrics.EventType.WithLabelValues(metrics.EventTypeAdd).Inc()
103104
i.queue.Add(key)
104105
}
105106

@@ -114,7 +115,7 @@ func (i *informer) handleDeleteResourceEvent(obj interface{}) {
114115
// TODO: Revisit the need for passing delete events to the handler
115116
// Save the last known state for the deleted object
116117
i.deletedObjects[key] = obj.(*unstructured.Unstructured).DeepCopy()
117-
i.metrics.Events.WithLabelValues(metrics.EventTypeDelete).Inc()
118+
i.metrics.EventType.WithLabelValues(metrics.EventTypeDelete).Inc()
118119

119120
i.queue.Add(key)
120121
}
@@ -124,6 +125,6 @@ func (i *informer) handleUpdateResourceEvent(oldObj, newObj interface{}) {
124125
if err != nil {
125126
panic(err)
126127
}
127-
i.metrics.Events.WithLabelValues(metrics.EventTypeUpdate).Inc()
128+
i.metrics.EventType.WithLabelValues(metrics.EventTypeUpdate).Inc()
128129
i.queue.Add(key)
129130
}

pkg/sdk/metrics/metrics.go

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import (
88
)
99

1010
const (
11-
eventsMetricName = "operator_sdk_events"
12-
syncEventsMetricName = "operator_sdk_sync_events"
11+
eventsMetricName = "operator_sdk_event_type"
12+
syncEventsMetricName = "operator_sdk_reconcile_result"
1313
// EventTypeLabel - metric label for event type
1414
EventTypeLabel = "type"
1515
// EventTypeAdd - addition event label
@@ -32,45 +32,43 @@ var (
3232

3333
// Collector - metric collector for all the metrics the sdk will watch
3434
type Collector struct {
35-
Events *prom.CounterVec
36-
SyncEvents *prom.CounterVec
35+
EventType *prom.CounterVec
36+
ReconcileResult *prom.CounterVec
3737
}
3838

3939
// New - create a new Collector
4040
func New() *Collector {
4141
return &Collector{
42-
Events: prom.NewCounterVec(prom.CounterOpts{
42+
EventType: prom.NewCounterVec(prom.CounterOpts{
4343
Name: eventsMetricName,
44-
Help: "Events that the sdk has recieved, segmented by type(add or delete or update)",
44+
Help: "events that the sdk has recieved, segmented by type(add or delete or update)",
4545
}, []string{EventTypeLabel}),
46-
SyncEvents: prom.NewCounterVec(prom.CounterOpts{
46+
ReconcileResult: prom.NewCounterVec(prom.CounterOpts{
4747
Name: syncEventsMetricName,
48-
Help: "events that the sdk has processed segmented by result(success or failure) includes reconcilation events.",
48+
Help: "reconcilation events that the sdk has processed segmented by result(success or failure)",
4949
}, []string{SyncResultLabel}),
5050
}
5151
}
5252

53-
// RegisterCollector - add collector safetly to prometheus
53+
// RegisterCollector - add collector safely to prometheus
5454
func RegisterCollector(c *Collector) {
55-
defer func() {
56-
if r := recover(); r != nil {
57-
logrus.Errorf("unable to add metrics to prometheus: %v", r)
58-
}
59-
}()
6055
once.Do(func() {
61-
prom.MustRegister(c)
56+
err := prom.Register(c)
57+
if err != nil {
58+
logrus.Errorf("unable to register collector with prometheus: %v", err)
59+
}
6260
})
6361
}
6462

6563
// Describe returns all the descriptions of the collector
6664
func (s *Collector) Describe(ch chan<- *prom.Desc) {
67-
s.Events.Describe(ch)
68-
s.SyncEvents.Describe(ch)
65+
s.EventType.Describe(ch)
66+
s.ReconcileResult.Describe(ch)
6967

7068
}
7169

72-
// Collect returns the current ssstate of the metrics
70+
// Collect returns the current state of the metrics
7371
func (s *Collector) Collect(ch chan<- prom.Metric) {
74-
s.Events.Collect(ch)
75-
s.SyncEvents.Collect(ch)
72+
s.EventType.Collect(ch)
73+
s.ReconcileResult.Collect(ch)
7674
}

0 commit comments

Comments
 (0)