From 1bb46406f8795adeed71b20e2dec3b700ebb3576 Mon Sep 17 00:00:00 2001 From: cumulusAnia Date: Fri, 31 Jan 2025 14:31:47 -0800 Subject: [PATCH] add telemetry stats group commands --- .../Set-and-Unset-Commands/Telemetry.md | 484 ++++++++++++++++++ .../nvue-reference/Show-Commands/Telemetry.md | 464 ++++++++++++++++- 2 files changed, 925 insertions(+), 23 deletions(-) diff --git a/content/nvue-reference/Set-and-Unset-Commands/Telemetry.md b/content/nvue-reference/Set-and-Unset-Commands/Telemetry.md index 3223999637..8b9d9b99dd 100644 --- a/content/nvue-reference/Set-and-Unset-Commands/Telemetry.md +++ b/content/nvue-reference/Set-and-Unset-Commands/Telemetry.md @@ -1562,3 +1562,487 @@ Introduced in Cumulus Linux 5.11.0 ``` cumulus@switch:~$ nv set system telemetry snapshot port-group packet-all-pg timer-interval 15 ``` + +
+ +## nv set system telemetry stats-group \ + +Configures a statistics group name. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 +``` + +
+ +## nv set system telemetry stats-group \ interface-stats export state + +Configures a statistics group to export all interface statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 interface-stats export state enabled +``` + +
+ +## nv set system telemetry stats-group \ interface-stats sample-interval + +Configures the sample interval for the statistics group for interface statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 interface-stats sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ buffer-stats export state + +Configures a custom statistics group to export all buffer statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 buffer-stats export state enabled +``` + +
+ +## nv set system telemetry stats-group \ buffer-stats sample-interval + +Configures the sample interval for the custom statistics group for buffer statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 buffer-stats sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ histogram export state + +Configures a custom statistics group to export histogram statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 histogram export state enabled +``` + +
+ +## nv set system telemetry stats-group \ router export state + +Configures a custom statistics group to export router statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 router export state enabled +``` + +
+ +## nv set system telemetry stats-group \ router sample-interval + +Configures the sample interval for the custom statistics group for router statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 router sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ control-plane-stats export state + +Configures a custom statistics group to export control plane statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 control-plane-stats export state enabled +``` + +
+ +## nv set system telemetry stats-group \ control-plane-stats sample-interval + +Configures the sample interval for the custom statistics group for control plane statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 control-plane-stats sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ platform-stats export state + +Configures a custom statistics group to export platform statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 platform-stats export state enabled +``` + +
+ +## nv set system telemetry stats-group \ platform-stats export sample-interval + +Configures the sample interval for the custom statistics group for platform statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 platform-stats sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class cpu state + +Configures a custom statistics group to export CPU platform statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 platform-stats class cpu export state enabled +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class cpu sample-interval + +Configures the sample interval for the custom statistics group for CPU platform statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 platform-stats class cpu sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class disk state + +Configures a custom statistics group to export disk platform statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 platform-stats class disk export state enabled +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class disk sample-interval + +Configures the sample interval for the custom statistics group for disk platform statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 platform-stats class disk sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class file-system state + +Configures a custom statistics group to export file system platform statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 platform-stats class file-system export state enabled +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class file-system sample-interval + +Configures the sample interval for the custom statistics group for file system platform statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 platform-stats class file-system sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class environment-sensor state + +Configures a custom statistics group to export environment-sensor platform statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 platform-stats class environment-sensor export state enabled +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class environment-sensor sample-interval + +Configures the sample interval for the custom statistics group for environment sensor platform statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 platform-stats class environment-sensor sample-interval 100 +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class memory state + +Configures a custom statistics group to export memory platform statistics. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP1 platform-stats class memory export state enabled +``` + +
+ +## nv set system telemetry stats-group \ platform-stats class memory sample-interval + +Configures the sample interval for the custom statistics group for memory platform statistics. You can specify a value between 1 and 86400. The default value is 1. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP2 platform-stats class memory sample-interval 100 +``` diff --git a/content/nvue-reference/Show-Commands/Telemetry.md b/content/nvue-reference/Show-Commands/Telemetry.md index 5e14a44ef6..d99196a7ab 100644 --- a/content/nvue-reference/Show-Commands/Telemetry.md +++ b/content/nvue-reference/Show-Commands/Telemetry.md @@ -2420,7 +2420,15 @@ No Data
-## nv show system telemetry stats-group +## nv show system telemetry stats-group \ interface-stats + +Shows configuration for the custom statistics group for interface statistics export. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | ### Version History @@ -2429,78 +2437,488 @@ Introduced in Cumulus Linux 5.12.0 ### Example ``` -cumulus@switch:~$ +cumulus@switch:~$ nv show system telemetry stats-group STAT-GROUP1 interface-stats + applied +--------------- -------- +sample-interval 100 +export + state enabled +class + phy + state disabled ``` - \ No newline at end of file +## nv show system telemetry stats-group \ platform-stats class memory + +Shows if the custom statistics group for memory platform statistics export is enabled. + +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| ``| The statistics group name. | + +### Version History + +Introduced in Cumulus Linux 5.12.0 + +### Example + +``` +cumulus@leaf01:mgmt:~$ nv show system telemetry stats-group STAT-GROUP1 platform-stats class memory + applied +----- ------- +state enabled +```