-
Notifications
You must be signed in to change notification settings - Fork 578
/
stats_reporter.go
164 lines (137 loc) · 4.33 KB
/
stats_reporter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
Copyright 2019 The Knative Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package reconciler
import (
"context"
"fmt"
"time"
"github.com/knative/pkg/metrics"
"go.opencensus.io/stats"
"go.opencensus.io/stats/view"
"go.opencensus.io/tag"
)
type Measurement int
const (
// NatssChannelReadyCountN is the number of natss channels that have become ready.
NatssChannelReadyCountN = "natsschannel_ready_count"
// NatssChannelReadyLatencyN is the time it takes for a natss channel to become ready since the resource is created.
NatssChannelReadyLatencyN = "natsschannel_ready_latency"
)
var (
KindToStatKeys = map[string]StatKey{
"NatssChannel": {
ReadyCountKey: NatssChannelReadyCountN,
ReadyLatencyKey: NatssChannelReadyLatencyN,
},
}
KindToMeasurements map[string]Measurements
reconcilerTagKey tag.Key
keyTagKey tag.Key
)
type Measurements struct {
ReadyLatencyStat *stats.Int64Measure
ReadyCountStat *stats.Int64Measure
}
type StatKey struct {
ReadyLatencyKey string
ReadyCountKey string
}
func init() {
var err error
// Create the tag keys that will be used to add tags to our measurements.
// Tag keys must conform to the restrictions described in
// go.opencensus.io/tag/validate.go. Currently those restrictions are:
// - length between 1 and 255 inclusive
// - characters are printable US-ASCII
reconcilerTagKey = mustNewTagKey("reconciler")
keyTagKey = mustNewTagKey("key")
KindToMeasurements = make(map[string]Measurements, len(KindToStatKeys))
for kind, keys := range KindToStatKeys {
readyLatencyStat := stats.Int64(
keys.ReadyLatencyKey,
fmt.Sprintf("Time it takes for a %s to become ready since created", kind),
stats.UnitMilliseconds)
readyCountStat := stats.Int64(
keys.ReadyCountKey,
fmt.Sprintf("Number of %s that became ready", kind),
stats.UnitDimensionless)
// Save the measurements for later marks.
KindToMeasurements[kind] = Measurements{
ReadyCountStat: readyCountStat,
ReadyLatencyStat: readyLatencyStat,
}
// Create views to see our measurements. This can return an error if
// a previously-registered view has the same name with a different value.
// View name defaults to the measure name if unspecified.
err = view.Register(
&view.View{
Description: readyLatencyStat.Description(),
Measure: readyLatencyStat,
Aggregation: view.LastValue(),
TagKeys: []tag.Key{reconcilerTagKey, keyTagKey},
},
&view.View{
Description: readyCountStat.Description(),
Measure: readyCountStat,
Aggregation: view.Count(),
TagKeys: []tag.Key{reconcilerTagKey, keyTagKey},
},
)
if err != nil {
panic(err)
}
}
}
// StatsReporter reports reconcilers' metrics.
type StatsReporter interface {
// ReportReady reports the time it took a resource to become Ready.
ReportReady(kind, namespace, service string, d time.Duration) error
}
type reporter struct {
ctx context.Context
}
// NewStatsReporter creates a reporter for reconcilers' metrics
func NewStatsReporter(reconciler string) (StatsReporter, error) {
ctx, err := tag.New(
context.Background(),
tag.Insert(reconcilerTagKey, reconciler))
if err != nil {
return nil, err
}
return &reporter{ctx: ctx}, nil
}
// ReportServiceReady reports the time it took a service to become Ready
func (r *reporter) ReportReady(kind, namespace, service string, d time.Duration) error {
key := fmt.Sprintf("%s/%s", namespace, service)
v := int64(d / time.Millisecond)
ctx, err := tag.New(
r.ctx,
tag.Insert(keyTagKey, key))
if err != nil {
return err
}
m, ok := KindToMeasurements[kind]
if !ok {
return fmt.Errorf("unknown kind attempted to report ready, %q", kind)
}
metrics.Record(ctx, m.ReadyCountStat.M(1))
metrics.Record(ctx, m.ReadyLatencyStat.M(v))
return nil
}
func mustNewTagKey(s string) tag.Key {
tagKey, err := tag.NewKey(s)
if err != nil {
panic(err)
}
return tagKey
}