Skip to content

Commit 06fa283

Browse files
jpinsonneaujpinsonneau
committed
update sampling descripton
1 parent 8bc864e commit 06fa283

File tree

2 files changed

+132
-132
lines changed

2 files changed

+132
-132
lines changed

‎docs/netobserv_cli.adoc‎

Lines changed: 95 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -55,43 +55,43 @@ $ oc netobserv flows [<feature_option>] [<command_options>]
5555
[cols="1,1,1",options="header"]
5656
|===
5757
| Option | Description | Default
58-
|--enable_all| enable all eBPF features | false
59-
|--enable_dns| enable DNS tracking | false
60-
|--enable_network_events| enable network events monitoring | false
61-
|--enable_pkt_translation| enable packet translation | false
62-
|--enable_pkt_drop| enable packet drop | false
63-
|--enable_rtt| enable RTT tracking | false
64-
|--enable_udn_mapping| enable User Defined Network mapping | false
65-
|--get-subnets| get subnets information | false
66-
|--sampling| rate at which packets should be sampled | 1
67-
|--background| run in background | false
68-
|--copy| copy the output files locally | prompt
69-
|--log-level| components logs | info
70-
|--max-time| maximum capture time | 5m
71-
|--max-bytes| maximum capture bytes | 50000000 = 50MB
72-
|--action| filter action | Accept
73-
|--cidr| filter CIDR | 0.0.0.0/0
74-
|--direction| filter direction | -
75-
|--dport| filter destination port | -
76-
|--dport_range| filter destination port range | -
77-
|--dports| filter on either of two destination ports | -
78-
|--drops| filter flows with only dropped packets | false
79-
|--icmp_code| filter ICMP code | -
80-
|--icmp_type| filter ICMP type | -
81-
|--node-selector| capture on specific nodes | -
82-
|--peer_ip| filter peer IP | -
83-
|--peer_cidr| filter peer CIDR | -
84-
|--port_range| filter port range | -
85-
|--port| filter port | -
86-
|--ports| filter on either of two ports | -
87-
|--protocol| filter protocol | -
88-
|--query| filter flows using a custom query | -
89-
|--sport_range| filter source port range | -
90-
|--sport| filter source port | -
91-
|--sports| filter on either of two source ports | -
92-
|--tcp_flags| filter TCP flags | -
93-
|--interfaces| interfaces to monitor, comma separated | -
94-
|--exclude_interfaces| interfaces to exclude, comma separated | lo
58+
|--enable_all| enable all eBPF features | false
59+
|--enable_dns| enable DNS tracking | false
60+
|--enable_network_events| enable network events monitoring | false
61+
|--enable_pkt_translation| enable packet translation | false
62+
|--enable_pkt_drop| enable packet drop | false
63+
|--enable_rtt| enable RTT tracking | false
64+
|--enable_udn_mapping| enable User Defined Network mapping | false
65+
|--get-subnets| get subnets information | false
66+
|--sampling| value that defines the ratio of packets being sampled | 1
67+
|--background| run in background | false
68+
|--copy| copy the output files locally | prompt
69+
|--log-level| components logs | info
70+
|--max-time| maximum capture time | 5m
71+
|--max-bytes| maximum capture bytes | 50000000 = 50MB
72+
|--action| filter action | Accept
73+
|--cidr| filter CIDR | 0.0.0.0/0
74+
|--direction| filter direction | -
75+
|--dport| filter destination port | -
76+
|--dport_range| filter destination port range | -
77+
|--dports| filter on either of two destination ports | -
78+
|--drops| filter flows with only dropped packets | false
79+
|--icmp_code| filter ICMP code | -
80+
|--icmp_type| filter ICMP type | -
81+
|--node-selector| capture on specific nodes | -
82+
|--peer_ip| filter peer IP | -
83+
|--peer_cidr| filter peer CIDR | -
84+
|--port_range| filter port range | -
85+
|--port| filter port | -
86+
|--ports| filter on either of two ports | -
87+
|--protocol| filter protocol | -
88+
|--query| filter flows using a custom query | -
89+
|--sport_range| filter source port range | -
90+
|--sport| filter source port | -
91+
|--sports| filter on either of two source ports | -
92+
|--tcp_flags| filter TCP flags | -
93+
|--interfaces| interfaces to monitor, comma separated | -
94+
|--exclude_interfaces| interfaces to exclude, comma separated | lo
9595
|===
9696

