forked from elastic/beats
-
Notifications
You must be signed in to change notification settings - Fork 0
/
redis.go
382 lines (317 loc) · 8.4 KB
/
redis.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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
package redis
import (
"strings"
"time"
"github.com/elastic/libbeat/common"
"github.com/elastic/libbeat/logp"
"github.com/elastic/libbeat/publisher"
"github.com/elastic/packetbeat/config"
"github.com/elastic/packetbeat/procs"
"github.com/elastic/packetbeat/protos"
"github.com/elastic/packetbeat/protos/applayer"
"github.com/elastic/packetbeat/protos/tcp"
)
type stream struct {
applayer.Stream
parser parser
tcptuple *common.TcpTuple
}
type transaction struct {
Type string
tuple common.TcpTuple
Src common.Endpoint
Dst common.Endpoint
ResponseTime int32
Ts int64
JsTs time.Time
ts time.Time
cmdline *common.CmdlineTuple
Method string
Path string
Query string
IsError bool
BytesOut int
BytesIn int
Redis common.MapStr
RequestRaw string
ResponseRaw string
}
type redisConnectionData struct {
Streams [2]*stream
requests messageList
responses messageList
}
type messageList struct {
head, tail *redisMessage
}
// Redis protocol plugin
type Redis struct {
// config
Ports []int
SendRequest bool
SendResponse bool
transactionTimeout time.Duration
results publisher.Client
}
var debug = logp.MakeDebug("redis")
func (redis *Redis) InitDefaults() {
redis.SendRequest = false
redis.SendResponse = false
redis.transactionTimeout = protos.DefaultTransactionExpiration
}
func (redis *Redis) setFromConfig(config config.Redis) error {
redis.Ports = config.Ports
if config.SendRequest != nil {
redis.SendRequest = *config.SendRequest
}
if config.SendResponse != nil {
redis.SendResponse = *config.SendResponse
}
if config.TransactionTimeout != nil && *config.TransactionTimeout > 0 {
redis.transactionTimeout = time.Duration(*config.TransactionTimeout) * time.Second
}
return nil
}
func (redis *Redis) GetPorts() []int {
return redis.Ports
}
func (redis *Redis) Init(test_mode bool, results publisher.Client) error {
redis.InitDefaults()
if !test_mode {
redis.setFromConfig(config.ConfigSingleton.Protocols.Redis)
}
redis.results = results
return nil
}
func (s *stream) PrepareForNewMessage() {
parser := &s.parser
s.Stream.Reset()
parser.reset()
}
func (redis *Redis) ConnectionTimeout() time.Duration {
return redis.transactionTimeout
}
func (redis *Redis) Parse(
pkt *protos.Packet,
tcptuple *common.TcpTuple,
dir uint8,
private protos.ProtocolData,
) protos.ProtocolData {
defer logp.Recover("ParseRedis exception")
conn := ensureRedisConnection(private)
conn = redis.doParse(conn, pkt, tcptuple, dir)
if conn == nil {
return nil
}
return conn
}
func ensureRedisConnection(private protos.ProtocolData) *redisConnectionData {
if private == nil {
return &redisConnectionData{}
}
priv, ok := private.(*redisConnectionData)
if !ok {
logp.Warn("redis connection data type error, create new one")
return &redisConnectionData{}
}
if priv == nil {
logp.Warn("Unexpected: redis connection data not set, create new one")
return &redisConnectionData{}
}
return priv
}
func (redis *Redis) doParse(
conn *redisConnectionData,
pkt *protos.Packet,
tcptuple *common.TcpTuple,
dir uint8,
) *redisConnectionData {
st := conn.Streams[dir]
if st == nil {
st = newStream(pkt.Ts, tcptuple)
conn.Streams[dir] = st
debug("new stream: %p (dir=%v, len=%v)", st, dir, len(pkt.Payload))
}
if err := st.Append(pkt.Payload); err != nil {
debug("%v, dropping TCP stream: ", err)
return nil
}
debug("stream add data: %p (dir=%v, len=%v)", st, dir, len(pkt.Payload))
for st.Buf.Len() > 0 {
if st.parser.message == nil {
st.parser.message = newMessage(pkt.Ts)
}
ok, complete := st.parser.parse(&st.Buf)
if !ok {
// drop this tcp stream. Will retry parsing with the next
// segment in it
conn.Streams[dir] = nil
debug("Ignore Redis message. Drop tcp stream. Try parsing with the next segment")
return conn
}
if !complete {
// wait for more data
break
}
msg := st.parser.message
if msg.IsRequest {
debug("REDIS (%p) request message: %s", conn, msg.Message)
} else {
debug("REDIS (%p) response message: %s", conn, msg.Message)
}
// all ok, go to next level and reset stream for new message
redis.handleRedis(conn, msg, tcptuple, dir)
st.PrepareForNewMessage()
}
return conn
}
func newStream(ts time.Time, tcptuple *common.TcpTuple) *stream {
s := &stream{
tcptuple: tcptuple,
}
s.parser.message = newMessage(ts)
s.Stream.Init(tcp.TCP_MAX_DATA_IN_STREAM)
return s
}
func newMessage(ts time.Time) *redisMessage {
return &redisMessage{Ts: ts}
}
func (redis *Redis) handleRedis(
conn *redisConnectionData,
m *redisMessage,
tcptuple *common.TcpTuple,
dir uint8,
) {
m.TcpTuple = *tcptuple
m.Direction = dir
m.CmdlineTuple = procs.ProcWatcher.FindProcessesTuple(tcptuple.IpPort())
if m.IsRequest {
conn.requests.append(m) // wait for response
} else {
conn.responses.append(m)
redis.correlate(conn)
}
}
func (redis *Redis) correlate(conn *redisConnectionData) {
// drop responses with missing requests
if conn.requests.empty() {
for !conn.responses.empty() {
logp.Warn("Response from unknown transaction. Ignoring")
conn.responses.pop()
}
return
}
// merge requests with responses into transactions
for !conn.responses.empty() && !conn.requests.empty() {
requ := conn.requests.pop()
resp := conn.responses.pop()
trans := newTransaction(requ, resp)
debug("REDIS (%p) transaction completed: %s", conn, trans.Redis)
redis.publishTransaction(trans)
}
}
func newTransaction(requ, resp *redisMessage) *transaction {
trans := &transaction{Type: "redis", tuple: requ.TcpTuple}
// init from request
trans.Redis = common.MapStr{}
trans.Method = requ.Method
trans.Path = requ.Path
trans.Query = requ.Message
trans.RequestRaw = requ.Message
trans.BytesIn = requ.Size
trans.cmdline = requ.CmdlineTuple
trans.ts = requ.Ts
trans.Ts = int64(trans.ts.UnixNano() / 1000) // transactions have microseconds resolution
trans.JsTs = requ.Ts
trans.Src = common.Endpoint{
Ip: requ.TcpTuple.Src_ip.String(),
Port: requ.TcpTuple.Src_port,
Proc: string(requ.CmdlineTuple.Src),
}
trans.Dst = common.Endpoint{
Ip: requ.TcpTuple.Dst_ip.String(),
Port: requ.TcpTuple.Dst_port,
Proc: string(requ.CmdlineTuple.Dst),
}
if requ.Direction == tcp.TcpDirectionReverse {
trans.Src, trans.Dst = trans.Dst, trans.Src
}
// init from response
trans.IsError = resp.IsError
if resp.IsError {
trans.Redis["error"] = resp.Message
} else {
trans.Redis["return_value"] = resp.Message
}
trans.BytesOut = resp.Size
trans.ResponseRaw = resp.Message
trans.ResponseTime = int32(resp.Ts.Sub(trans.ts).Nanoseconds() / 1e6) // resp_time in milliseconds
return trans
}
func (redis *Redis) GapInStream(tcptuple *common.TcpTuple, dir uint8,
nbytes int, private protos.ProtocolData) (priv protos.ProtocolData, drop bool) {
// tsg: being packet loss tolerant is probably not very useful for Redis,
// because most requests/response tend to fit in a single packet.
return private, true
}
func (redis *Redis) ReceivedFin(tcptuple *common.TcpTuple, dir uint8,
private protos.ProtocolData) protos.ProtocolData {
// TODO: check if we have pending data that we can send up the stack
return private
}
func (redis *Redis) publishTransaction(t *transaction) {
if redis.results == nil {
return
}
event := common.MapStr{}
event["type"] = "redis"
if !t.IsError {
event["status"] = common.OK_STATUS
} else {
event["status"] = common.ERROR_STATUS
}
event["responsetime"] = t.ResponseTime
if redis.SendRequest {
event["request"] = t.RequestRaw
}
if redis.SendResponse {
event["response"] = t.ResponseRaw
}
event["redis"] = common.MapStr(t.Redis)
event["method"] = strings.ToUpper(t.Method)
event["resource"] = t.Path
event["query"] = t.Query
event["bytes_in"] = uint64(t.BytesIn)
event["bytes_out"] = uint64(t.BytesOut)
event["@timestamp"] = common.Time(t.ts)
event["src"] = &t.Src
event["dst"] = &t.Dst
redis.results.PublishEvent(event)
}
func (ml *messageList) append(msg *redisMessage) {
if ml.tail == nil {
ml.head = msg
} else {
ml.tail.next = msg
}
msg.next = nil
ml.tail = msg
}
func (ml *messageList) empty() bool {
return ml.head == nil
}
func (ml *messageList) pop() *redisMessage {
if ml.head == nil {
return nil
}
msg := ml.head
ml.head = ml.head.next
if ml.head == nil {
ml.tail = nil
}
debug("new head=%p", ml.head)
return msg
}
func (ml *messageList) last() *redisMessage {
return ml.tail
}