-
Notifications
You must be signed in to change notification settings - Fork 26
/
telemetry.go
95 lines (78 loc) · 2.57 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
package telemetry
import (
"os"
"strconv"
"sync"
"github.com/appbaseio/reactivesearch-api/middleware"
"github.com/appbaseio/reactivesearch-api/plugins"
badger "github.com/outcaste-io/badger/v3"
"github.com/robfig/cron"
log "github.com/sirupsen/logrus"
)
const (
logTag = "[telemetry]"
eventType = "telemetry" // New relic event name
frontEndHeader = "X-Search-Client"
telemetryHeader = "X-Enable-Telemetry"
defaultServerMode = "OSS"
syncInterval = 10 // interval in minutes to sync telemetry records
deltaInterval = 100 // in ms
totalEventsPerRequest = 2000
defaultTelemetryFilePath = "log/arc/telemetry"
envTelemetryFilePath = "TELEMETRY_FILE_PATH" // Just for local testing
)
var blacklistRoutes = []string{"/"}
var (
singleton *Telemetry
once sync.Once
)
// Telemetry plugin records the API usage.
type Telemetry struct {
filePath string
db *badger.DB
}
// Instance returns the singleton instance of Telemetry plugin.
// Note: Only this function must be used (both within and outside the package) to
// obtain the instance Logs in order to avoid stateless instances of the plugin.
func Instance() *Telemetry {
once.Do(func() { singleton = &Telemetry{} })
return singleton
}
// Name returns the name of the plugin: "[telemetry]"
func (t *Telemetry) Name() string {
return logTag
}
// InitFunc is a part of Plugin interface that gets executed only once, and initializes
// the dao, i.e. elasticsearch before the plugin is operational.
func (t *Telemetry) InitFunc() error {
filePath := os.Getenv(envTelemetryFilePath)
if filePath == "" {
log.Warnln(logTag, envTelemetryFilePath+" is not defined telemetry will get stored at ", defaultTelemetryFilePath)
filePath = defaultTelemetryFilePath
}
t.filePath = filePath
db, err := badger.Open(setBadgerOptions(filePath))
if err != nil {
log.Fatal(err)
}
t.db = db
// Sync at the starting of arc
t.syncTelemetryRecords()
interval := "@every " + strconv.Itoa(syncInterval) + "m"
cronjob := cron.New()
cronjob.AddFunc(interval, t.syncTelemetryRecords)
cronjob.Start()
return nil
}
// Routes returns an empty slice of routes, since Logs is solely a middleware.
func (t *Telemetry) Routes() []plugins.Route {
return []plugins.Route{}
}
// Default empty middleware array function
func (t *Telemetry) ESMiddleware() []middleware.Middleware {
return make([]middleware.Middleware, 0)
}
// Default empty middleware array function
func (t *Telemetry) RSMiddleware() []middleware.Middleware {
return make([]middleware.Middleware, 0)
}