-
Notifications
You must be signed in to change notification settings - Fork 24
/
flux-meter.go
268 lines (237 loc) · 8.88 KB
/
flux-meter.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
package fluxmeter
import (
"context"
"path"
"github.com/prometheus/client_golang/prometheus"
"go.uber.org/fx"
"go.uber.org/multierr"
policylangv1 "github.com/fluxninja/aperture/v2/api/gen/proto/go/aperture/policy/language/v1"
policysyncv1 "github.com/fluxninja/aperture/v2/api/gen/proto/go/aperture/policy/sync/v1"
agentinfo "github.com/fluxninja/aperture/v2/pkg/agent-info"
"github.com/fluxninja/aperture/v2/pkg/config"
etcdclient "github.com/fluxninja/aperture/v2/pkg/etcd/client"
etcdwatcher "github.com/fluxninja/aperture/v2/pkg/etcd/watcher"
"github.com/fluxninja/aperture/v2/pkg/metrics"
"github.com/fluxninja/aperture/v2/pkg/notifiers"
"github.com/fluxninja/aperture/v2/pkg/policies/flowcontrol/iface"
"github.com/fluxninja/aperture/v2/pkg/policies/paths"
"github.com/fluxninja/aperture/v2/pkg/status"
)
const (
// FxNameTag is Flux Meter Watcher's Fx Tag.
FxNameTag = "name:\"flux_meter\""
)
var engineAPI iface.Engine
// fluxMeterModule returns the fx options for flowcontrol side pieces of concurrency control in the main fx app.
func fluxMeterModule() fx.Option {
return fx.Options(
// Tag the watcher so that other modules can find it.
fx.Provide(
fx.Annotate(
provideWatcher,
fx.ResultTags(FxNameTag),
),
),
fx.Invoke(
fx.Annotate(
setupFluxMeterModule,
fx.ParamTags(FxNameTag),
),
),
)
}
// provideWatcher provides pointer to flux meter watcher.
func provideWatcher(
etcdClient *etcdclient.Client,
ai *agentinfo.AgentInfo,
) (notifiers.Watcher, error) {
// Get Agent Group from host info gatherer
agentGroupName := ai.GetAgentGroup()
// Scope the sync to the agent group.
etcdPath := path.Join(paths.FluxMeterConfigPath,
paths.AgentGroupPrefix(agentGroupName))
watcher, err := etcdwatcher.NewWatcher(etcdClient, etcdPath)
if err != nil {
return nil, err
}
return watcher, nil
}
// setupFluxMeterModule sets up the flux meter module in the main fx app.
func setupFluxMeterModule(
watcher notifiers.Watcher,
lifecycle fx.Lifecycle,
e iface.Engine,
sr status.Registry,
pr *prometheus.Registry,
) error {
// save policy config api
engineAPI = e
reg := sr.Child("resource", "flux_meters")
fmf := &fluxMeterFactory{
registry: reg,
}
fxDriver, err := notifiers.NewFxDriver(reg, pr,
config.NewProtobufUnmarshaller,
[]notifiers.FxOptionsFunc{fmf.newFluxMeterOptions},
)
if err != nil {
return err
}
notifiers.WatcherLifecycle(lifecycle, watcher, []notifiers.PrefixNotifier{fxDriver})
return nil
}
// FluxMeter describes single fluxmeter.
type FluxMeter struct {
registry status.Registry
fluxMeterProto *policylangv1.FluxMeter
histMetricVec *prometheus.HistogramVec
invalidFluxMeterTotal *prometheus.CounterVec
fluxMeterName string
attributeKey string
buckets []float64
policyName string
}
type fluxMeterFactory struct {
registry status.Registry
}
// NewFluxMeterOptions creates fluxmeter for usage in flowcontrol and also returns its fx options.
func (fluxMeterFactory *fluxMeterFactory) newFluxMeterOptions(
key notifiers.Key,
unmarshaller config.Unmarshaller,
reg status.Registry,
) (fx.Option, error) {
logger := fluxMeterFactory.registry.GetLogger()
wrapperMessage := &policysyncv1.FluxMeterWrapper{}
err := unmarshaller.Unmarshal(wrapperMessage)
if err != nil || wrapperMessage.FluxMeter == nil {
reg.SetStatus(status.NewStatus(nil, err))
logger.Warn().Err(err).Msg("Failed to unmarshal flux meter config wrapper")
return fx.Options(), err
}
fluxMeterProto := wrapperMessage.FluxMeter
buckets := make([]float64, 0)
switch fluxMeterProto.GetHistogramBuckets().(type) {
case *policylangv1.FluxMeter_LinearBuckets_:
if linearBuckets := fluxMeterProto.GetLinearBuckets(); linearBuckets != nil {
buckets = append(buckets, prometheus.LinearBuckets(
linearBuckets.GetStart(), linearBuckets.GetWidth(), int(linearBuckets.GetCount()))...)
}
case *policylangv1.FluxMeter_ExponentialBuckets_:
if exponentialBuckets := fluxMeterProto.GetExponentialBuckets(); exponentialBuckets != nil {
buckets = append(buckets, prometheus.ExponentialBuckets(
exponentialBuckets.GetStart(), exponentialBuckets.GetFactor(), int(exponentialBuckets.GetCount()))...)
}
case *policylangv1.FluxMeter_ExponentialBucketsRange_:
if exponentialBucketsRange := fluxMeterProto.GetExponentialBucketsRange(); exponentialBucketsRange != nil {
buckets = append(buckets, prometheus.ExponentialBucketsRange(
exponentialBucketsRange.GetMin(), exponentialBucketsRange.GetMax(), int(exponentialBucketsRange.GetCount()))...)
}
default:
if defaultBuckets := fluxMeterProto.GetStaticBuckets(); defaultBuckets != nil {
buckets = append(buckets, defaultBuckets.Buckets...)
}
}
fluxMeter := &FluxMeter{
fluxMeterName: wrapperMessage.FluxMeterName,
attributeKey: fluxMeterProto.AttributeKey,
fluxMeterProto: fluxMeterProto,
buckets: buckets,
registry: reg,
policyName: wrapperMessage.PolicyName,
}
return fx.Options(
fx.Invoke(fluxMeter.setup),
),
nil
}
func (fluxMeter *FluxMeter) setup(lc fx.Lifecycle, prometheusRegistry *prometheus.Registry) {
logger := fluxMeter.registry.GetLogger()
metricLabels := make(map[string]string)
metricLabels[metrics.FluxMeterNameLabel] = fluxMeter.GetFluxMeterName()
metricLabels[metrics.PolicyNameLabel] = fluxMeter.GetPolicyName()
lc.Append(fx.Hook{
OnStart: func(_ context.Context) error {
// Initialize a prometheus histogram metric
fluxMeter.histMetricVec = prometheus.NewHistogramVec(prometheus.HistogramOpts{
Name: metrics.FluxMeterMetricName,
Buckets: fluxMeter.buckets,
ConstLabels: prometheus.Labels{metrics.FluxMeterNameLabel: fluxMeter.GetFluxMeterName(), metrics.PolicyNameLabel: fluxMeter.GetPolicyName()},
}, []string{metrics.DecisionTypeLabel, metrics.StatusCodeLabel, metrics.FlowStatusLabel})
fluxMeter.invalidFluxMeterTotal = prometheus.NewCounterVec(prometheus.CounterOpts{
Name: metrics.InvalidFluxMeterTotalMetricName,
ConstLabels: prometheus.Labels{metrics.FluxMeterNameLabel: fluxMeter.GetFluxMeterName(), metrics.PolicyNameLabel: fluxMeter.GetPolicyName()},
Help: "The number of invalid readings from a Flux Meter",
}, []string{metrics.DecisionTypeLabel, metrics.StatusCodeLabel, metrics.FlowStatusLabel})
// Register metric with Prometheus
fmMetrics := []prometheus.Collector{fluxMeter.histMetricVec, fluxMeter.invalidFluxMeterTotal}
for _, metric := range fmMetrics {
err := prometheusRegistry.Register(metric)
if err != nil {
logger.Error().Err(err).Msgf("Failed to register metric %+v with Prometheus registry", metric)
return err
}
}
// Register metric with PCA
err := engineAPI.RegisterFluxMeter(fluxMeter)
if err != nil {
logger.Error().Err(err).Msgf("Failed to register FluxMeter %s with EngineAPI", fluxMeter.fluxMeterName)
return err
}
return nil
},
OnStop: func(_ context.Context) error {
var errMulti error
// Unregister metric with PCA
err := engineAPI.UnregisterFluxMeter(fluxMeter)
if err != nil {
logger.Error().Err(err).Msgf("Failed to unregister FluxMeter %s with EngineAPI", fluxMeter.fluxMeterName)
errMulti = multierr.Append(errMulti, err)
}
// Unregister metric with Prometheus
fmMetrics := []prometheus.Collector{fluxMeter.histMetricVec, fluxMeter.invalidFluxMeterTotal}
for _, metric := range fmMetrics {
unregistered := prometheusRegistry.Unregister(metric)
if !unregistered {
logger.Error().Err(err).Msgf("Failed to unregister metric %+v with Prometheus registry", metric)
}
}
return errMulti
},
})
}
// GetSelectors returns the selectors.
func (fluxMeter *FluxMeter) GetSelectors() []*policylangv1.Selector {
return fluxMeter.fluxMeterProto.GetSelectors()
}
// GetFluxMeterName returns the metric name.
func (fluxMeter *FluxMeter) GetFluxMeterName() string {
return fluxMeter.fluxMeterName
}
// GetPolicyName returns the policy name.
func (fluxMeter *FluxMeter) GetPolicyName() string {
return fluxMeter.policyName
}
// GetAttributeKey returns the attribute key.
func (fluxMeter *FluxMeter) GetAttributeKey() string {
return fluxMeter.attributeKey
}
// GetFluxMeterID returns the flux meter ID.
func (fluxMeter *FluxMeter) GetFluxMeterID() iface.FluxMeterID {
return iface.FluxMeterID{
FluxMeterName: fluxMeter.GetFluxMeterName(),
}
}
// GetHistogram returns the histogram.
func (fluxMeter *FluxMeter) GetHistogram(labels map[string]string) prometheus.Observer {
logger := fluxMeter.registry.GetLogger()
fluxMeterHistogram, err := fluxMeter.histMetricVec.GetMetricWith(labels)
if err != nil {
logger.Warn().Err(err).Msg("Getting latency histogram")
return nil
}
return fluxMeterHistogram
}
// GetInvalidFluxMeterTotal returns the gauge for invalid flux meters.
func (fluxMeter *FluxMeter) GetInvalidFluxMeterTotal(labels map[string]string) (prometheus.Counter, error) {
return fluxMeter.invalidFluxMeterTotal.GetMetricWith(labels)
}