Skip to content

address doc feedback #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Jun 26, 2025
Merged

address doc feedback #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/netobserv_cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ $ oc netobserv flows [<feature_option>] [<command_options>]
|--sport| filter source port | -
|--sports| filter on either of two source ports | -
|--tcp_flags| filter TCP flags | -
|--interfaces| interfaces to monitor, comma separated | -
|--exclude_interfaces| interfaces to exclude, comma separated | lo
|--interfaces| list of interfaces to monitor, comma separated | -
|--exclude_interfaces| list of interfaces to exclude, comma separated | lo
|===

.Example running flows capture on TCP protocol and port 49051 with PacketDrop and RTT features enabled:
Expand Down Expand Up @@ -189,9 +189,9 @@ $ oc netobserv metrics [<option>]
|--sport| filter source port | -
|--sports| filter on either of two source ports | -
|--tcp_flags| filter TCP flags | -
|--include_list| list of metric names to generate | namespace_flows_total,node_ingress_bytes_total,node_egress_bytes_total,workload_ingress_bytes_total
|--interfaces| interfaces to monitor, comma separated | -
|--exclude_interfaces| interfaces to exclude, comma separated | lo
|--include_list| list of metric names to generate, comma separated | namespace_flows_total,node_ingress_bytes_total,node_egress_bytes_total,workload_ingress_bytes_total
|--interfaces| list of interfaces to monitor, comma separated | -
|--exclude_interfaces| list of interfaces to exclude, comma separated | lo
|===

.Example running metrics capture for TCP drops
Expand Down
6 changes: 3 additions & 3 deletions scripts/help.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ function filters_usage {

# specific filters for flows and metrics
function flowsAndMetrics_filters_usage {
echo " --interfaces: interfaces to monitor, comma separated (default: n/a)"
echo " --exclude_interfaces: interfaces to exclude, comma separated (default: lo)"
echo " --interfaces: list of interfaces to monitor, comma separated (default: n/a)"
echo " --exclude_interfaces: list of interfaces to exclude, comma separated (default: lo)"
}

# specific filters for metrics
function metrics_options {
echo " --include_list: list of metric names to generate (default: $includeList)"
echo " --include_list: list of metric names to generate, comma separated (default: $includeList)"
}

function flows_usage {
Expand Down