-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
eventmonitor.go
279 lines (225 loc) · 6.82 KB
/
eventmonitor.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
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016-present Datadog, Inc.
//go:build linux || windows
// Package eventmonitor holds eventmonitor related files
package eventmonitor
import (
"context"
"fmt"
"net"
"slices"
"sync"
"time"
"github.com/DataDog/datadog-go/v5/statsd"
"google.golang.org/grpc"
"github.com/DataDog/datadog-agent/cmd/system-probe/api/module"
"github.com/DataDog/datadog-agent/comp/core/workloadmeta"
"github.com/DataDog/datadog-agent/pkg/eventmonitor/config"
procstatsd "github.com/DataDog/datadog-agent/pkg/process/statsd"
secconfig "github.com/DataDog/datadog-agent/pkg/security/config"
"github.com/DataDog/datadog-agent/pkg/security/probe"
"github.com/DataDog/datadog-agent/pkg/security/secl/model"
"github.com/DataDog/datadog-agent/pkg/security/seclog"
"github.com/DataDog/datadog-agent/pkg/util/log"
"github.com/DataDog/datadog-agent/pkg/util/optional"
)
var (
// allowedEventTypes defines allowed event type for consumers
allowedEventTypes = []model.EventType{model.ForkEventType, model.ExecEventType, model.ExitEventType}
)
// Opts defines options that can be used for the eventmonitor
type Opts struct {
ProbeOpts probe.Opts
StatsdClient statsd.ClientInterface
}
// EventMonitor represents the system-probe module for kernel event monitoring
type EventMonitor struct {
sync.RWMutex
Probe *probe.Probe
Config *config.Config
StatsdClient statsd.ClientInterface
GRPCServer *grpc.Server
// internals
ctx context.Context
cancelFnc context.CancelFunc
sendStatsChan chan chan bool
eventConsumers []EventConsumerInterface
netListener net.Listener
wg sync.WaitGroup
}
var _ module.Module = &EventMonitor{}
// EventConsumerInterface defines an event consumer
type EventConsumerInterface interface {
// ID returns the ID of the event consumer
ID() string
// Start starts the event consumer
Start() error
// Stop stops the event consumer
Stop()
}
// EventConsumerPostProbeStartHandler defines an event consumer that can respond to PostProbeStart events
type EventConsumerPostProbeStartHandler interface {
// PostProbeStart is called after the event stream (the probe) is started
PostProbeStart() error
}
// EventConsumer event consumer
type EventConsumer interface {
probe.EventConsumerInterface
}
// Register the event monitoring module
func (m *EventMonitor) Register(_ *module.Router) error {
if err := m.Init(); err != nil {
return err
}
return m.Start()
}
// AddEventConsumer registers an event handler
func (m *EventMonitor) AddEventConsumer(consumer EventConsumer) error {
for _, eventType := range consumer.EventTypes() {
if !slices.Contains(allowedEventTypes, eventType) {
return fmt.Errorf("event type (%s) not allowed", eventType)
}
}
return m.Probe.AddEventConsumer(consumer)
}
// RegisterEventConsumer registers an event consumer
func (m *EventMonitor) RegisterEventConsumer(consumer EventConsumerInterface) {
m.eventConsumers = append(m.eventConsumers, consumer)
}
// Init initializes the module
func (m *EventMonitor) Init() error {
if err := m.init(); err != nil {
return err
}
// initialize the eBPF manager and load the programs and maps in the kernel. At this stage, the probes are not
// running yet.
if err := m.Probe.Init(); err != nil {
return fmt.Errorf("failed to init probe: %w", err)
}
return nil
}
// Start the module
func (m *EventMonitor) Start() error {
ln, err := m.getListener()
if err != nil {
return fmt.Errorf("unable to register event monitoring module: %w", err)
}
m.netListener = ln
m.wg.Add(1)
go func() {
defer m.wg.Done()
if err := m.GRPCServer.Serve(ln); err != nil {
seclog.Errorf("error launching the grpc server: %v", err)
}
}()
// setup the manager and its probes / perf maps
if err := m.Probe.Setup(); err != nil {
return fmt.Errorf("failed to setup probe: %w", err)
}
// fetch the current state of the system (example: mount points, running processes, ...) so that our user space
// context is ready when we start the probes
if err := m.Probe.Snapshot(); err != nil {
return err
}
// start event consumers
for _, em := range m.eventConsumers {
if err := em.Start(); err != nil {
log.Errorf("unable to start %s event consumer: %v", em.ID(), err)
}
}
if err := m.Probe.Start(); err != nil {
return err
}
for _, em := range m.eventConsumers {
if ppsem, ok := em.(EventConsumerPostProbeStartHandler); ok {
if err := ppsem.PostProbeStart(); err != nil {
log.Errorf("after probe start callback of %s failed: %v", em.ID(), err)
}
}
}
m.wg.Add(1)
go m.statsSender()
return nil
}
// Close the module
func (m *EventMonitor) Close() {
// stop so that consumers won't receive events anymore
m.Probe.Stop()
// stop event consumers
for _, em := range m.eventConsumers {
em.Stop()
}
if m.GRPCServer != nil {
m.GRPCServer.Stop()
}
if m.netListener != nil {
m.netListener.Close()
}
m.cleanup()
m.cancelFnc()
m.wg.Wait()
// all the go routines should be stopped now we can safely call close the probe and remove the eBPF programs
m.Probe.Close()
}
// SendStats send stats
func (m *EventMonitor) SendStats() {
ackChan := make(chan bool, 1)
m.sendStatsChan <- ackChan
<-ackChan
}
func (m *EventMonitor) sendStats() {
if err := m.Probe.SendStats(); err != nil {
seclog.Debugf("failed to send probe stats: %s", err)
}
}
func (m *EventMonitor) statsSender() {
defer m.wg.Done()
statsTicker := time.NewTicker(m.Probe.StatsPollingInterval())
defer statsTicker.Stop()
for {
select {
case ackChan := <-m.sendStatsChan:
m.sendStats()
ackChan <- true
case <-statsTicker.C:
m.sendStats()
case <-m.ctx.Done():
return
}
}
}
// GetStats returns statistics about the module
func (m *EventMonitor) GetStats() map[string]interface{} {
debug := map[string]interface{}{}
if m.Probe != nil {
debug["probe"] = m.Probe.GetDebugStats()
} else {
debug["probe"] = "not_running"
}
return debug
}
// NewEventMonitor instantiates an event monitoring system-probe module
func NewEventMonitor(config *config.Config, secconfig *secconfig.Config, opts Opts, wmeta optional.Option[workloadmeta.Component]) (*EventMonitor, error) {
if opts.StatsdClient == nil {
opts.StatsdClient = procstatsd.Client
}
if opts.ProbeOpts.StatsdClient == nil {
opts.ProbeOpts.StatsdClient = opts.StatsdClient
}
probe, err := probe.NewProbe(secconfig, opts.ProbeOpts, wmeta)
if err != nil {
return nil, err
}
ctx, cancelFnc := context.WithCancel(context.Background())
return &EventMonitor{
Config: config,
Probe: probe,
StatsdClient: opts.StatsdClient,
GRPCServer: grpc.NewServer(),
ctx: ctx,
cancelFnc: cancelFnc,
sendStatsChan: make(chan chan bool, 1),
}, nil
}