/
telemetry_service.go
209 lines (180 loc) · 7.1 KB
/
telemetry_service.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
// Copyright 2023 Aalyria Technologies, Inc., and its affiliates.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package agent
import (
"context"
afpb "aalyria.com/spacetime/api/cdpi/v1alpha"
apipb "aalyria.com/spacetime/api/common"
"aalyria.com/spacetime/cdpi_agent/internal/channels"
"aalyria.com/spacetime/cdpi_agent/internal/loggable"
"aalyria.com/spacetime/cdpi_agent/internal/task"
"aalyria.com/spacetime/cdpi_agent/telemetry"
"github.com/rs/zerolog"
"go.opentelemetry.io/otel/attribute"
oteltrace "go.opentelemetry.io/otel/trace"
"golang.org/x/sync/errgroup"
)
type telemetryService struct {
nc *nodeController
telemetryClient afpb.NetworkTelemetryStreamingClient
tb telemetry.Backend
}
func (nc *nodeController) newTelemetryService(tc afpb.NetworkTelemetryStreamingClient, tb telemetry.Backend) task.Task {
return task.Task((&telemetryService{
nc: nc,
telemetryClient: tc,
tb: tb,
}).run).WithNewSpan("telemetry_service")
}
func (ts *telemetryService) run(ctx context.Context) error {
g, ctx := errgroup.WithContext(ctx)
ti, err := ts.telemetryClient.TelemetryInterface(ctx)
if err != nil {
return err
}
// sendCh contains the messages queued to send over the gRPC stream
sendCh := make(chan *afpb.TelemetryUpdate)
// recvCh contains the messages received over the gRPC stream
recvCh := make(chan *afpb.TelemetryRequest)
// triggerCh contains empty messages that trigger sending a TelemetryUpdate
// via the sendCh.
triggerCh := make(chan struct{})
// Something like this:
//
// ┌──────┐ ┌────────┐┌────────┐ ┌──────┐
// │recvCh│ │mainLoop││statLoop│ │sendCh│
// └──┬───┘ └───┬────┘└───┬────┘ └──┬───┘
// │ │ │ │
// │TelemetryRequest│ │ │
// │───────────────>│ │ │
// │ │ │ │
// │ │struct{} │ │
// │ │────────>│ │
// │ │ │ │
// │ │ │TelemetryUpdate│
// │ │ │──────────────>│
// ┌──┴───┐ ┌───┴────┐┌───┴────┐ ┌──┴───┐
// │recvCh│ │mainLoop││statLoop│ │sendCh│
// └──────┘ └────────┘└────────┘ └──────┘
g.Go(channels.NewSource(sendCh).ForwardTo(ti.Send).
WithStartingStoppingLogs("sendLoop", zerolog.TraceLevel).
WithLogField("task", "send").
WithNewSpan("sendLoop").
WithPanicCatcher().
WithCtx(ctx))
g.Go(channels.NewSink(recvCh).FillFrom(ti.Recv).
WithStartingStoppingLogs("recvLoop", zerolog.TraceLevel).
WithLogField("task", "recv").
WithNewSpan("recvLoop").
WithPanicCatcher().
WithCtx(ctx))
g.Go(ts.statLoop(triggerCh, sendCh).
WithStartingStoppingLogs("statLoop", zerolog.TraceLevel).
WithLogField("task", "stat").
WithNewSpan("statLoop").
WithPanicCatcher().
WithCtx(ctx))
g.Go(ts.mainLoop(triggerCh, recvCh).
WithStartingStoppingLogs("mainLoop", zerolog.TraceLevel).
WithLogField("task", "main").
WithNewSpan("mainLoop").
WithPanicCatcher().
WithCtx(ctx))
triggerCh <- struct{}{}
return g.Wait()
}
// statLoop reads values from `triggerCh`, generates telemetry updates, then
// forwards them to the `sendCh`.
func (ts *telemetryService) statLoop(triggerCh <-chan struct{}, sendCh chan<- *afpb.TelemetryUpdate) task.Task {
mapFn := func(ctx context.Context, _ struct{}) (*afpb.TelemetryUpdate, error) {
zerolog.Ctx(ctx).Trace().Msg("got trigger")
var report *apipb.NetworkStatsReport
if err := task.Task(func(ctx context.Context) (err error) {
report, err = ts.tb(ctx)
return err
}).WithNewSpan("telemetry.Backend")(ctx); err != nil {
return nil, err
}
zerolog.Ctx(ctx).Trace().
Object("report", loggable.Proto(report)).
Msg("generated stats report")
return &afpb.TelemetryUpdate{Type: &afpb.TelemetryUpdate_Statistics{Statistics: report}}, nil
}
return channels.MapBetween(triggerCh, sendCh, mapFn)
}
// mainLoop processes incoming telemetry requests and manages triggering stats
// generation for both periodic and one-off requests.
func (ts *telemetryService) mainLoop(triggerCh chan<- struct{}, recvCh <-chan *afpb.TelemetryRequest) task.Task {
return func(ctx context.Context) error {
log := zerolog.Ctx(ctx)
ticker := newReusableTicker(ts.nc.clock)
span := oteltrace.SpanFromContext(ctx)
for {
select {
case <-ctx.Done():
return context.Cause(ctx)
case <-ticker.Chan():
span.AddEvent("periodic telemetry report upload triggered")
log.Trace().Msg("triggering periodic report generation")
select {
case triggerCh <- struct{}{}:
case <-ctx.Done():
return context.Cause(ctx)
}
case req := <-recvCh:
if req.GetNodeId() != ts.nc.id {
log.Warn().
Str("requestedID", req.GetNodeId()).
Object("req", loggable.Proto(req)).
Msg("ignoring request with mismatched node ID")
span.AddEvent(
"ignoring request with mismatched node ID",
oteltrace.WithAttributes(attribute.String("aalyria.requestedID", req.GetNodeId())))
continue
}
switch req.Type.(type) {
case *afpb.TelemetryRequest_QueryStatistics:
span.AddEvent("received request to trigger one-off report generation")
log.Trace().Msg("triggering one-off report generation")
select {
case triggerCh <- struct{}{}:
case <-ctx.Done():
return context.Cause(ctx)
}
case *afpb.TelemetryRequest_StatisticsPublishRateHz:
newHz := req.GetStatisticsPublishRateHz()
span.AddEvent(
"received request to update periodic publish rate",
oteltrace.WithAttributes(attribute.Float64("aalyria.hz", newHz)))
if newHz > 0 {
dur := hzToDuration(newHz)
log.Trace().
Float64("hz", newHz).
Dur("dur", dur).
Msg("updating publish rate")
ticker.Start(dur)
} else {
log.Trace().Msg("disabling periodic report publishing")
ticker.Stop()
}
default:
log.Warn().
Object("req", loggable.Proto(req)).
Msg("unknown telemetry request type received")
span.AddEvent("unknown telemetry request type received")
}
}
}
}
}