/
generator.go
304 lines (242 loc) · 8.41 KB
/
generator.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
/*
* Copyright (C) 2023 Intergral GmbH
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package generator
import (
"context"
"errors"
"fmt"
"os"
"sync"
"github.com/intergral/deep/pkg/util"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/grafana/dskit/kv"
"github.com/grafana/dskit/ring"
"github.com/grafana/dskit/services"
"github.com/opentracing/opentracing-go"
"github.com/prometheus/client_golang/prometheus"
"go.uber.org/atomic"
"github.com/intergral/deep/modules/generator/storage"
"github.com/intergral/deep/pkg/deeppb"
)
const (
// ringAutoForgetUnhealthyPeriods is how many consecutive timeout periods an unhealthy instance
// in the ring will be automatically removed.
ringAutoForgetUnhealthyPeriods = 2
// We use a safe default instead of exposing to config option to the user
// in order to simplify the config.
ringNumTokens = 256
)
var (
ErrUnconfigured = errors.New("no metrics_generator.storage.path configured, metrics generator will be disabled")
ErrReadOnly = errors.New("metrics-generator is shutting down")
)
type Generator struct {
services.Service
deeppb.UnimplementedMetricsGeneratorServer
cfg *Config
overrides metricsGeneratorOverrides
ringLifecycler *ring.BasicLifecycler
instancesMtx sync.RWMutex
instances map[string]*instance
subservices *services.Manager
subservicesWatcher *services.FailureWatcher
// When set to true, the generator will refuse incoming pushes
// and will flush any remaining metrics.
readOnly atomic.Bool
reg prometheus.Registerer
logger log.Logger
}
// New makes a new Generator.
func New(cfg *Config, overrides metricsGeneratorOverrides, reg prometheus.Registerer, logger log.Logger) (*Generator, error) {
if cfg.Storage.Path == "" {
return nil, ErrUnconfigured
}
err := os.MkdirAll(cfg.Storage.Path, os.ModePerm)
if err != nil {
return nil, fmt.Errorf("failed to mkdir on %s: %w", cfg.Storage.Path, err)
}
g := &Generator{
cfg: cfg,
overrides: overrides,
instances: map[string]*instance{},
reg: reg,
logger: logger,
}
// Lifecycler and ring
ringStore, err := kv.NewClient(
cfg.Ring.KVStore,
ring.GetCodec(),
kv.RegistererWithKVName(prometheus.WrapRegistererWithPrefix("deep_", reg), "metrics-generator"),
g.logger,
)
if err != nil {
return nil, fmt.Errorf("create KV store client: %w", err)
}
lifecyclerCfg, err := cfg.Ring.toLifecyclerConfig()
if err != nil {
return nil, fmt.Errorf("invalid ring lifecycler config: %w", err)
}
// Define lifecycler delegates in reverse order (last to be called defined first because they're
// chained via "next delegate").
delegate := ring.BasicLifecyclerDelegate(g)
delegate = ring.NewLeaveOnStoppingDelegate(delegate, g.logger)
delegate = ring.NewAutoForgetDelegate(ringAutoForgetUnhealthyPeriods*cfg.Ring.HeartbeatTimeout, delegate, g.logger)
g.ringLifecycler, err = ring.NewBasicLifecycler(lifecyclerCfg, ringNameForServer, RingKey, ringStore, delegate, g.logger, prometheus.WrapRegistererWithPrefix("deep_", reg))
if err != nil {
return nil, fmt.Errorf("create ring lifecycler: %w", err)
}
g.Service = services.NewBasicService(g.starting, g.running, g.stopping)
return g, nil
}
func (g *Generator) starting(ctx context.Context) (err error) {
// In case this function will return error we want to unregister the instance
// from the ring. We do it ensuring dependencies are gracefully stopped if they
// were already started.
defer func() {
if err == nil || g.subservices == nil {
return
}
if stopErr := services.StopManagerAndAwaitStopped(context.Background(), g.subservices); stopErr != nil {
level.Error(g.logger).Log("msg", "failed to gracefully stop metrics-generator dependencies", "err", stopErr)
}
}()
g.subservices, err = services.NewManager(g.ringLifecycler)
if err != nil {
return fmt.Errorf("unable to start metrics-generator dependencies: %w", err)
}
g.subservicesWatcher = services.NewFailureWatcher()
g.subservicesWatcher.WatchManager(g.subservices)
err = services.StartManagerAndAwaitHealthy(ctx, g.subservices)
if err != nil {
return fmt.Errorf("unable to start mertics-generator dependencies: %w", err)
}
return nil
}
func (g *Generator) running(ctx context.Context) error {
for {
select {
case <-ctx.Done():
return nil
case err := <-g.subservicesWatcher.Chan():
return fmt.Errorf("metrics-generator subservice failed %w", err)
}
}
}
func (g *Generator) stopping(_ error) error {
// Mark as read-only
g.stopIncomingRequests()
if g.subservices != nil {
err := services.StopManagerAndAwaitStopped(context.Background(), g.subservices)
if err != nil {
level.Error(g.logger).Log("msg", "failed to stop metrics-generator dependencies", "err", err)
}
}
var wg sync.WaitGroup
wg.Add(len(g.instances))
for _, inst := range g.instances {
go func(inst *instance) {
inst.shutdown()
wg.Done()
}(inst)
}
wg.Wait()
return nil
}
// stopIncomingRequests marks the generator as read-only, refusing push requests
func (g *Generator) stopIncomingRequests() {
g.readOnly.Store(true)
}
func (g *Generator) PushSnapshot(ctx context.Context, req *deeppb.PushSnapshotRequest) (*deeppb.PushSnapshotResponse, error) {
if g.readOnly.Load() {
return nil, ErrReadOnly
}
span, ctx := opentracing.StartSpanFromContext(ctx, "generator.PushSpans")
defer span.Finish()
tenantID, err := util.ExtractTenantID(ctx)
if err != nil {
return nil, err
}
span.SetTag("tenantID", tenantID)
instance, err := g.getOrCreateInstance(tenantID)
if err != nil {
return nil, err
}
instance.PushSnapshot(ctx, req)
return &deeppb.PushSnapshotResponse{}, nil
}
func (g *Generator) getOrCreateInstance(instanceID string) (*instance, error) {
inst, ok := g.getInstanceByID(instanceID)
if ok {
return inst, nil
}
g.instancesMtx.Lock()
defer g.instancesMtx.Unlock()
inst, ok = g.instances[instanceID]
if ok {
return inst, nil
}
inst, err := g.createInstance(instanceID)
if err != nil {
return nil, err
}
g.instances[instanceID] = inst
return inst, nil
}
func (g *Generator) getInstanceByID(id string) (*instance, bool) {
g.instancesMtx.RLock()
defer g.instancesMtx.RUnlock()
inst, ok := g.instances[id]
return inst, ok
}
func (g *Generator) createInstance(id string) (*instance, error) {
wal, err := storage.New(&g.cfg.Storage, id, g.reg, g.logger)
if err != nil {
return nil, err
}
return newInstance(g.cfg, id, g.overrides, wal, g.reg, g.logger)
}
func (g *Generator) CheckReady(_ context.Context) error {
if !g.ringLifecycler.IsRegistered() {
return fmt.Errorf("metrics-generator check ready failed: not registered in the ring")
}
return nil
}
// OnRingInstanceRegister implements ring.BasicLifecyclerDelegate
func (g *Generator) OnRingInstanceRegister(_ *ring.BasicLifecycler, ringDesc ring.Desc, instanceExists bool, _ string, instanceDesc ring.InstanceDesc) (ring.InstanceState, ring.Tokens) {
// When we initialize the metrics-generator instance in the ring we want to start from
// a clean situation, so whatever is the state we set it ACTIVE, while we keep existing
// tokens (if any) or the ones loaded from file.
var tokens []uint32
if instanceExists {
tokens = instanceDesc.GetTokens()
}
takenTokens := ringDesc.GetTokens()
newTokens := ring.GenerateTokens(ringNumTokens-len(tokens), takenTokens)
// Tokens sorting will be enforced by the parent caller.
tokens = append(tokens, newTokens...)
return ring.ACTIVE, tokens
}
// OnRingInstanceTokens implements ring.BasicLifecyclerDelegate
func (g *Generator) OnRingInstanceTokens(*ring.BasicLifecycler, ring.Tokens) {
}
// OnRingInstanceStopping implements ring.BasicLifecyclerDelegate
func (g *Generator) OnRingInstanceStopping(*ring.BasicLifecycler) {
}
// OnRingInstanceHeartbeat implements ring.BasicLifecyclerDelegate
func (g *Generator) OnRingInstanceHeartbeat(*ring.BasicLifecycler, *ring.Desc, *ring.InstanceDesc) {
}