/
stats_reporter.go
272 lines (242 loc) · 8.42 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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*
Copyright 2018 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 autoscaler
import (
"context"
"errors"
pkgmetrics "knative.dev/pkg/metrics"
"knative.dev/pkg/metrics/metricskey"
"knative.dev/serving/pkg/metrics"
"go.opencensus.io/stats"
"go.opencensus.io/stats/view"
"go.opencensus.io/tag"
)
var (
desiredPodCountM = stats.Int64(
"desired_pods",
"Number of pods autoscaler wants to allocate",
stats.UnitDimensionless)
requestedPodCountM = stats.Int64(
"requested_pods",
"Number of pods autoscaler requested from Kubernetes",
stats.UnitDimensionless)
actualPodCountM = stats.Int64(
"actual_pods",
"Number of pods that are allocated currently",
stats.UnitDimensionless)
excessBurstCapacityM = stats.Float64(
"excess_burst_capacity",
"Excess burst capacity overserved over the stable window",
stats.UnitDimensionless)
stableRequestConcurrencyM = stats.Float64(
"stable_request_concurrency",
"Average of requests count per observed pod over the stable window",
stats.UnitDimensionless)
panicRequestConcurrencyM = stats.Float64(
"panic_request_concurrency",
"Average of requests count per observed pod over the panic window",
stats.UnitDimensionless)
targetRequestConcurrencyM = stats.Float64(
"target_concurrency_per_pod",
"The desired number of concurrent requests for each pod",
stats.UnitDimensionless)
stableRPSM = stats.Float64(
"stable_requests_per_second",
"Average requests-per-second per observed pod over the stable window",
stats.UnitDimensionless)
panicRPSM = stats.Float64(
"panic_requests_per_second",
"Average requests-per-second per observed pod over the panic window",
stats.UnitDimensionless)
targetRPSM = stats.Float64(
"target_requests_per_second",
"The desired requests-per-second for each pod",
stats.UnitDimensionless)
panicM = stats.Int64(
"panic_mode",
"1 if autoscaler is in panic mode, 0 otherwise",
stats.UnitDimensionless)
)
func init() {
register()
}
func register() {
// 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.
if err := view.Register(
&view.View{
Description: "Number of pods autoscaler wants to allocate",
Measure: desiredPodCountM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Number of pods autoscaler requested from Kubernetes",
Measure: requestedPodCountM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Number of pods that are allocated currently",
Measure: actualPodCountM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Average of requests count over the stable window",
Measure: stableRequestConcurrencyM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Current excess burst capacity over average request count over the stable window",
Measure: excessBurstCapacityM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Average of requests count over the panic window",
Measure: panicRequestConcurrencyM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "The desired number of concurrent requests for each pod",
Measure: targetRequestConcurrencyM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "1 if autoscaler is in panic mode, 0 otherwise",
Measure: panicM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Average requests-per-second over the stable window",
Measure: stableRPSM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "Average requests-per-second over the panic window",
Measure: panicRPSM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
&view.View{
Description: "The desired requests-per-second for each pod",
Measure: targetRPSM,
Aggregation: view.LastValue(),
TagKeys: metrics.CommonRevisionKeys,
},
); err != nil {
panic(err)
}
}
// StatsReporter defines the interface for sending autoscaler metrics
type StatsReporter interface {
ReportDesiredPodCount(v int64) error
ReportRequestedPodCount(v int64) error
ReportActualPodCount(v int64) error
ReportStableRequestConcurrency(v float64) error
ReportPanicRequestConcurrency(v float64) error
ReportTargetRequestConcurrency(v float64) error
ReportStableRPS(v float64) error
ReportPanicRPS(v float64) error
ReportTargetRPS(v float64) error
ReportExcessBurstCapacity(v float64) error
ReportPanic(v int64) error
}
// Reporter holds cached metric objects to report autoscaler metrics
type Reporter struct {
ctx context.Context
initialized bool
}
func valueOrUnknown(v string) string {
if v != "" {
return v
}
return metricskey.ValueUnknown
}
// NewStatsReporter creates a reporter that collects and reports autoscaler metrics
func NewStatsReporter(ns, service, config, revision string) (*Reporter, error) {
r := &Reporter{}
// Our tags are static. So, we can get away with creating a single context
// and reuse it for reporting all of our metrics. Note that service names
// can be an empty string, so it needs a special treatment.
ctx, err := tag.New(
context.Background(),
tag.Insert(metrics.NamespaceTagKey, ns),
tag.Insert(metrics.ServiceTagKey, valueOrUnknown(service)),
tag.Insert(metrics.ConfigTagKey, config),
tag.Insert(metrics.RevisionTagKey, revision))
if err != nil {
return nil, err
}
r.ctx = ctx
r.initialized = true
return r, nil
}
// ReportDesiredPodCount captures value v for desired pod count measure.
func (r *Reporter) ReportDesiredPodCount(v int64) error {
return r.report(desiredPodCountM.M(v))
}
// ReportRequestedPodCount captures value v for requested pod count measure.
func (r *Reporter) ReportRequestedPodCount(v int64) error {
return r.report(requestedPodCountM.M(v))
}
// ReportActualPodCount captures value v for actual pod count measure.
func (r *Reporter) ReportActualPodCount(v int64) error {
return r.report(actualPodCountM.M(v))
}
// ReportExcessBurstCapacity captures value v for excess target burst capacity.
func (r *Reporter) ReportExcessBurstCapacity(v float64) error {
return r.report(excessBurstCapacityM.M(v))
}
// ReportStableRequestConcurrency captures value v for stable request concurrency measure.
func (r *Reporter) ReportStableRequestConcurrency(v float64) error {
return r.report(stableRequestConcurrencyM.M(v))
}
// ReportPanicRequestConcurrency captures value v for panic request concurrency measure.
func (r *Reporter) ReportPanicRequestConcurrency(v float64) error {
return r.report(panicRequestConcurrencyM.M(v))
}
// ReportTargetRequestConcurrency captures value v for target request concurrency measure.
func (r *Reporter) ReportTargetRequestConcurrency(v float64) error {
return r.report(targetRequestConcurrencyM.M(v))
}
// ReportStableRPS captures value v for stable RPS measure.
func (r *Reporter) ReportStableRPS(v float64) error {
return r.report(stableRPSM.M(v))
}
// ReportPanicRPS captures value v for panic RPS measure.
func (r *Reporter) ReportPanicRPS(v float64) error {
return r.report(panicRPSM.M(v))
}
// ReportTargetRPS captures value v for target requests-per-second measure.
func (r *Reporter) ReportTargetRPS(v float64) error {
return r.report(targetRPSM.M(v))
}
// ReportPanic captures value v for panic mode measure.
func (r *Reporter) ReportPanic(v int64) error {
return r.report(panicM.M(v))
}
func (r *Reporter) report(m stats.Measurement) error {
if !r.initialized {
return errors.New("StatsReporter is not initialized yet")
}
pkgmetrics.Record(r.ctx, m)
return nil
}