forked from knative/serving
-
Notifications
You must be signed in to change notification settings - Fork 2
/
multiscaler.go
368 lines (316 loc) · 9.82 KB
/
multiscaler.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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
/*
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"
"fmt"
"sync"
"time"
"github.com/knative/pkg/logging"
"github.com/knative/pkg/logging/logkey"
kpa "github.com/knative/serving/pkg/apis/autoscaling/v1alpha1"
"go.uber.org/zap"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
const (
// Enough buffer to store scale requests generated every 2
// seconds while an http request is taking the full timeout of 5
// second.
scaleBufferSize = 10
// scrapeTickInterval is the interval of time between scraping metrics across
// all pods of a revision.
// TODO(yanweiguo): tuning this value. To be based on pod population?
scrapeTickInterval = time.Second / 3
)
// Decider is a resource which observes the request load of a Revision and
// recommends a number of replicas to run.
// +k8s:deepcopy-gen=true
type Decider struct {
metav1.ObjectMeta
Spec DeciderSpec
Status DeciderStatus
}
// DeciderSpec is the parameters in which the Revision should scaled.
type DeciderSpec struct {
TargetConcurrency float64
}
// DeciderStatus is the current scale recommendation.
type DeciderStatus struct {
DesiredScale int32
}
// UniScaler records statistics for a particular Decider and proposes the scale for the Decider's target based on those statistics.
type UniScaler interface {
// Record records the given statistics.
Record(context.Context, Stat)
// Scale either proposes a number of replicas or skips proposing. The proposal is requested at the given time.
// The returned boolean is true if and only if a proposal was returned.
Scale(context.Context, time.Time) (int32, bool)
// Update reconfigures the UniScaler according to the DeciderSpec.
Update(DeciderSpec) error
}
// UniScalerFactory creates a UniScaler for a given PA using the given dynamic configuration.
type UniScalerFactory func(*Decider, *DynamicConfig) (UniScaler, error)
// StatsScraperFactory creates a StatsScraper for a given PA using the given dynamic configuration.
type StatsScraperFactory func(*Decider) (StatsScraper, error)
// scalerRunner wraps a UniScaler and a channel for implementing shutdown behavior.
type scalerRunner struct {
scaler UniScaler
stopCh chan struct{}
pokeCh chan struct{}
// mux guards access to metric
mux sync.RWMutex
decider Decider
}
func (sr *scalerRunner) getLatestScale() int32 {
sr.mux.RLock()
defer sr.mux.RUnlock()
return sr.decider.Status.DesiredScale
}
func (sr *scalerRunner) updateLatestScale(new int32) bool {
sr.mux.Lock()
defer sr.mux.Unlock()
if sr.decider.Status.DesiredScale != new {
sr.decider.Status.DesiredScale = new
return true
}
return false
}
// NewMetricKey identifies a UniScaler in the multiscaler. Stats send in
// are identified and routed via this key.
func NewMetricKey(namespace string, name string) string {
return fmt.Sprintf("%s/%s", namespace, name)
}
// MultiScaler maintains a collection of Uniscalers.
type MultiScaler struct {
scalers map[string]*scalerRunner
scalersMutex sync.RWMutex
scalersStopCh <-chan struct{}
statsCh chan<- *StatMessage
dynConfig *DynamicConfig
uniScalerFactory UniScalerFactory
statsScraperFactory StatsScraperFactory
logger *zap.SugaredLogger
watcher func(string)
watcherMutex sync.RWMutex
}
// NewMultiScaler constructs a MultiScaler.
func NewMultiScaler(
dynConfig *DynamicConfig,
stopCh <-chan struct{},
statsCh chan<- *StatMessage,
uniScalerFactory UniScalerFactory,
statsScraperFactory StatsScraperFactory,
logger *zap.SugaredLogger) *MultiScaler {
logger.Debugf("Creating MultiScaler with configuration %#v", dynConfig)
return &MultiScaler{
scalers: make(map[string]*scalerRunner),
scalersStopCh: stopCh,
statsCh: statsCh,
dynConfig: dynConfig,
uniScalerFactory: uniScalerFactory,
statsScraperFactory: statsScraperFactory,
logger: logger,
}
}
// Get return the current Decider.
func (m *MultiScaler) Get(ctx context.Context, namespace, name string) (*Decider, error) {
key := NewMetricKey(namespace, name)
m.scalersMutex.RLock()
defer m.scalersMutex.RUnlock()
scaler, exists := m.scalers[key]
if !exists {
// This GroupResource is a lie, but unfortunately this interface requires one.
return nil, errors.NewNotFound(kpa.Resource("Deciders"), key)
}
scaler.mux.RLock()
defer scaler.mux.RUnlock()
return (&scaler.decider).DeepCopy(), nil
}
// Create instantiates the desired Decider.
func (m *MultiScaler) Create(ctx context.Context, metric *Decider) (*Decider, error) {
m.scalersMutex.Lock()
defer m.scalersMutex.Unlock()
key := NewMetricKey(metric.Namespace, metric.Name)
scaler, exists := m.scalers[key]
if !exists {
var err error
scaler, err = m.createScaler(ctx, metric)
if err != nil {
return nil, err
}
m.scalers[key] = scaler
}
scaler.mux.RLock()
defer scaler.mux.RUnlock()
return (&scaler.decider).DeepCopy(), nil
}
// Update applied the desired DeciderSpec to a currently running Decider.
func (m *MultiScaler) Update(ctx context.Context, decider *Decider) (*Decider, error) {
key := NewMetricKey(decider.Namespace, decider.Name)
m.scalersMutex.Lock()
defer m.scalersMutex.Unlock()
if scaler, exists := m.scalers[key]; exists {
scaler.mux.Lock()
defer scaler.mux.Unlock()
scaler.decider = *decider
scaler.scaler.Update(decider.Spec)
return decider, nil
}
// This GroupResource is a lie, but unfortunately this interface requires one.
return nil, errors.NewNotFound(kpa.Resource("Deciders"), key)
}
// Delete stops and removes a Decider.
func (m *MultiScaler) Delete(ctx context.Context, namespace, name string) error {
key := NewMetricKey(namespace, name)
m.scalersMutex.Lock()
defer m.scalersMutex.Unlock()
if scaler, exists := m.scalers[key]; exists {
close(scaler.stopCh)
delete(m.scalers, key)
}
return nil
}
// Watch registers a singleton function to call when DeciderStatus is updated.
func (m *MultiScaler) Watch(fn func(string)) {
m.watcherMutex.Lock()
defer m.watcherMutex.Unlock()
if m.watcher != nil {
m.logger.Fatal("Multiple calls to Watch() not supported")
}
m.watcher = fn
}
// Inform sends an update to the registered watcher function, if it is set.
func (m *MultiScaler) Inform(event string) bool {
m.watcherMutex.RLock()
defer m.watcherMutex.RUnlock()
if m.watcher != nil {
m.watcher(event)
return true
}
return false
}
// setScale directly sets the scale for a given metric key. This does not perform any ticking
// or updating of other scaler components.
func (m *MultiScaler) setScale(metricKey string, scale int32) bool {
scaler, exists := m.scalers[metricKey]
if !exists {
return false
}
scaler.updateLatestScale(scale)
return true
}
func (m *MultiScaler) createScaler(ctx context.Context, decider *Decider) (*scalerRunner, error) {
scaler, err := m.uniScalerFactory(decider, m.dynConfig)
if err != nil {
return nil, err
}
stopCh := make(chan struct{})
runner := &scalerRunner{
scaler: scaler,
stopCh: stopCh,
decider: *decider,
pokeCh: make(chan struct{}),
}
runner.decider.Status.DesiredScale = -1
ticker := time.NewTicker(m.dynConfig.Current().TickInterval)
scaleChan := make(chan int32, scaleBufferSize)
go func() {
for {
select {
case <-m.scalersStopCh:
ticker.Stop()
return
case <-stopCh:
ticker.Stop()
return
case <-ticker.C:
m.tickScaler(ctx, scaler, scaleChan)
case <-runner.pokeCh:
m.tickScaler(ctx, scaler, scaleChan)
}
}
}()
scraper, err := m.statsScraperFactory(decider)
if err != nil {
return nil, fmt.Errorf("failed to create a stats scraper for metric %q: %v", decider.Name, err)
}
scraperTicker := time.NewTicker(scrapeTickInterval)
go func() {
for {
select {
case <-m.scalersStopCh:
scraperTicker.Stop()
return
case <-stopCh:
scraperTicker.Stop()
return
case <-scraperTicker.C:
stat, err := scraper.Scrape()
if err != nil {
m.logger.Errorw("Failed to scrape metrics", zap.Error(err))
}
if stat != nil {
m.statsCh <- stat
}
}
}
}()
metricKey := NewMetricKey(decider.Namespace, decider.Name)
go func() {
for {
select {
case <-m.scalersStopCh:
return
case <-stopCh:
return
case desiredScale := <-scaleChan:
if runner.updateLatestScale(desiredScale) {
m.Inform(metricKey)
}
}
}
}()
return runner, nil
}
func (m *MultiScaler) tickScaler(ctx context.Context, scaler UniScaler, scaleChan chan<- int32) {
logger := logging.FromContext(ctx)
desiredScale, scaled := scaler.Scale(ctx, time.Now())
if scaled {
// Cannot scale negative.
if desiredScale < 0 {
logger.Errorf("Cannot scale: desiredScale %d < 0.", desiredScale)
return
}
// Don't scale to zero if scale to zero is disabled.
if desiredScale == 0 && !m.dynConfig.Current().EnableScaleToZero {
logger.Warn("Cannot scale: Desired scale == 0 && EnableScaleToZero == false.")
return
}
scaleChan <- desiredScale
}
}
// RecordStat records some statistics for the given Decider.
func (m *MultiScaler) RecordStat(key string, stat Stat) {
m.scalersMutex.RLock()
defer m.scalersMutex.RUnlock()
scaler, exists := m.scalers[key]
if exists {
logger := m.logger.With(zap.String(logkey.Key, key))
ctx := logging.WithLogger(context.Background(), logger)
scaler.scaler.Record(ctx, stat)
if scaler.getLatestScale() == 0 && stat.AverageConcurrentRequests != 0 {
scaler.pokeCh <- struct{}{}
}
}
}