9797
.Example running flows capture on TCP protocol and port 49051 with PacketDrop and RTT features enabled:
@@ -112,32 +112,32 @@ $ oc netobserv packets [<option>]
112112
[cols="1,1,1",options="header"]
113113
|===
114114
| Option | Description | Default
115-
|--background| run in background | false
116-
|--copy| copy the output files locally | prompt
117-
|--log-level| components logs | info
118-
|--max-time| maximum capture time | 5m
119-
|--max-bytes| maximum capture bytes | 50000000 = 50MB
120-
|--action| filter action | Accept
121-
|--cidr| filter CIDR | 0.0.0.0/0
122-
|--direction| filter direction | -
123-
|--dport| filter destination port | -
124-
|--dport_range| filter destination port range | -
125-
|--dports| filter on either of two destination ports | -
126-
|--drops| filter flows with only dropped packets | false
127-
|--icmp_code| filter ICMP code | -
128-
|--icmp_type| filter ICMP type | -
129-
|--node-selector| capture on specific nodes | -
130-
|--peer_ip| filter peer IP | -
131-
|--peer_cidr| filter peer CIDR | -
132-
|--port_range| filter port range | -
133-
|--port| filter port | -
134-
|--ports| filter on either of two ports | -
135-
|--protocol| filter protocol | -
136-
|--query| filter flows using a custom query | -
137-
|--sport_range| filter source port range | -
138-
|--sport| filter source port | -
139-
|--sports| filter on either of two source ports | -
140-
|--tcp_flags| filter TCP flags | -
115+
|--background| run in background | false
116+
|--copy| copy the output files locally | prompt
117+
|--log-level| components logs | info
118+
|--max-time| maximum capture time | 5m
119+
|--max-bytes| maximum capture bytes | 50000000 = 50MB
120+
|--action| filter action | Accept
121+
|--cidr| filter CIDR | 0.0.0.0/0
122+
|--direction| filter direction | -
123+
|--dport| filter destination port | -
124+
|--dport_range| filter destination port range | -
125+
|--dports| filter on either of two destination ports | -
126+
|--drops| filter flows with only dropped packets | false
127+
|--icmp_code| filter ICMP code | -
128+
|--icmp_type| filter ICMP type | -
129+
|--node-selector| capture on specific nodes | -
130+
|--peer_ip| filter peer IP | -
131+
|--peer_cidr| filter peer CIDR | -
132+
|--port_range| filter port range | -
133+
|--port| filter port | -
134+
|--ports| filter on either of two ports | -
135+
|--protocol| filter protocol | -
136+
|--query| filter flows using a custom query | -
137+
|--sport_range| filter source port range | -
138+
|--sport| filter source port | -
139+
|--sports| filter on either of two source ports | -
140+
|--tcp_flags| filter TCP flags | -
141141
|===
142142

143143
.Example running packets capture on TCP protocol and port 49051:
@@ -157,38 +157,38 @@ $ oc netobserv metrics [<option>]
157157
[cols="1,1,1",options="header"]
158158
|===
159159
| Option | Description | Default
160-
|--enable_all| enable all eBPF features | false
161-
|--enable_dns| enable DNS tracking | false
162-
|--enable_network_events| enable network events monitoring | false
163-
|--enable_pkt_translation| enable packet translation | false
164-
|--enable_pkt_drop| enable packet drop | false
165-
|--enable_rtt| enable RTT tracking | false
166-
|--enable_udn_mapping| enable User Defined Network mapping | false
167-
|--get-subnets| get subnets information | false
168-
|--sampling| rate at which packets should be sampled | 1
169-
|--action| filter action | Accept
170-
|--cidr| filter CIDR | 0.0.0.0/0
171-
|--direction| filter direction | -
172-
|--dport| filter destination port | -
173-
|--dport_range| filter destination port range | -
174-
|--dports| filter on either of two destination ports | -
175-
|--drops| filter flows with only dropped packets | false
176-
|--icmp_code| filter ICMP code | -
177-
|--icmp_type| filter ICMP type | -
178-
|--node-selector| capture on specific nodes | -
179-
|--peer_ip| filter peer IP | -
180-
|--peer_cidr| filter peer CIDR | -
181-
|--port_range| filter port range | -
182-
|--port| filter port | -
183-
|--ports| filter on either of two ports | -
184-
|--protocol| filter protocol | -
185-
|--query| filter flows using a custom query | -
186-
|--sport_range| filter source port range | -
187-
|--sport| filter source port | -
188-
|--sports| filter on either of two source ports | -
189-
|--tcp_flags| filter TCP flags | -
190-
|--interfaces| interfaces to monitor, comma separated | -
191-
|--exclude_interfaces| interfaces to exclude, comma separated | lo
160+
|--enable_all| enable all eBPF features | false
161+
|--enable_dns| enable DNS tracking | false
162+
|--enable_network_events| enable network events monitoring | false
163+
|--enable_pkt_translation| enable packet translation | false
164+
|--enable_pkt_drop| enable packet drop | false
165+
|--enable_rtt| enable RTT tracking | false
166+
|--enable_udn_mapping| enable User Defined Network mapping | false
167+
|--get-subnets| get subnets information | false
168+
|--sampling| value that defines the ratio of packets being sampled | 1
169+
|--action| filter action | Accept
170+
|--cidr| filter CIDR | 0.0.0.0/0
171+
|--direction| filter direction | -
172+
|--dport| filter destination port | -
173+
|--dport_range| filter destination port range | -
174+
|--dports| filter on either of two destination ports | -
175+
|--drops| filter flows with only dropped packets | false
176+
|--icmp_code| filter ICMP code | -
177+
|--icmp_type| filter ICMP type | -
178+
|--node-selector| capture on specific nodes | -
179+
|--peer_ip| filter peer IP | -
180+
|--peer_cidr| filter peer CIDR | -
181+
|--port_range| filter port range | -
182+
|--port| filter port | -
183+
|--ports| filter on either of two ports | -
184+
|--protocol| filter protocol | -
185+
|--query| filter flows using a custom query | -
186+
|--sport_range| filter source port range | -
187+
|--sport| filter source port | -
188+
|--sports| filter on either of two source ports | -
189+
|--tcp_flags| filter TCP flags | -
190+
|--interfaces| interfaces to monitor, comma separated | -
191+
|--exclude_interfaces| interfaces to exclude, comma separated | lo
192192
|===
193193

194194
.Example running metrics capture for TCP drops

0 commit comments

Comments
 (0)