NETOBSERV-2355: Rename sampling ratio/rate -> interval (#385)

jotak · web-flow · commit 6a4f32e351a5 · 2025-09-22T17:05:26.000+02:00
diff --git a/cmd/config.yaml b/cmd/config.yaml
@@ -1325,7 +1325,7 @@ fields:
     description: Differentiated Services Code Point (DSCP) value
   - name: Sampling
     type: number
-    description: Sampling rate used for this flow
+    description: Sampling interval used for this flow
   - name: IcmpType
     type: number
     description: ICMP type
diff --git a/docs/netobserv_cli.adoc b/docs/netobserv_cli.adoc
@@ -64,7 +64,7 @@ $ oc netobserv flows [<feature_option>] [<command_options>]
 |--enable_rtt|                enable RTT tracking                                   | false
 |--enable_udn_mapping|        enable User Defined Network mapping                   | false
 |--get-subnets|               get subnets information                               | false
-|--sampling|                  value that defines the ratio of packets being sampled | 1
+|--sampling|                  packets sampling interval                             | 1
 |--background|                run in background                                     | false
 |--copy|                      copy the output files locally                         | prompt
 |--log-level|                 components logs                                       | info
@@ -167,7 +167,7 @@ $ oc netobserv metrics [<option>]
 |--enable_rtt|                enable RTT tracking                                   | false
 |--enable_udn_mapping|        enable User Defined Network mapping                   | false
 |--get-subnets|               get subnets information                               | false
-|--sampling|                  value that defines the ratio of packets being sampled | 1
+|--sampling|                  packets sampling interval                             | 1
 |--max-time|                  maximum capture time                                  | 1h
 |--action|                    filter action                                         | Accept
 |--cidr|                      filter CIDR                                           | 0.0.0.0/0
diff --git a/scripts/help.sh b/scripts/help.sh
@@ -76,7 +76,7 @@ function features_usage {
   echo "  --enable_udn_mapping:         enable User Defined Network mapping                   (default: false)"
   echo "  --get-subnets:                get subnets information                               (default: false)"
   echo "  --privileged:                 force eBPF agent privileged mode                      (default: auto)"
-  echo "  --sampling:                   value that defines the ratio of packets being sampled (default: 1)"
+  echo "  --sampling:                   packets sampling interval                             (default: 1)"
 }
 
 # flow and packets collector options

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ function features_usage {`
`76`	`76`	`echo " --enable_udn_mapping: enable User Defined Network mapping (default: false)"`
`77`	`77`	`echo " --get-subnets: get subnets information (default: false)"`
`78`	`78`	`echo " --privileged: force eBPF agent privileged mode (default: auto)"`
`79`		`- echo " --sampling: value that defines the ratio of packets being sampled (default: 1)"`
	`79`	`+ echo " --sampling: packets sampling interval (default: 1)"`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`# flow and packets collector options`