-
Notifications
You must be signed in to change notification settings - Fork 121
/
telemetry.go
362 lines (294 loc) · 8.13 KB
/
telemetry.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
// Copyright 2021-2024 Zenauth Ltd.
// SPDX-License-Identifier: Apache-2.0
package telemetry
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"sync"
"sync/atomic"
"time"
statev1 "github.com/cerbos/cerbos/api/genpb/cerbos/state/v1"
telemetryv1 "github.com/cerbos/cerbos/api/genpb/cerbos/telemetry/v1"
"github.com/cerbos/cerbos/internal/config"
"github.com/cerbos/cerbos/internal/storage"
"github.com/cerbos/cerbos/internal/util"
"github.com/google/uuid"
analytics "github.com/rudderlabs/analytics-go"
"github.com/spf13/afero"
"go.uber.org/zap"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/durationpb"
"google.golang.org/protobuf/types/known/timestamppb"
)
const (
doNotTrackEnvVar = "DO_NOT_TRACK"
noTelemetryEnvVar = "CERBOS_NO_TELEMETRY"
eventBufferSize = 8
stateFile = "cerbos.telemetry.json"
)
var (
WriteKey string
DataPlaneURL string
reporter Reporter = nopReporter{}
startTime = time.Now()
)
type Reporter interface {
Report(*telemetryv1.Event) bool
Intercept() Interceptors
Stop() error
}
type nopReporter struct{}
func (nopReporter) Report(_ *telemetryv1.Event) bool {
return true
}
func (nopReporter) Intercept() Interceptors {
return nopInterceptors{}
}
func (nopReporter) Stop() error {
return nil
}
func Start(ctx context.Context, store storage.Store) {
logger := zap.L().Named("telemetry")
conf := &Conf{}
_ = config.GetSection(conf)
if !isEnabled(conf) || WriteKey == "" || DataPlaneURL == "" {
logger.Info("Telemetry disabled")
return
}
if r := startReporter(ctx, conf, store, logger); r != nil {
reporter = r
}
}
func isEnabled(conf *Conf) bool {
if conf.Disabled {
return false
}
for _, v := range []string{noTelemetryEnvVar, doNotTrackEnvVar} {
if disabledByEnvVar(v) {
return false
}
}
return true
}
func disabledByEnvVar(name string) bool {
v, ok := os.LookupEnv(name)
// if the var is not defined, assume consent.
if !ok {
return false
}
set, err := strconv.ParseBool(v)
if err != nil {
// err on the side of caution and assume no consent.
return true
}
return set
}
func startReporter(_ context.Context, conf *Conf, store storage.Store, logger *zap.Logger) *analyticsReporter {
logger.Info(fmt.Sprintf("Anonymous telemetry enabled. Disable via the config file or by setting the %s=1 environment variable", noTelemetryEnvVar))
fs := initStateFS(conf.StateDir)
r, err := newAnalyticsReporter(conf, store, fs, logger)
if err != nil {
logger.Debug("Failed to create telemetry reporter", zap.Error(err))
return nil
}
go r.start()
return r
}
func initStateFS(dir string) afero.Fs {
if dir == "" {
confDir, err := os.UserConfigDir()
if err != nil {
confDir = os.TempDir()
}
dir = filepath.Join(confDir, util.AppName)
}
finfo, err := os.Stat(dir)
if err != nil {
if !errors.Is(err, os.ErrNotExist) {
return afero.NewMemMapFs()
}
//nolint:mnd
if err := os.MkdirAll(dir, 0o700); err != nil {
return afero.NewMemMapFs()
}
}
if finfo != nil && !finfo.IsDir() {
return afero.NewMemMapFs()
}
return afero.NewBasePathFs(afero.NewOsFs(), dir)
}
func Stop() {
_ = reporter.Stop()
}
func Report(event *telemetryv1.Event) bool {
return reporter.Report(event)
}
func Intercept() Interceptors {
return reporter.Intercept()
}
type analyticsReporter struct {
state *statev1.TelemetryState
fsys afero.Fs
store storage.Store
eventChan chan *telemetryv1.Event
client analytics.Client
logger *zap.Logger
shutdownChan chan struct{}
reportInterval time.Duration
closeOnce sync.Once
}
func newAnalyticsReporter(conf *Conf, store storage.Store, fsys afero.Fs, logger *zap.Logger) (*analyticsReporter, error) {
client, err := analytics.NewWithConfig(WriteKey, DataPlaneURL, analytics.Config{
Logger: zapLogWrapper{logger: logger.Sugar()},
})
if err != nil {
return nil, fmt.Errorf("failed to instantiate Analytics client: %w", err)
}
return newAnalyticsReporterWithClient(client, conf, store, fsys, logger), nil
}
func newAnalyticsReporterWithClient(client analytics.Client, conf *Conf, store storage.Store, fsys afero.Fs, logger *zap.Logger) *analyticsReporter {
return &analyticsReporter{
state: readState(fsys),
fsys: fsys,
store: store,
logger: logger,
client: client,
reportInterval: conf.ReportInterval,
eventChan: make(chan *telemetryv1.Event, eventBufferSize),
shutdownChan: make(chan struct{}),
}
}
func readState(fsys afero.Fs) *statev1.TelemetryState {
stateBytes, err := afero.ReadFile(fsys, stateFile)
if err != nil {
return newState()
}
var state statev1.TelemetryState
if err := protojson.Unmarshal(stateBytes, &state); err != nil {
return newState()
}
return &state
}
func newState() *statev1.TelemetryState {
var uuidStr string
if id, err := uuid.NewRandom(); err != nil {
uuidStr = "unknown"
} else {
uuidStr = id.String()
}
return &statev1.TelemetryState{
Uuid: uuidStr,
}
}
func (r *analyticsReporter) start() {
defer func() {
// don't let a panic in this goroutine crash the whole app.
if err := recover(); err != nil {
r.logger.Debug("Telemetry panic", zap.Any("cause", err))
}
}()
r.reportServerLaunch()
for event := range r.eventChan {
switch t := event.Data.(type) {
case *telemetryv1.Event_ApiActivity_:
r.reportAPIActivity(t.ApiActivity)
default:
r.logger.Debug(fmt.Sprintf("Unhandled telemetry event type %T", t))
}
}
}
func (r *analyticsReporter) Intercept() Interceptors {
return newStatsInterceptors(r, r.reportInterval, r.shutdownChan)
}
func (r *analyticsReporter) reportServerLaunch() {
event := buildServerLaunch(r.store)
if err := r.send("server_launch", event); err != nil {
r.logger.Debug("Failed to send server launch event", zap.Error(err))
}
}
func (r *analyticsReporter) Report(event *telemetryv1.Event) bool {
select {
case r.eventChan <- event:
return true
default:
return false
}
}
func (r *analyticsReporter) reportAPIActivity(event *telemetryv1.Event_ApiActivity) {
if err := r.send("api_activity", event); err != nil {
r.logger.Debug("Failed to send API activity event", zap.Error(err))
}
}
func (r *analyticsReporter) Stop() error {
var err error
r.closeOnce.Do(func() {
close(r.shutdownChan)
close(r.eventChan)
r.reportServerStop()
err = r.client.Close()
_ = r.writeState()
})
return err
}
func (r *analyticsReporter) reportServerStop() {
event := &telemetryv1.ServerStop{
Version: "1.0.0",
Uptime: durationpb.New(time.Since(startTime)),
RequestsTotal: atomic.LoadUint64(&totalReqCount),
}
if err := r.send("server_stop", event); err != nil {
r.logger.Debug("Failed to send server stop event", zap.Error(err))
}
}
func (r *analyticsReporter) writeState() error {
stateBytes, err := protojson.Marshal(r.state)
if err != nil {
return fmt.Errorf("failed to marshal proto: %w", err)
}
//nolint:mnd
if err := afero.WriteFile(r.fsys, stateFile, stateBytes, 0o600); err != nil {
return fmt.Errorf("failed to write state: %w", err)
}
return nil
}
func (r *analyticsReporter) send(kind string, event proto.Message) error {
props, err := mkProps(event)
if err != nil {
return fmt.Errorf("failed to create properties: %w", err)
}
if err := r.client.Enqueue(analytics.Track{
AnonymousId: r.state.Uuid,
Event: kind,
Properties: props,
}); err != nil {
return fmt.Errorf("failed to enqueue event: %w", err)
}
r.state.LastTimestamp = timestamppb.Now()
return nil
}
func mkProps(event proto.Message) (analytics.Properties, error) {
evtBytes, err := protojson.Marshal(event)
if err != nil {
return nil, fmt.Errorf("failed to marshal event: %w", err)
}
var props map[string]any
if err := json.Unmarshal(evtBytes, &props); err != nil {
return nil, fmt.Errorf("failed to unmarshal evt: %w", err)
}
return analytics.Properties(props), nil
}
type zapLogWrapper struct {
logger *zap.SugaredLogger
}
func (zlw zapLogWrapper) Logf(fmt string, args ...any) {
zlw.logger.Debugf(fmt, args...)
}
func (zlw zapLogWrapper) Errorf(fmt string, args ...any) {
zlw.logger.Warnf(fmt, args...)
}