-
Notifications
You must be signed in to change notification settings - Fork 577
/
stats_reporter.go
161 lines (141 loc) · 4.74 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
/*
Copyright 2021 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 source
import (
"context"
"go.opencensus.io/stats/view"
eventingmetrics "knative.dev/eventing/pkg/metrics"
"knative.dev/pkg/metrics"
"go.opencensus.io/stats"
"go.opencensus.io/tag"
)
var (
// eventCountM is a counter which records the number of events sent by the source.
eventCountM = stats.Int64(
"event_count",
"Number of events sent",
stats.UnitDimensionless,
)
// retryEventCountM is a counter which records the number of events sent by the source in retries.
retryEventCountM = stats.Int64(
"retry_event_count",
"Number of retry events sent",
stats.UnitDimensionless,
)
// 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
namespaceKey = tag.MustNewKey(eventingmetrics.LabelNamespaceName)
eventSourceKey = tag.MustNewKey(eventingmetrics.LabelEventSource)
eventTypeKey = tag.MustNewKey(eventingmetrics.LabelEventType)
sourceNameKey = tag.MustNewKey(eventingmetrics.LabelName)
sourceResourceGroupKey = tag.MustNewKey(eventingmetrics.LabelResourceGroup)
responseCodeKey = tag.MustNewKey(eventingmetrics.LabelResponseCode)
responseCodeClassKey = tag.MustNewKey(eventingmetrics.LabelResponseCodeClass)
responseError = tag.MustNewKey(eventingmetrics.LabelResponseError)
responseTimeout = tag.MustNewKey(eventingmetrics.LabelResponseTimeout)
)
// ReportArgs defines the arguments for reporting metrics.
type ReportArgs struct {
Namespace string
EventType string
EventSource string
Name string
ResourceGroup string
Error string
Timeout bool
}
func init() {
register()
}
// StatsReporter defines the interface for sending source metrics.
type StatsReporter interface {
// ReportEventCount captures the event count. It records one per call.
ReportEventCount(args *ReportArgs, responseCode int) error
ReportRetryEventCount(args *ReportArgs, responseCode int) error
}
var _ StatsReporter = (*reporter)(nil)
// reporter holds cached metric objects to report source metrics.
type reporter struct {
ctx context.Context
}
// NewStatsReporter creates a reporter that collects and reports source metrics.
func NewStatsReporter() (StatsReporter, error) {
ctx, err := tag.New(
context.Background(),
)
if err != nil {
return nil, err
}
return &reporter{ctx: ctx}, nil
}
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
}
func (r *reporter) ReportRetryEventCount(args *ReportArgs, responseCode int) error {
ctx, err := r.generateTag(args, responseCode)
if err != nil {
return err
}
metrics.Record(ctx, retryEventCountM.M(1))
return nil
}
func (r *reporter) generateTag(args *ReportArgs, responseCode int) (context.Context, error) {
return tag.New(
r.ctx,
tag.Insert(namespaceKey, args.Namespace),
tag.Insert(eventSourceKey, args.EventSource),
tag.Insert(eventTypeKey, args.EventType),
tag.Insert(sourceNameKey, args.Name),
tag.Insert(sourceResourceGroupKey, args.ResourceGroup),
metrics.MaybeInsertIntTag(responseCodeKey, responseCode, responseCode > 0),
metrics.MaybeInsertStringTag(responseCodeClassKey, metrics.ResponseCodeClass(responseCode), responseCode > 0),
tag.Insert(responseError, args.Error),
metrics.MaybeInsertBoolTag(responseTimeout, args.Timeout, args.Error != ""))
}
func register() {
tagKeys := []tag.Key{
namespaceKey,
eventSourceKey,
eventTypeKey,
sourceNameKey,
sourceResourceGroupKey,
responseCodeKey,
responseCodeClassKey,
responseError,
responseTimeout}
// Create view to see our measurements.
if err := view.Register(
&view.View{
Description: eventCountM.Description(),
Measure: eventCountM,
Aggregation: view.Count(),
TagKeys: tagKeys,
},
&view.View{
Description: retryEventCountM.Description(),
Measure: retryEventCountM,
Aggregation: view.Count(),
TagKeys: tagKeys,
},
); err != nil {
panic(err)
}
}