-
Notifications
You must be signed in to change notification settings - Fork 111
/
client.go
221 lines (178 loc) · 4.71 KB
/
client.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
package activity
import (
"context"
"encoding/json"
"errors"
"sync"
"time"
"go.opentelemetry.io/otel/attribute"
"go.uber.org/zap"
)
type Client interface {
With(dims ...attribute.KeyValue) Client
Emit(ctx context.Context, name string, value float64, dims ...attribute.KeyValue)
Close() error
}
// wrappedClient is designed to wrap a client and enrich every emitted event with common dimensions
type wrappedClient struct {
client Client
commonDims []attribute.KeyValue
}
func newWrappedClient(client Client, commonDims ...attribute.KeyValue) Client {
return &wrappedClient{
client: client,
commonDims: commonDims,
}
}
func (w *wrappedClient) With(dims ...attribute.KeyValue) Client {
dims = append(dims, w.commonDims...)
return &wrappedClient{
client: w.client,
commonDims: dims,
}
}
func (w *wrappedClient) Emit(ctx context.Context, name string, value float64, dims ...attribute.KeyValue) {
dims = append(dims, w.commonDims...)
w.client.Emit(ctx, name, value, dims...)
}
func (w *wrappedClient) Close() error {
return w.client.Close()
}
// bufferedClient collects and periodically sinks Event-s.
type bufferedClient struct {
sink Sink
sinkPeriod time.Duration
buffer []Event
bufferSize int
bufferMx sync.Mutex
stop chan struct{}
sinkWg sync.WaitGroup
logger *zap.Logger
}
type BufferedClientOptions struct {
Sink Sink
SinkPeriod time.Duration
BufferSize int
Logger *zap.Logger
}
func NewBufferedClient(opts BufferedClientOptions) Client {
client := &bufferedClient{
sink: opts.Sink,
sinkPeriod: opts.SinkPeriod,
buffer: make([]Event, 0, opts.BufferSize),
bufferSize: opts.BufferSize,
stop: make(chan struct{}),
}
go client.init()
return client
}
func (c *bufferedClient) With(dims ...attribute.KeyValue) Client {
return newWrappedClient(c, dims...)
}
func (c *bufferedClient) Emit(ctx context.Context, name string, value float64, dims ...attribute.KeyValue) {
dimsFromCtx := GetDimsFromContext(ctx)
if dimsFromCtx == nil {
dimsFromCtx = &[]attribute.KeyValue{}
}
if dims == nil {
dims = []attribute.KeyValue{}
}
dims = append(*dimsFromCtx, dims...)
event := Event{Time: time.Now(), Name: name, Value: value, Dims: dims}
c.bufferMx.Lock()
defer c.bufferMx.Unlock()
c.buffer = append(c.buffer, event)
if len(c.buffer) >= c.bufferSize {
events := c.buffer
c.buffer = make([]Event, 0, c.bufferSize)
go func() {
err := c.flush(events)
if err != nil {
c.logger.Error("could not flush activity events", zap.Error(err))
}
}()
}
}
func (c *bufferedClient) Close() error {
close(c.stop)
var events []Event
// flush call may take some time to process, so it's better to unlock the mutex early
func() {
c.bufferMx.Lock()
defer c.bufferMx.Unlock()
events = c.buffer
c.buffer = make([]Event, 0, c.bufferSize)
}()
errFlush := c.flush(events) // Do not return the error immediately so concurrent flush calls can complete
// Wait for all Sink calls to complete
c.sinkWg.Wait()
errSink := c.sink.Close()
return errors.Join(errFlush, errSink)
}
func (c *bufferedClient) init() {
ticker := time.NewTicker(c.sinkPeriod)
for {
select {
case <-ticker.C:
var events []Event
// flush call may take some time to process, so it's better to unlock the mutex early
func() {
c.bufferMx.Lock()
defer c.bufferMx.Unlock()
events = c.buffer
c.buffer = make([]Event, 0, c.bufferSize)
}()
err := c.flush(events)
if err != nil {
c.logger.Error("could not flush activity events", zap.Error(err))
}
case <-c.stop:
ticker.Stop()
return
}
}
}
func (c *bufferedClient) flush(events []Event) error {
c.sinkWg.Add(1)
defer c.sinkWg.Done()
// If there are events, use a sink to process them
if len(events) > 0 {
err := c.sink.Sink(context.Background(), events)
if err != nil {
return err
}
}
return nil
}
type noopClient struct{}
func NewNoopClient() Client {
return &noopClient{}
}
func (n *noopClient) With(_ ...attribute.KeyValue) Client {
return n
}
func (n *noopClient) Emit(_ context.Context, _ string, _ float64, _ ...attribute.KeyValue) {
}
func (n *noopClient) Close() error {
return nil
}
type Event struct {
Time time.Time
Name string
Value float64
Dims []attribute.KeyValue
}
func (e *Event) Marshal() ([]byte, error) {
// Create a map to hold the flattened event structure.
flattened := make(map[string]interface{})
// Iterate over the dims slice and add each dim to the map.
for _, dim := range e.Dims {
key := string(dim.Key)
flattened[key] = dim.Value.AsInterface()
}
// Add the non-dim fields.
flattened["time"] = e.Time.UTC().Format(time.RFC3339)
flattened["name"] = e.Name
flattened["value"] = e.Value
return json.Marshal(flattened)
}