-
Notifications
You must be signed in to change notification settings - Fork 50
/
mpr_metric_module.go
401 lines (329 loc) · 11.8 KB
/
mpr_metric_module.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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
package stream
import (
"context"
"fmt"
"strings"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/cloudwatch"
"github.com/aws/aws-sdk-go-v2/service/cloudwatch/types"
"github.com/justtrackio/gosoline/pkg/cfg"
"github.com/justtrackio/gosoline/pkg/clock"
gosoCloudwatch "github.com/justtrackio/gosoline/pkg/cloud/aws/cloudwatch"
"github.com/justtrackio/gosoline/pkg/conc"
"github.com/justtrackio/gosoline/pkg/conc/ddb"
"github.com/justtrackio/gosoline/pkg/kernel"
"github.com/justtrackio/gosoline/pkg/log"
"github.com/justtrackio/gosoline/pkg/metric"
"github.com/justtrackio/gosoline/pkg/uuid"
)
const (
metricNameStreamMprMessagesPerRunner = "StreamMprMessagesPerRunner"
)
type MessagesPerRunnerMetricWriterSettings struct {
Ecs MessagesPerRunnerEcsSettings
MaxIncreasePeriod time.Duration
UpdatePeriod time.Duration
CloudwatchNamespace string
MaxIncreasePercent float64
MemberId string
QueueNames []string
TargetValue float64
}
func MessagesPerRunnerMetricWriterFactory(_ context.Context, config cfg.Config, _ log.Logger) (map[string]kernel.ModuleFactory, error) {
if !messagesPerRunnerIsEnabled(config) {
return map[string]kernel.ModuleFactory{}, nil
}
settings := readMessagesPerRunnerMetricSettings(config)
modules := map[string]kernel.ModuleFactory{}
if !settings.Enabled {
return modules, nil
}
moduleName := "stream-metric-messages-per-runner"
modules[moduleName] = NewMessagesPerRunnerMetricWriter(settings)
return modules, nil
}
type MessagesPerRunnerMetricWriter struct {
kernel.EssentialModule
kernel.ServiceStage
logger log.Logger
leaderElection ddb.LeaderElection
cwClient gosoCloudwatch.Client
metricWriter metric.Writer
clock clock.Clock
ticker clock.Ticker
settings *MessagesPerRunnerMetricWriterSettings
}
func NewMessagesPerRunnerMetricWriter(settings *MessagesPerRunnerMetricSettings) kernel.ModuleFactory {
return func(ctx context.Context, config cfg.Config, logger log.Logger) (kernel.Module, error) {
var err error
var queueNames []string
var leaderElection ddb.LeaderElection
var cwClient gosoCloudwatch.Client
logger = logger.WithChannel("stream-metric-messages-per-runner")
if queueNames, err = getQueueNames(config); err != nil {
return nil, fmt.Errorf("can't create stream-metric-messages-per-runner: %w", err)
}
if len(queueNames) == 0 {
return nil, fmt.Errorf("failed to detect any SQS queues to monitor")
}
cwNamespace := getCloudwatchNamespace(config, settings.Cloudwatch.Naming.Pattern)
writerSettings := &MessagesPerRunnerMetricWriterSettings{
CloudwatchNamespace: cwNamespace,
QueueNames: queueNames,
UpdatePeriod: settings.Period,
TargetValue: settings.TargetValue,
MaxIncreasePercent: settings.MaxIncreasePercent,
MaxIncreasePeriod: settings.MaxIncreasePeriod,
Ecs: settings.Ecs,
MemberId: uuid.New().NewV4(),
}
if leaderElection, err = ddb.NewLeaderElection(ctx, config, logger, settings.LeaderElection); err != nil {
return nil, fmt.Errorf("can not create leader election for stream-metric-messages-per-runner writer: %w", err)
}
if cwClient, err = gosoCloudwatch.ProvideClient(ctx, config, logger, "default"); err != nil {
return nil, fmt.Errorf("can not create cloudwatch client: %w", err)
}
metricWriter := metric.NewWriter()
ticker := clock.NewRealTicker(settings.Period)
return NewMessagesPerRunnerMetricWriterWithInterfaces(logger, leaderElection, cwClient, metricWriter, clock.Provider, ticker, writerSettings)
}
}
func getCloudwatchNamespace(config cfg.Config, cwNamespacePattern string) string {
appId := cfg.AppId{}
appId.PadFromConfig(config)
values := map[string]string{
"project": appId.Project,
"env": appId.Environment,
"family": appId.Family,
"group": appId.Group,
"app": appId.Application,
}
for key, val := range values {
templ := fmt.Sprintf("{%s}", key)
cwNamespacePattern = strings.ReplaceAll(cwNamespacePattern, templ, val)
}
return cwNamespacePattern
}
func NewMessagesPerRunnerMetricWriterWithInterfaces(logger log.Logger, leaderElection ddb.LeaderElection, cwClient gosoCloudwatch.Client, metricWriter metric.Writer, clock clock.Clock, ticker clock.Ticker, settings *MessagesPerRunnerMetricWriterSettings) (*MessagesPerRunnerMetricWriter, error) {
writer := &MessagesPerRunnerMetricWriter{
logger: logger,
leaderElection: leaderElection,
cwClient: cwClient,
metricWriter: metricWriter,
clock: clock,
ticker: ticker,
settings: settings,
}
return writer, nil
}
func (u *MessagesPerRunnerMetricWriter) Run(ctx context.Context) error {
if err := u.writeMessagesPerRunnerMetric(ctx); err != nil {
return fmt.Errorf("can not write message per runner metric: %w", err)
}
for {
select {
case <-ctx.Done():
return nil
case <-u.ticker.Chan():
if err := u.writeMessagesPerRunnerMetric(ctx); err != nil {
return fmt.Errorf("can not write message per runner metric: %w", err)
}
}
}
}
func (u *MessagesPerRunnerMetricWriter) writeMessagesPerRunnerMetric(ctx context.Context) error {
var err error
var isLeader bool
var messagesPerRunner float64
if isLeader, err = u.leaderElection.IsLeader(ctx, u.settings.MemberId); err != nil {
if conc.IsLeaderElectionFatalError(err) {
return fmt.Errorf("can not decide on leader: %w", err)
}
u.logger.Warn("will assume leader role as election failed: %s", err)
isLeader = true
}
if !isLeader {
u.logger.Info("not leading: do nothing")
return nil
}
if messagesPerRunner, err = u.calculateMessagesPerRunner(ctx); err != nil {
u.logger.Warn("can not calculate messages per runner: %s", err)
return nil
}
u.metricWriter.WriteOne(&metric.Datum{
Priority: metric.PriorityHigh,
Timestamp: u.clock.Now(),
MetricName: metricNameStreamMprMessagesPerRunner,
Unit: metric.UnitCountAverage,
Value: messagesPerRunner,
})
return nil
}
func (u *MessagesPerRunnerMetricWriter) calculateMessagesPerRunner(ctx context.Context) (float64, error) {
var err error
var runnerCount, messagesSent, messagesVisible, currentMpr, newMpr, maxMpr float64
if messagesSent, err = u.getQueueMetrics(ctx, "NumberOfMessagesSent", types.StatisticSum); err != nil {
return 0, fmt.Errorf("can not get number of messages sent: %w", err)
}
if messagesVisible, err = u.getQueueMetrics(ctx, "ApproximateNumberOfMessagesVisible", types.StatisticMaximum); err != nil {
return 0, fmt.Errorf("can not get number of messages visible: %w", err)
}
if runnerCount, err = u.getEcsMetric(ctx, "DesiredTaskCount", types.StatisticMaximum, u.settings.UpdatePeriod); err != nil {
return 0, fmt.Errorf("can not get runner count: %w", err)
}
if runnerCount == 0 {
return 0, fmt.Errorf("runner count is zero")
}
if currentMpr, err = u.getStreamMprMetric(ctx, metricNameStreamMprMessagesPerRunner, types.StatisticAverage, u.settings.MaxIncreasePeriod); err != nil {
u.logger.Warn("can not get current messages per runner metric: %s, defaulting to 0", err.Error())
currentMpr = 0
}
newMpr = (messagesSent + messagesVisible) / runnerCount
if currentMpr == 0 {
currentMpr = newMpr
}
maxMpr = currentMpr * (u.settings.MaxIncreasePercent / 100)
if currentMpr < u.settings.TargetValue {
maxMpr = u.settings.TargetValue * (u.settings.MaxIncreasePercent / 100)
}
if newMpr > maxMpr {
u.logger.Warn("newMpr of %f is higher than configured maxMpr of %f: falling back to max", newMpr, maxMpr)
newMpr = maxMpr
}
u.logger.WithFields(log.Fields{
"messagesSent": messagesSent,
"messagesVisible": messagesVisible,
"runnerCount": runnerCount,
"messagesPerRunner": newMpr,
}).Info("%f messages per runner", newMpr)
return newMpr, nil
}
func (u *MessagesPerRunnerMetricWriter) getQueueMetrics(ctx context.Context, metric string, stat types.Statistic) (float64, error) {
startTime := u.clock.Now().Add(-1 * u.settings.UpdatePeriod * 5)
endTime := u.clock.Now().Add(-1 * u.settings.UpdatePeriod)
period := int32(u.settings.UpdatePeriod.Seconds())
queries := make([]types.MetricDataQuery, len(u.settings.QueueNames))
for i, queueName := range u.settings.QueueNames {
queries[i] = types.MetricDataQuery{
Id: aws.String(fmt.Sprintf("m%d", i)),
MetricStat: &types.MetricStat{
Metric: &types.Metric{
Namespace: aws.String("AWS/SQS"),
MetricName: aws.String(metric),
Dimensions: []types.Dimension{
{
Name: aws.String("QueueName"),
Value: aws.String(queueName),
},
},
},
Period: aws.Int32(period),
Stat: aws.String(string(stat)),
Unit: types.StandardUnitCount,
},
}
}
input := &cloudwatch.GetMetricDataInput{
StartTime: aws.Time(startTime),
EndTime: aws.Time(endTime),
MetricDataQueries: queries,
}
out, err := u.cwClient.GetMetricData(ctx, input)
if err != nil {
return 0, fmt.Errorf("can not get metric data: %w", err)
}
value := 0.0
for _, result := range out.MetricDataResults {
if len(result.Values) == 0 {
continue
}
value += result.Values[0]
}
return value, nil
}
func (u *MessagesPerRunnerMetricWriter) getStreamMprMetric(ctx context.Context, name string, stat types.Statistic, period time.Duration) (float64, error) {
namespace := u.settings.CloudwatchNamespace
startTime := u.clock.Now().Add(-1 * period)
endTime := u.clock.Now().Add(-1 * u.settings.UpdatePeriod)
periodSeconds := int32(u.settings.UpdatePeriod.Seconds())
input := &cloudwatch.GetMetricDataInput{
StartTime: aws.Time(startTime),
EndTime: aws.Time(endTime),
MetricDataQueries: []types.MetricDataQuery{
{
Id: aws.String("m1"),
MetricStat: &types.MetricStat{
Metric: &types.Metric{
Namespace: aws.String(namespace),
MetricName: aws.String(name),
},
Period: aws.Int32(periodSeconds),
Stat: aws.String(string(stat)),
Unit: types.StandardUnitCount,
},
},
},
MaxDatapoints: aws.Int32(1),
}
out, err := u.cwClient.GetMetricData(ctx, input)
if err != nil {
return 0, fmt.Errorf("can not get metric: %w", err)
}
if len(out.MetricDataResults) == 0 {
return 0, fmt.Errorf("no metric results")
}
if len(out.MetricDataResults[0].Values) == 0 {
return 0, fmt.Errorf("no metric values")
}
value := out.MetricDataResults[0].Values[0]
return value, nil
}
func (u *MessagesPerRunnerMetricWriter) getEcsMetric(ctx context.Context, name string, stat types.Statistic, period time.Duration) (float64, error) {
clusterName := u.settings.Ecs.Cluster
serviceName := u.settings.Ecs.Service
startTime := u.clock.Now().Add(-1 * period * 5)
endTime := u.clock.Now().Add(-1 * period)
periodSeconds := int32(period.Seconds())
input := &cloudwatch.GetMetricDataInput{
StartTime: aws.Time(startTime),
EndTime: aws.Time(endTime),
MetricDataQueries: []types.MetricDataQuery{
{
Id: aws.String("m1"),
MetricStat: &types.MetricStat{
Metric: &types.Metric{
Namespace: aws.String("ECS/ContainerInsights"),
MetricName: aws.String(name),
Dimensions: []types.Dimension{
{
Name: aws.String("ClusterName"),
Value: aws.String(clusterName),
},
{
Name: aws.String("ServiceName"),
Value: aws.String(serviceName),
},
},
},
Period: aws.Int32(periodSeconds),
Stat: aws.String(string(stat)),
Unit: types.StandardUnitCount,
},
},
},
MaxDatapoints: aws.Int32(1),
}
out, err := u.cwClient.GetMetricData(ctx, input)
if err != nil {
return 0, fmt.Errorf("can not get metric: %w", err)
}
if len(out.MetricDataResults) == 0 {
return 0, fmt.Errorf("no metric results")
}
if len(out.MetricDataResults[0].Values) == 0 {
return 0, fmt.Errorf("no metric values")
}
value := out.MetricDataResults[0].Values[0]
return value, nil
}