summaryrefslogtreecommitdiff
path: root/docs/vpp
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-05 01:42:07 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 16:18:03 +0300
commit80c5ca4aebb666932f681d2be0e7712e22d97f47 (patch)
tree21b93597e7df6cb62c7d42b0db4a37f2cbdbb954 /docs/vpp
parentce48fd34ef9347947206c23f13332e6e32fe0be0 (diff)
downloadvyos-documentation-80c5ca4aebb666932f681d2be0e7712e22d97f47.tar.gz
vyos-documentation-80c5ca4aebb666932f681d2be0e7712e22d97f47.zip
docs: address review feedback from PR #1857
Fix conversion artifacts, typos, grammar errors, and technical inaccuracies flagged by automated code review (Copilot + CodeRabbit). Infrastructure: add root-level md-*.md exclusion to conf.py, fix sphinx-autobuild ignore globs in Makefile. Content: fix curly quotes, invalid Go panic() calls, shell quoting in cURL examples, incorrect firewall command paths, typos across 22 documentation files, remove duplicate sections. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/vpp')
-rw-r--r--docs/vpp/configuration/md-sflow.md39
1 files changed, 28 insertions, 11 deletions
diff --git a/docs/vpp/configuration/md-sflow.md b/docs/vpp/configuration/md-sflow.md
index 53f6feed..042cf8a8 100644
--- a/docs/vpp/configuration/md-sflow.md
+++ b/docs/vpp/configuration/md-sflow.md
@@ -12,34 +12,51 @@ lastproofread: '2025-09-04'
VPP Dataplane in VyOS supports sFlow for traffic monitoring and analysis.
-The VPP Dataplane integration works hand-in-hand with normal kernel sFlow agent, which is responsible for collecting and exporting sFlow samples. VPP itself is responsible for generating the samples.
+The VPP Dataplane integration works hand-in-hand with normal kernel
+sFlow agent, which is responsible for collecting and exporting sFlow
+samples. VPP itself is responsible for generating the samples.
-To enable sFlow in VPP, you first need to configure the service using the same steps as for normal kernel sFlow agent, as described in {doc}`/configuration/system/sflow`. Then you can enable sFlow on VPP interfaces.
+To enable sFlow in VPP, you first need to configure the service using
+the same steps as for normal kernel sFlow agent, as described in
+{doc}`/configuration/system/sflow`. Then you can enable sFlow on VPP
+interfaces.
-Then, you need to enable sFlow on the VPP interfaces you want to monitor. This is done using the following commands:
+Then, you need to enable sFlow on the VPP interfaces you want to
+monitor. This is done using the following commands:
```{cfgcmd} set vpp sflow interface \<interface-name\>
```
-This will enable sFlow on the specified interface. You can repeat this command for each interface you want to monitor.
+This will enable sFlow on the specified interface. You can repeat
+this command for each interface you want to monitor.
:::{note}
-sFlow collects statistics only for traffic *received* on the interface. If you want to monitor traffic *sent* on the interface, you need to enable sFlow on the corresponding interface in the opposite direction.
+sFlow collects statistics only for traffic *received* on the
+interface. If you want to monitor traffic *sent* on the interface,
+you need to enable sFlow on the corresponding interface in the
+opposite direction.
:::
-Optionally, you can specify the number of bytes from each packet that should be included in the sFlow sample using the following command:
+Optionally, you can specify the number of bytes from each packet
+that should be included in the sFlow sample using the following
+command:
```{cfgcmd} set vpp sflow header-bytes \<bytes\>
```
-This defines the size of the packet header (in bytes) captured for each sFlow sample.
+This defines the size of the packet header (in bytes) captured for
+each sFlow sample.
-The sampling rate is configured globally under the `system sflow` section and automatically applied to VPP sFlow.
-This ensures consistent sampling behavior between the system and VPP, and prevents configuration conflicts.
+The sampling rate is configured globally under the `system sflow`
+section and automatically applied to VPP sFlow. This ensures
+consistent sampling behavior between the system and VPP, and
+prevents configuration conflicts.
-Finally, you need to enable integration between VPP and the kernel sFlow agent using the following command:
+Finally, you need to enable integration between VPP and the kernel
+sFlow agent using the following command:
```{cfgcmd} set system sflow vpp
```
-After this, collecting and exporting sFlow samples will be handled by the kernel sFlow agent, while VPP will generate the samples.
+After this, collecting and exporting sFlow samples will be handled
+by the kernel sFlow agent, while VPP will generate the samples.