-
Notifications
You must be signed in to change notification settings - Fork 578
/
stats_reporter.go
159 lines (139 loc) · 4.58 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
/*
Copyright 2020 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 ingress
import (
"context"
"log"
"strconv"
"time"
"go.opencensus.io/resource"
"go.opencensus.io/stats"
"go.opencensus.io/stats/view"
"go.opencensus.io/tag"
broker "knative.dev/eventing/pkg/broker"
eventingmetrics "knative.dev/eventing/pkg/metrics"
"knative.dev/pkg/metrics"
"knative.dev/pkg/metrics/metricskey"
)
var (
// eventCountM is a counter which records the number of events received
// by the Broker.
eventCountM = stats.Int64(
"event_count",
"Number of events received by a Broker",
stats.UnitDimensionless,
)
// dispatchTimeInMsecM records the time spent dispatching an event to
// a Channel, in milliseconds.
dispatchTimeInMsecM = stats.Float64(
"event_dispatch_latencies",
"The time spent dispatching an event to a Channel",
stats.UnitMilliseconds,
)
// 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
eventTypeKey = tag.MustNewKey(eventingmetrics.LabelEventType)
responseCodeKey = tag.MustNewKey(eventingmetrics.LabelResponseCode)
responseCodeClassKey = tag.MustNewKey(eventingmetrics.LabelResponseCodeClass)
)
type ReportArgs struct {
ns string
broker string
eventType string
}
func init() {
register()
}
// StatsReporter defines the interface for sending ingress metrics.
type StatsReporter interface {
ReportEventCount(args *ReportArgs, responseCode int) error
ReportEventDispatchTime(args *ReportArgs, responseCode int, d time.Duration) error
}
var _ StatsReporter = (*reporter)(nil)
var emptyContext = context.Background()
// Reporter holds cached metric objects to report ingress metrics.
type reporter struct {
container string
uniqueName string
}
// NewStatsReporter creates a reporter that collects and reports ingress metrics.
func NewStatsReporter(container, uniqueName string) StatsReporter {
return &reporter{
container: container,
uniqueName: uniqueName,
}
}
func register() {
tagKeys := []tag.Key{
eventTypeKey,
responseCodeKey,
responseCodeClassKey,
broker.ContainerTagKey,
broker.UniqueTagKey}
// Create view to see our measurements.
err := metrics.RegisterResourceView(
&view.View{
Description: eventCountM.Description(),
Measure: eventCountM,
Aggregation: view.Count(),
TagKeys: tagKeys,
},
&view.View{
Description: dispatchTimeInMsecM.Description(),
Measure: dispatchTimeInMsecM,
Aggregation: view.Distribution(metrics.Buckets125(1, 10000)...), // 1, 2, 5, 10, 20, 50, 100, 500, 1000, 5000, 10000
TagKeys: tagKeys,
},
)
if err != nil {
log.Printf("failed to register opencensus views, %s", err)
}
}
// ReportEventCount captures the event count.
func (r *reporter) ReportEventCount(args *ReportArgs, responseCode int) error {
ctx, err := r.generateTag(args, responseCode)
if err != nil {
return err
}
metrics.Record(ctx, eventCountM.M(1))
return nil
}
// ReportEventDispatchTime captures dispatch times.
func (r *reporter) ReportEventDispatchTime(args *ReportArgs, responseCode int, d time.Duration) error {
ctx, err := r.generateTag(args, responseCode)
if err != nil {
return err
}
// convert time.Duration in nanoseconds to milliseconds.
metrics.Record(ctx, dispatchTimeInMsecM.M(float64(d/time.Millisecond)))
return nil
}
func (r *reporter) generateTag(args *ReportArgs, responseCode int) (context.Context, error) {
ctx := metricskey.WithResource(emptyContext, resource.Resource{
Type: eventingmetrics.ResourceTypeKnativeBroker,
Labels: map[string]string{
eventingmetrics.LabelNamespaceName: args.ns,
eventingmetrics.LabelBrokerName: args.broker,
},
})
return tag.New(
ctx,
tag.Insert(broker.ContainerTagKey, r.container),
tag.Insert(broker.UniqueTagKey, r.uniqueName),
tag.Insert(eventTypeKey, args.eventType),
tag.Insert(responseCodeKey, strconv.Itoa(responseCode)),
tag.Insert(responseCodeClassKey, metrics.ResponseCodeClass(responseCode)))
}