-
Notifications
You must be signed in to change notification settings - Fork 362
/
traceflow.go
547 lines (508 loc) · 19 KB
/
traceflow.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
// Copyright 2020 Antrea Authors
//
// 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 graphviz
import (
"fmt"
"strconv"
"strings"
"github.com/awalterschulze/gographviz"
crdv1alpha1 "antrea.io/antrea/pkg/apis/crd/v1alpha1"
)
const (
darkRed = `"#B20000"`
mistyRose = `"#EDD5D5"`
fireBrick = `"#B22222"`
ghostWhite = `"#F8F8FF"`
gainsboro = `"#DCDCDC"`
lightGrey = `"#C8C8C8"`
silver = `"#C0C0C0"`
grey = `"#808080"`
dimGrey = `"#696969"`
)
var (
clusterSrcName = "cluster_source"
clusterDstName = "cluster_destination"
)
// createNodeWithDefaultStyle creates a node with default style (usually used to represent a component in traceflow) .
func createNodeWithDefaultStyle(graph *gographviz.Graph, parentGraph string, name string) (*gographviz.Node, error) {
err := graph.AddNode(parentGraph, name, map[string]string{
"shape": "box",
"style": `"rounded,filled,solid"`,
"color": dimGrey,
})
if err != nil {
return nil, err
}
return graph.Nodes.Lookup[name], nil
}
// createEndpointNodeWithDefaultStyle creates an endpoint node with default style.
// EndpointNode is the the type of node for endpoints in networks like the sender and the receiver.
func createEndpointNodeWithDefaultStyle(graph *gographviz.Graph, parentGraph string, name string) (*gographviz.Node, error) {
err := graph.AddNode(parentGraph, name, map[string]string{
"style": `"filled,bold"`,
"color": grey,
"fillcolor": lightGrey,
})
if err != nil {
return nil, err
}
return graph.Nodes.Lookup[name], nil
}
// createDirectedEdgeWithDefaultStyle creates a directed edge with default style.
// It is allowed to create duplicate edges.
func createDirectedEdgeWithDefaultStyle(graph *gographviz.Graph, start *gographviz.Node, end *gographviz.Node, isForwardDir bool) (*gographviz.Edge, error) {
err := graph.AddEdge(start.Name, end.Name, true, map[string]string{
"penwidth": "2.0",
"color": silver,
})
if err != nil {
return nil, err
}
edges := graph.Edges.SrcToDsts[start.Name][end.Name]
if len(edges) == 0 {
return nil, fmt.Errorf("failed to create a new edge between node %s and node %s", start.Name, end.Name)
}
edge := edges[len(edges)-1]
if isForwardDir {
edge.Attrs[gographviz.Dir] = "forward"
} else {
edge.Attrs[gographviz.Dir] = "back"
}
return edge, nil
}
// createClusterWithDefaultStyle creates a cluster with default style.
// In Graphviz, cluster is a subgraph which is surrounded by a rectangle and the nodes belonging to the cluster are drawn together.
// In traceflow, a cluster is usually used to represent a K8s node.
func createClusterWithDefaultStyle(graph *gographviz.Graph, name string) (*gographviz.SubGraph, error) {
err := graph.AddSubGraph(graph.Name, name, map[string]string{
"style": `"filled,bold"`,
"bgcolor": ghostWhite,
})
if err != nil {
return nil, err
}
return graph.SubGraphs.SubGraphs[name], nil
}
func isSender(result *crdv1alpha1.NodeResult) bool {
if len(result.Observations) == 0 {
return false
}
if result.Observations[0].Component != crdv1alpha1.ComponentSpoofGuard || result.Observations[0].Action != crdv1alpha1.ActionForwarded {
return false
}
return true
}
func isReceiver(result *crdv1alpha1.NodeResult) bool {
if len(result.Observations) == 0 {
return false
}
if result.Observations[0].Component != crdv1alpha1.ComponentForwarding || result.Observations[0].Action != crdv1alpha1.ActionReceived {
return false
}
return true
}
// In DOT language, some symbols are used to parse the Graphviz DOT language, including but not limited to ",", "/", "#", etc.
// All Graphviz attributes are specified by name-value pairs. If the value string contains such symbols, we need to add a pair
// of quotation marks to prevent them from being used for parsing the DOT language.
// More details about DOT language can be seen at: https://graphviz.org/doc/info/lang.html.
func getWrappedStr(str string) string {
// In quoted strings in DOT, the only escaped character is double-quote (").
// That is, in quoted strings, the dyad \" is converted to "; all other characters are left unchanged.
wStr := strings.ReplaceAll(str, `"`, `\"`)
return `"` + wStr + `"`
}
func getNodeResult(tf *crdv1alpha1.Traceflow, fn func(result *crdv1alpha1.NodeResult) bool) *crdv1alpha1.NodeResult {
for i := range tf.Status.Results {
result := tf.Status.Results[i]
if fn(&result) {
return &result
}
}
return nil
}
func getSrcNodeName(tf *crdv1alpha1.Traceflow) string {
if len(tf.Spec.Source.Namespace) > 0 && len(tf.Spec.Source.Pod) > 0 {
return getWrappedStr(tf.Spec.Source.Namespace + "/" + tf.Spec.Source.Pod)
}
if tf.Spec.LiveTraffic {
if len(tf.Spec.Source.IP) > 0 {
return getWrappedStr(tf.Spec.Source.IP)
}
return getWrappedStr(tf.Status.CapturedPacket.SrcIP)
}
return ""
}
func getDstNodeName(tf *crdv1alpha1.Traceflow) string {
if len(tf.Spec.Destination.Namespace) > 0 && len(tf.Spec.Destination.Service) > 0 {
return getWrappedStr(tf.Spec.Destination.Namespace + "/" + tf.Spec.Destination.Pod +
"\nService: " + tf.Spec.Destination.Service)
}
if len(tf.Spec.Destination.IP) > 0 {
return getWrappedStr(tf.Spec.Destination.IP)
}
if len(tf.Spec.Destination.Namespace) > 0 && len(tf.Spec.Destination.Pod) > 0 {
return getWrappedStr(tf.Spec.Destination.Namespace + "/" + tf.Spec.Destination.Pod)
}
if tf.Spec.LiveTraffic {
return getWrappedStr(tf.Status.CapturedPacket.DstIP)
}
return ""
}
// getTraceflowMessage gets the shown message string in traceflow graph.
func getTraceflowMessage(o *crdv1alpha1.Observation, spec *crdv1alpha1.TraceflowSpec) string {
str := string(o.Component)
if len(o.ComponentInfo) > 0 {
str += "\n" + o.ComponentInfo
}
str += "\n" + string(o.Action)
if o.Component == crdv1alpha1.ComponentNetworkPolicy && len(o.NetworkPolicy) > 0 {
str += "\nNetpol: " + o.NetworkPolicy
}
if len(o.Pod) > 0 {
str += "\nTo: " + o.Pod
if len(spec.Destination.Pod) == 0 {
spec.Destination.Pod = o.Pod[strings.Index(o.Pod, `/`)+1:]
}
}
if o.Action != crdv1alpha1.ActionDropped && len(o.TranslatedSrcIP) > 0 {
str += "\nTranslated Source IP: " + o.TranslatedSrcIP
}
if o.Action != crdv1alpha1.ActionDropped && len(o.TranslatedDstIP) > 0 {
str += "\nTranslated Destination IP: " + o.TranslatedDstIP
}
if o.Action != crdv1alpha1.ActionDropped && len(o.TunnelDstIP) > 0 {
str += "\nTunnel Destination IP : " + o.TunnelDstIP
}
return str
}
// In Graphviz, clusters are surrounded by a pair of "{}" with string "subgraph ClusterName" before them.
// The function finds the start and end index of specific cluster.
func findClusterString(graphStr string, clusterName string) (startIndex int, endIndex int) {
startIndex = strings.Index(graphStr, "subgraph "+clusterName)
if startIndex == -1 {
return 0, 1
}
endIndex = startIndex
for graphStr[endIndex] != '{' {
endIndex++
}
// Depth represents the number of "{" minus the number of "}" from the start index of current cluster to endIndex.
// When depth is zero for the first time, it indicates that we successfully find the end index of the cluster.
depth := 1
for depth > 0 {
endIndex++
if graphStr[endIndex] == '{' {
depth++
}
if graphStr[endIndex] == '}' {
depth--
}
}
return startIndex, endIndex + 1
}
func genOutput(graph *gographviz.Graph, isSingleCluster bool) string {
str := graph.String()
if isSingleCluster {
return str
}
// Swap source and destination cluster if destination cluster appears before source cluster.
srcStartIdx, srcEndIdx := findClusterString(str, clusterSrcName)
dstStartIdx, dstEndIdx := findClusterString(str, clusterDstName)
if dstEndIdx <= srcStartIdx {
return str[:dstStartIdx] + str[srcStartIdx:srcEndIdx] + str[dstEndIdx:srcStartIdx] + str[dstStartIdx:dstEndIdx] + str[srcEndIdx:]
}
return str
}
func getTraceflowStatusMessage(tf *crdv1alpha1.Traceflow) string {
switch tf.Status.Phase {
case crdv1alpha1.Failed:
return getWrappedStr(fmt.Sprintf("Traceflow %s failed: %s", tf.Name, tf.Status.Reason))
case crdv1alpha1.Running:
return getWrappedStr(fmt.Sprintf("Traceflow %s is running...", tf.Name))
case crdv1alpha1.Pending:
return getWrappedStr(fmt.Sprintf("Traceflow %s is pending...", tf.Name))
default:
return getWrappedStr("Unknown Traceflow status. Please check whether Antrea is running.")
}
}
func genSubGraph(graph *gographviz.Graph, cluster *gographviz.SubGraph, result *crdv1alpha1.NodeResult, spec *crdv1alpha1.TraceflowSpec,
endpointNodeName string, isForwardDir bool, addNodeNum int) ([]*gographviz.Node, error) {
var nodes []*gographviz.Node
// Show the name of cluster.
if len(result.Node) > 0 {
cluster.Attrs[gographviz.Label] = getWrappedStr(result.Node)
if isForwardDir {
cluster.Attrs[gographviz.LabelJust] = "l"
} else {
cluster.Attrs[gographviz.LabelJust] = "r"
}
}
// Construct the first node. Show it only if we know the name of it.
node, err := createEndpointNodeWithDefaultStyle(graph, cluster.Name, endpointNodeName)
if err != nil {
return nil, err
}
nodes = append(nodes, node)
if len(endpointNodeName) == 0 {
node.Attrs[gographviz.Style] = `"invis"`
}
// Reorder the observations according to the direction of edges.
// Before that, deep copy observations to prevent possible risks of the original traceflow being modified.
obs := make([]crdv1alpha1.Observation, len(result.Observations))
copy(obs, result.Observations)
if !isForwardDir {
for i := len(obs)/2 - 1; i >= 0; i-- {
opp := len(obs) - 1 - i
obs[i], obs[opp] = obs[opp], obs[i]
}
}
// Draw the actual observations of traceflow.
for i := range obs {
o := obs[i]
// Construct node and edge.
nodeName := fmt.Sprintf("%s_%d", cluster.Name, len(nodes))
node, err := createNodeWithDefaultStyle(graph, cluster.Name, nodeName)
if err != nil {
return nil, err
}
node.Attrs[gographviz.Label] = getWrappedStr(string(o.Component))
nodes = append(nodes, node)
if len(nodes) > 1 {
edge, err := createDirectedEdgeWithDefaultStyle(graph, nodes[len(nodes)-2], nodes[len(nodes)-1], isForwardDir)
if err != nil {
return nil, err
}
// Make the graph centered by adjusting the length of edge between the first two nodes.
if len(nodes) == 2 {
edge.Attrs[gographviz.MinLen] = strconv.Itoa(1 + addNodeNum)
} else {
edge.Attrs[gographviz.MinLen] = "1"
}
if o.Action == crdv1alpha1.ActionDropped && !isForwardDir {
edge.Attrs[gographviz.Style] = `"invis"`
}
}
// Set the pattern of node.
if o.Action == crdv1alpha1.ActionDropped {
node.Attrs[gographviz.Color] = fireBrick
node.Attrs[gographviz.FillColor] = mistyRose
} else {
node.Attrs[gographviz.FillColor] = gainsboro
}
// Set the message shown inside node.
labelStr := getTraceflowMessage(&o, spec)
node.Attrs[gographviz.Label] = getWrappedStr(labelStr)
}
return nodes, nil
}
func GenGraph(tf *crdv1alpha1.Traceflow) (string, error) {
g, _ := gographviz.ParseString(`digraph G {}`)
graph := gographviz.NewGraph()
if err := gographviz.Analyse(g, graph); err != nil {
return "", err
}
graph.Attrs[gographviz.Center] = "true"
graph.Attrs[gographviz.Label] = getWrappedStr(tf.Name)
graph.Attrs[gographviz.LabelLOC] = "t"
err := graph.SetDir(true)
if err != nil {
return "", err
}
senderRst := getNodeResult(tf, isSender)
receiverRst := getNodeResult(tf, isReceiver)
if tf.Status.Phase != crdv1alpha1.Succeeded {
graph.Attrs[gographviz.Label] = getTraceflowStatusMessage(tf)
}
if tf == nil || senderRst == nil || tf.Status.Phase != crdv1alpha1.Succeeded || len(senderRst.Observations) == 0 {
// For live traffic, when the source is IP or empty, there is no result from the sender Node result in the traceflow status.
if senderRst == nil && tf.Spec.LiveTraffic && tf.Status.Phase == crdv1alpha1.Succeeded {
// Draw the nodes for the sender.
srcCluster, err := createClusterWithDefaultStyle(graph, clusterSrcName)
if err != nil {
return "", err
}
srcCluster.Attrs[gographviz.Label] = "source"
srcCluster.Attrs[gographviz.LabelJust] = "l"
// For live traffic data, we only know src IP from capturedPacket
node, err := createEndpointNodeWithDefaultStyle(graph, srcCluster.Name, getWrappedStr(tf.Status.CapturedPacket.SrcIP))
if err != nil {
return "", err
}
// create an invisble edge before destination cluster, otherwise the source cluster will
// always be on the right even source subGraph is before desitination subGraph in graph string.
err = graph.AddEdge(node.Name, node.Name, true, map[string]string{
"style": "invis",
})
if err != nil {
return "", err
}
dstCluster, err := createClusterWithDefaultStyle(graph, clusterDstName)
if err != nil {
return "", err
}
nodes, err := genSubGraph(graph, dstCluster, receiverRst, &tf.Spec, getDstNodeName(tf), false, 0)
if err != nil {
return "", err
}
// Draw the cross-cluster edge.
edge, err := createDirectedEdgeWithDefaultStyle(graph, node, nodes[len(nodes)-1], true)
if err != nil {
return "", err
}
edge.Attrs[gographviz.Constraint] = "false"
err = createCapturedPacketNode(graph, dstCluster.Name, tf)
if err != nil {
return "", err
}
// add an anonymous subgraph to make two nodes in the same level.
// refer to https://github.com/awalterschulze/gographviz/issues/59
graph.AddAttr("G", "newrank", "true")
graph.AddSubGraph("G", "force_node_same_level", map[string]string{"rank": "same"})
graph.AddNode("force_node_same_level", node.Name, nil)
graph.AddNode("force_node_same_level", nodes[len(nodes)-1].Name, nil)
return genOutput(graph, false), nil
}
return genOutput(graph, true), nil
}
cluster1, err := createClusterWithDefaultStyle(graph, clusterSrcName)
if err != nil {
return "", err
}
// Handle single node traceflow.
if receiverRst == nil {
nodes, err := genSubGraph(graph, cluster1, senderRst, &tf.Spec, getSrcNodeName(tf), true, 0)
if err != nil {
return "", err
}
// Draw the destination pod and involved edge.
if len(nodes) == 0 {
return genOutput(graph, true), nil
}
switch senderRst.Observations[len(senderRst.Observations)-1].Action {
// If the last action of the sender is FORWARDED,
// then the packet has been sent out by sender, implying that there is a disconnection.
case crdv1alpha1.ActionForwarded:
lastNode, err := createEndpointNodeWithDefaultStyle(graph, graph.Name, getDstNodeName(tf))
if err != nil {
return "", err
}
err = graph.AddEdge(nodes[len(nodes)-1].Name, lastNode.Name, true, map[string]string{
"penwidth": "2.0",
"color": darkRed,
"style": `"dashed"`,
})
if err != nil {
return "", err
}
case crdv1alpha1.ActionDelivered:
lastNode, err := createEndpointNodeWithDefaultStyle(graph, cluster1.Name, getDstNodeName(tf))
if err != nil {
return "", err
}
_, err = createDirectedEdgeWithDefaultStyle(graph, nodes[len(nodes)-1], lastNode, true)
if err != nil {
return "", err
}
}
if tf.Spec.LiveTraffic && tf.Status.Phase == crdv1alpha1.Succeeded {
err = createCapturedPacketNode(graph, cluster1.Name, tf)
if err != nil {
return "", err
}
}
return genOutput(graph, true), nil
}
// Make the graph centered by balancing the difference of node numbers on two sides with the length of first edge.
var nodeNum int
if len(senderRst.Observations) > len(receiverRst.Observations) {
nodeNum = len(senderRst.Observations)
} else {
nodeNum = len(receiverRst.Observations)
}
// Draw the nodes for the sender.
nodes1, err := genSubGraph(graph, cluster1, senderRst, &tf.Spec, getSrcNodeName(tf), true, nodeNum-len(senderRst.Observations))
if err != nil {
return "", err
}
// Draw the nodes for the receiver.
cluster2, err := createClusterWithDefaultStyle(graph, clusterDstName)
if err != nil {
return "", err
}
nodes2, err := genSubGraph(graph, cluster2, receiverRst, &tf.Spec, getDstNodeName(tf), false, nodeNum-len(receiverRst.Observations))
if err != nil {
return "", err
}
// Draw the cross-cluster edge.
if len(nodes1) > 0 && len(nodes2) > 0 {
edge, err := createDirectedEdgeWithDefaultStyle(graph, nodes1[len(nodes1)-1], nodes2[len(nodes2)-1], true)
if err != nil {
return "", err
}
edge.Attrs[gographviz.Constraint] = "false"
}
if tf.Spec.LiveTraffic && tf.Status.Phase == crdv1alpha1.Succeeded {
err = createCapturedPacketNode(graph, cluster2.Name, tf)
if err != nil {
return "", err
}
}
return genOutput(graph, false), nil
}
func getCapturedPacketLabel(tf *crdv1alpha1.Traceflow) string {
label := "Captured Packet:\\lSource IP: " + tf.Status.CapturedPacket.SrcIP + "\\l" +
"Destination IP: " + tf.Status.CapturedPacket.DstIP + "\\l" +
"Length: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.Length) + "\\l"
if tf.Status.CapturedPacket.IPv6Header == nil {
label = label + "IPv4 Header: " + "\\l" +
" Flags: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.IPHeader.Flags) + "\\l" +
" Protocol: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.IPHeader.Protocol) + "\\l" +
" TTL: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.IPHeader.TTL) + "\\l"
} else {
label = label + "IPv6 Header: \\l" +
" Next Header: " + fmt.Sprintf("%d", *tf.Status.CapturedPacket.IPv6Header.NextHeader) + "\\l" +
" Hop Limit: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.IPv6Header.HopLimit) + "\\l"
}
if tf.Status.CapturedPacket.TransportHeader != (crdv1alpha1.TransportHeader{}) {
label = label + "Transport Header: \\l"
if tf.Status.CapturedPacket.TransportHeader.TCP != nil {
label = label + " TCP: " + "\\l" +
" Source Port: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.TransportHeader.TCP.SrcPort) + "\\l" +
" Destination Port: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.TransportHeader.TCP.DstPort) + "\\l"
}
if tf.Status.CapturedPacket.TransportHeader.UDP != nil {
label = label + " UDP: " + "\\l" +
" Source Port: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.TransportHeader.UDP.SrcPort) + "\\l" +
" Destination Port: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.TransportHeader.UDP.DstPort) + "\\l"
}
if tf.Status.CapturedPacket.TransportHeader.ICMP != nil {
label = label + " ICMP: " + "\\l" +
" ID: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.TransportHeader.ICMP.ID) + "\\l" +
" Sequence: " + fmt.Sprintf("%d", tf.Status.CapturedPacket.TransportHeader.ICMP.Sequence) + "\\l"
}
}
return label
}
func createCapturedPacketNode(graph *gographviz.Graph, parentGraph string, tf *crdv1alpha1.Traceflow) error {
err := graph.AddNode(parentGraph, "capturedPacket", map[string]string{
"shape": "note",
"style": `"rounded,filled,solid"`,
"color": dimGrey,
"label": `"` + getCapturedPacketLabel(tf) + `"`,
})
if err != nil {
return err
}
return nil
}