1ovs-dpctl-top(8) Open vSwitch Manual ovs-dpctl-top(8)
2
6 ovs-dpctl-top - Top like behavior for ovs-dpctl dump-flows
7
9 ovs-dpctl-top [-h] [-v] [-f FLOWFILES] [-V] [-s] [--host HOST] [-a |
10 --accumulate] [--accumulate-decay ACCUMULATEDECAY] [-d DELAY]
11
13 This program summarizes ovs-dpctl flow content by aggregating the num‐
14 ber of packets, total bytes and occurrence of the following fields:
15 - Datapath in_port
17 - Ethernet type
19 - Source and destination MAC addresses
21 - IP protocol
23 - Source and destination IPv4 addresses
25 - Source and destination IPv6 addresses
27 - UDP and TCP destination port
29 - Tunnel source and destination addresses
31 Output shows four values:
33 - FIELDS: the flow fields for example in_port(1).
34 - COUNT: the number of lines in the dump-flow output contain the
36 flow field.
37 - PACKETS: the total number of packets containing the flow
39 field.
40 - BYTES: the total number of bytes containing the flow field.
42 If units are not present then values are in bytes.
43 - AVERAGE: the average packets size (BYTES/PACKET).
45 Top Behavior
47 While in top mode, the default behavior, the following single character
48 commands are supported:
49 a - toggles top in accumulate and live mode. Accumulate mode is
51 described below.
52 s - toggles which column is used to sort content in decreasing
54 order. A DESC title is placed over the column.
55 _ - a space indicating to collect dump-flow content again
57 h - halt output. Any character will restart sampling
59 f - cycle through flow fields
61 q - q for quit.
63 Accumulate Mode
65 There are two supported modes: live and accumulate. The default is
66 live. The parameter --accumulate or the 'a' character in top mode en‐
67 ables the latter. In live mode, recent dump-flow content is presented.
68 Where as accumulate mode keeps track of the prior historical informa‐
69 tion until the flow is reset not when the flow is purged. Reset flows
70 are determined when the packet count for a flow has decreased from its
71 previous sample. There is one caveat, eventually the system will run
72 out of memory if, after the accumulate-decay period any flows that have
73 not been refreshed are purged. The goal here is to free memory of
74 flows that are not active. Statistics are not decremented. Their pur‐
75 pose is to reflect the overall history of the flow fields.
76 Debugging Errors
78 Parsing errors are counted and displayed in the status line at the be‐
79 ginning of the output. Use the --verbose option with --script to see
80 what output was not parsed, like this:
81 $ ovs-dpctl dump-flows | ovs-dpctl-top --script --verbose
83 Error messages will identify content that failed to parse.
85 Access Remote Hosts
87 The --host must follow the format user@hostname. This script simply
88 calls 'ssh user@Hostname' without checking for login credentials there‐
89 fore public keys should be installed on the system identified by host‐
90 name, such as:
91 $ ssh-copy-id user@hostname
93 Consult ssh-copy-id man pages for more details.
95 Expected usage
97 $ ovs-dpctl-top
98 or to run as a script:
100 $ ovs-dpctl dump-flows > dump-flows.log
102 $ ovs-dpctl-top --script --flow-file dump-flows.log
104 OPTIONS
106 -h, --help
107 show this help message and exit.
108 -v, --version
110 show program's version number and exit.
111 -f FLOWFILES, --flow-file FLOWFILES
113 file containing flows from ovs-dpctl dump-flow.
114 -V, --verbose
116 enable debug level verbosity.
117 -s, --script
119 Run from a script (no user interface).
120 --host HOST
122 Specify a user@host for retrieving flows see Accessing Remote
123 Hosts for more information.
124 -a, --accumulate
126 Accumulate dump-flow content.
127 --accumulate-decay ACCUMULATEDECAY
129 Decay old accumulated flows. The default is 5 minutes. A value
130 of 0 disables decay.
131 -d DELAY, --delay DELAY
133 Delay in milliseconds to collect dump-flow content (sample
134 rate).
135Open vSwitch 3.1.1 ovs-dpctl-top(8)