Skip to content

Commit 3057e17

Browse files
committed
Merge branch '5.17-features' into stage
2 parents 191976b + ef1a183 commit 3057e17

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

content/cumulus-linux-517/Monitoring-and-Troubleshooting/Open-Telemetry-Export.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -698,11 +698,15 @@ cumulus@switch:~$ nv config apply
698698
Granular metric selection is a Beta feature.
699699
{{%/notice%}}
700700
701-
To tailor metrics collection to your specific monitoring needs, you can collect individual metrics instead of all metrics in a group. You can include or exclude metrics by name or wildcard, globally or for a statistics group or destination at varied collection frequencies.
701+
To tailor metrics collection to your specific monitoring needs, you can collect individual metrics instead of all metrics in a category (such as interface, LLDP, platform) or sub category (such as platform memory or CPU). You can include or exclude metrics by name or wildcard, globally or for a statistics group or destination at varied collection frequencies.
702702
703-
Configure groups with specific metrics, then apply the group by either including or excluding the group of metrics.
703+
To configure granular metric selection, configure a group with the metrics you want to collect, then apply the group by either including or excluding the group.
704704
705-
The following example includes the platform memory metrics `node_memory_MemTotal_bytes` and `node_memory_MemFree_bytes`, and all `nvswitch_env_` and `node_cpu_` metrics in a group called PLATFORM_METRICS.
705+
{{%notice note%}}
706+
The statistics category must be enabled. For example, to configure specific control plane metrics, you must enable the control plane statistics group with the `nv set system telemetry control-plane-stats export state enabled` command. Refer to {{<link url="#configure-open-telemetry" text="Configure Open Telemetry">}}.
707+
{{%/notice%}}
708+
709+
The following example configures the platform memory metrics `node_memory_MemTotal_bytes` and `node_memory_MemFree_bytes`, and all `nvswitch_env_` and `node_cpu_` metrics in a group called PLATFORM_METRICS.
706710
707711
```
708712
cumulus@switch:~$ nv set system telemetry metric-list PLATFORM_METRICS description ”Platform metrics"
@@ -715,20 +719,24 @@ cumulus@switch:~$ nv config apply
715719
716720
To apply the metric collection, run the `nv set system telemetry include-list` command or the `nv set system telemetry exclude-list` command.
717721
718-
The following example includes the metrics in the PLATFORM_METRICS metric group list in the collection:
722+
The following example includes the metrics in the PLATFORM_METRICS metric group in the collection:
719723
720724
```
721725
cumulus@switch:~$ nv set system telemetry include-list PLATFORM_METRICS
722726
cumulus@switch:~$ nv config apply
723727
```
724728
725-
You can apply the metric collection to a statistics group. The following example includes the metrics in the PLATFORM_METRICS metric group list in the stats group STAT-GROUP3:
729+
You can apply the metric collection to a statistics group (`stats-group`). The following example includes the metrics in the PLATFORM_METRICS metric group in the statistics group STAT-GROUP3:
726730
727731
```
728732
cumulus@switch:~$ nv set system telemetry stats-group STAT-GROUP3 include-list PLATFORM_METRICS
729733
cumulus@switch:~$ nv config apply
730734
```
731735
736+
{{%notice note%}}
737+
The metric list under the statistics group overwrites the metric list under the global telemetry group.
738+
{{%/notice%}}
739+
732740
### Show Telemetry Export Configuration
733741
734742
To show the telemetry export configuration, run the `nv show system telemetry export` command:

0 commit comments

Comments
 (0)