Telemetry
The nv unset commands remove the configuration you set with the equivalent nv set commands. This guide only describes an nv unset command if it differs from the nv set command.
nv set interface <interface-id> telemetry bw-gauge enable
Enables (on) and disables (off) bandwidth gauge to track bandwidth usage for the specified interface.
Cumulus Linux supports the bandwidth gauge option on the Spectrum-4 switch only.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1 telemetry bw-gauge enable on
nv set interface <interface-id> telemetry histogram counter counter-type <counter-type-id>
Configures the counter type you want to monitor. You can specify:
- Received packet counters (
rx-packet) - Transmitted packet counters (
tx-packet) - Received byte counters (
rx-byte) - Transmitted byte counters (
tx-byte) - CRC counters (
crc) - Layer 1 received byte counters (
l1-rx-byte). The byte count includes layer 1IPG bytes. - Layer 1 transmitted byte counters (
l1-tx-byte). The byte count includes layer 1IPG bytes.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<counter-type-id> |
The counter type you want to monitor: rx-packet,tx-packet, rx-byte, tx-byte, crc, l1-rx-byte, or l1-tx-byte. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-swp8 telemetry histogram counter counter-type rx-packet
nv set interface <interface-id> telemetry histogram counter counter-type <counter-type-id> threshold action log
Configures the switch to send log messages to the /var/log/syslog file when the number of counters reach a specified value (threshold value described below).
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<counter-type-id> |
The counter type you want to monitor: rx-packet,tx-packet, rx-byte, tx-byte, crc, l1-rx-byte, or l1-tx-byte. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-swp8 telemetry histogram counter counter-type rx-packet threshold action log
nv set interface <interface-id> telemetry histogram counter counter-type <counter-type-id> threshold value
Configures the number of counters to reach before the switch sends log messages to the /var/log/syslog file. You can specify a value between 1 and 4294967295.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<counter-type-id> |
The counter type you want to monitor: rx-packet,tx-packet, rx-byte, tx-byte, crc, l1-rx-byte, or l1-tx-byte. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-swp8 telemetry histogram counter counter-type rx-packet threshold value 5000
nv set interface <interface-id> telemetry histogram counter counter-type <counter-type-id> bin-min-boundary
Configures the minimum boundary size of the counter histogram for the specified interface. Adding this number to the size of the histogram produces the maximum boundary size. These values represent the range of queue lengths per bin. You can specify a value, which must be a multiple of 96, between 1 and 4294967295. The default minimum boundary size is 960 bytes.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<counter-type-id> |
The counter type you want to monitor: rx-packet,tx-packet, rx-byte, tx-byte, crc, l1-rx-byte, or l1-tx-byte. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-swp8 telemetry histogram counter counter-type tx-packet bin-min-boundary 960
nv set interface <interface-id> telemetry histogram counter counter-type <counter-type-id> histogram-size
Configures the size of the counter histogram for the specified interface. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. These values represent the range of queue lengths or counters per bin. You can specify a value, which must be a multiple of 96, between 1 and 4294967295. The default minimum boundary size is 960 bytes.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<counter-type-id> |
The counter type you want to monitor: rx-packet,tx-packet, rx-byte, tx-byte, crc, l1-rx-byte, or l1-tx-byte. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-swp8 telemetry histogram counter counter-type tx-packet histogram-size 12288
nv set interface <interface-id> telemetry histogram counter counter-type <counter-type-id> sample-interval
Configures the counter histogram sampling interval for the specified interface. You can specify a value between 128 and 1000000000. The default value is 1024 nanoseconds.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<counter-type-id> |
The counter type you want to monitor: rx-packet,tx-packet, rx-byte, tx-byte, crc, l1-rx-byte, or l1-tx-byte. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-swp8 telemetry histogram counter counter-type tx-packet sample-interval 1024
nv set interface <interface-id> telemetry histogram ingress-buffer priority-group <pg-id>
Configures the priority group you want to monitor for the specified interface.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<pg-id> |
The priority group you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram ingress-buffer priority-group 0
nv set interface <interface-id> telemetry histogram ingress-buffer priority-group <pg-id> bin-min-boundary
Configures the minimum boundary size of the ingress buffer histogram for the specified priority group and interface. Adding this number to the size of the histogram produces the maximum boundary size. These values represent the range of counters per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295. The default minimum boundary size is 960 bytes.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<pg-id> |
The priority group you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp9-16 telemetry histogram ingress-buffer priority-group 1 bin-min-boundary 768
nv set interface <interface-id> telemetry histogram ingress-buffer priority-group <pg-id> histogram-size
Configures the size of the ingress buffer histogram for the specified priority group and interface. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. These values represent the range of counters per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295. The default minimum boundary size is 960 bytes.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<pg-id> |
The priority group you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp9-16 telemetry histogram ingress-buffer priority-group 1 histogram-size 9600
nv set interface <interface-id> telemetry histogram ingress-buffer priority-group <pg-id> sample-interval
Configures the ingress buffer histogram sampling interval for the specified priority group and interface. You can specify a value between 128 and 1000000000. The default value is 1024 nanoseconds.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<pg-id> |
The priority group you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp9-16 telemetry histogram ingress-buffer priority-group 1 sample-interval 204
nv set interface <interface-id> telemetry histogram ingress-buffer priority-group <pg-id> threshold action log
Configures the switch to send log messages to the /var/log/syslog file when the ingress queue length for the specified priority group and interface reaches a specified value (threshold value described below).
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<pg-id> |
The priority group you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp9-swp16 telemetry histogram ingress-buffer priority-group 1 threshold action log
nv set interface <interface-id> telemetry histogram ingress-buffer priority-group <if-pg-id> threshold value
Configures the ingress queue length to reach for the specified priority group and interface before the switch sends log messages to the /var/log/syslog file. You can specify a value between 96 and 4294967295.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<pg-id> |
The priority group you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp9-swp16 telemetry histogram ingress-buffer priority-group 1 threshold value 5000
nv set interface <interface-id> telemetry histogram egress-buffer traffic-class <tc-id>
Configures the egress-buffer traffic class you want to monitor.
Traffic class 0 through 7 is for unicast traffic and traffic class 8 through 15 is for multicast traffic.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram egress-buffer traffic-class 0
nv set interface <interface-id> telemetry histogram egress-buffer traffic-class <tc-id> bin-min-boundary
Configures the minimum boundary size of the egress-buffer histogram for the specified traffic class and interface. Adding this number to the size of the histogram produces the maximum boundary size. These values represent the range of queue lengths per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295. The default minimum boundary size is 960 bytes.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram egress-buffer traffic-class 0 bin-min-boundary 768
nv set interface <interface-id> telemetry histogram egress-buffer traffic-class <tc-id> histogram-size
Configures the size of the egress buffer histogram for the specified traffic class and interface. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. These values represent the range of queue lengths per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram egress-buffer traffic-class 0 histogram-size 9600
nv set interface <interface-id> telemetry histogram egress-buffer traffic-class <tc-id> sample-interval
Configures the egress buffer histogram sampling interval for the specified traffic class and interface. You can specify a value between 128 and 1000000000. The default value is 1024 nanoseconds.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram egress-buffer traffic-class 0 sample-interval 2048
nv set interface <interface-id> telemetry histogram egress-buffer traffic-class <tc-id> threshold action log
Configures the switch to send log messages to the /var/log/syslog file when the egress queue length for the specified traffic class reaches a specified value (threshold value described below).
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram egress-buffer traffic-class 0 threshold action log
nv set interface <interface-id> telemetry histogram egress-buffer traffic-class <tc-id> threshold value
Configures the egress queue length to reach for the specified traffic class before the switch sends log messages to the /var/log/syslog file. You can specify a value between 96 and 4294967295.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram egress-buffer traffic-class 0 threshold value 5000
nv set interface <interface-id> telemetry histogram latency traffic-class <tc-id>
Enables the latency histogram for the specified traffic class on the specified interfaces.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram latency traffic-class 2
nv set interface <interface-id> telemetry histogram latency traffic-class <tc-id> threshold action log
Configures the switch to send a message to the /var/log/syslog file after packet latency for the specified traffic class on the specified interfaces reaches the set threshold.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram latency traffic-class 0 threshold action log
nv set interface <interface-id> telemetry histogram latency traffic-class <tc-id> threshold value
Configures the threshold (in nannoseconds) after which the switch sends a message to the /var/log/syslog file.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set interface swp1-8 telemetry histogram latency traffic-class 0 threshold action log
nv set interface <interface-id> telemetry histogram latency traffic-class <tc-id> bin-min-boundary
Configures the minimum boundary for the latency histogram for the specified traffic class on the specified interfaces.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set interface swp9-16 telemetry histogram latency traffic-class 1 bin-min-boundary 768
nv set interface <interface-id> telemetry histogram latency traffic-class <tc-id> histogram-size
Configures the size of the latency histogram for the specified traffic class on the specified interfaces.
Command Syntax
| Syntax | Description |
|---|---|
<interface-id> |
The interface you want to configure. |
<tc-id> |
The traffic class you want to monitor. |
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set interface swp9-16 telemetry histogram latency traffic-class 1 histogram-size 9600
nv set system telemetry export otlp state
Enables and disables open telemetry export so that you can export interface counters and histogram collection data to an external collector. You can specify enabled or disabled.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry export otlp state enabled
nv set system telemetry hft profile <profile-id> counter
Configures the type of data you want to collect for the high frequency telemetry profile. You can specify tx-byte, rx-byte, or tc-occupancy. The standard profile collects all three data types.
- Cumulus Linux supports high frequency telemetry on Spectrum-4 switches only.
- Cumulus Linux does not support high frequency telemetry on ports using 8 lanes. On the Spectrum-4 switch, swp1 through swp64 use all 8 lanes; to run high frequency telemetry, you must break out these ports.
- To correlate counters from different switches, the switches must have the same time (Cumulus Linux adds timestamps in the metadata of the counters it collects). You can use either NTP or PTP; however, NVIDIA recommends using PTP because the timestamp is accurate between switches in the fabric at the microsecond level.
- The collected data is available on the switch until you trigger the next data collection job or until you reboot the switch.
Command Syntax
| Syntax | Description |
|---|---|
<profile-id> |
The name of the profile. High frequency telemetry uses profiles for data collection. A profile is a set of configurations. Cumulus Linux provides a default profile called standard. You can create a maximum of four new profiles (four profiles in addition to the default profile). |
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry hft profile profile1 counter tc-occupancy
You must specify the nv set system telemetry hft profile <profile-id> counter command for each data type you want to collect; For example:
cumulus@switch:~$ nv set system telemetry hft profile profile1 counter tx-byte
cumulus@switch:~$ nv set system telemetry hft profile profile1 counter rx-byte
nv set system telemetry hft profile <profile-id> sample-interval
Configures the high frequency telemetry sampling interval in microseconds for the profile. You can specify a value between 100 and 12750. The value must be a multiple of 50. The default value is 5000 microseconds (30 seconds).
- Cumulus Linux supports high frequency telemetry on Spectrum-4 switches only.
- Cumulus Linux does not support high frequency telemetry on ports using 8 lanes. On the Spectrum-4 switch, swp1 through swp64 use all 8 lanes; to run high frequency telemetry, you must break out these ports.
- To correlate counters from different switches, the switches must have the same time (Cumulus Linux adds timestamps in the metadata of the counters it collects). You can use either NTP or PTP; however, NVIDIA recommends using PTP because the timestamp is accurate between switches in the fabric at the microsecond level.
- The collected data is available on the switch until you trigger the next data collection job or until you reboot the switch.
Command Syntax
| Syntax | Description |
|---|---|
<profile-id> |
The name of the profile. High frequency telemetry uses profiles for data collection. A profile is a set of configurations. Cumulus Linux provides a default profile called standard. You can create a maximum of four new profiles (four profiles in addition to the default profile). |
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry hft profile profile1 sample-interval 1000
nv set system telemetry hft profile <profile-id> traffic-class
Sets the high frequency telemetry egress queue priorities (traffic class 0-15) for the profile if the data types you want to collect include current traffic class buffer occupancy. The standard profile setting is 3.
Use commas (no spaces) to separate the list of traffic classes. For example, to set traffic class 1, 3, and 6, specify 1,3,6.
Command Syntax
| Syntax | Description |
|---|---|
<profile-id> |
The name of the profile. High frequency telemetry uses profiles for data collection. A profile is a set of configurations. Cumulus Linux provides a default profile called standard. You can create a maximum of four new profiles (four profiles in addition to the default profile). |
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry hft profile profile1 traffic-class 0,3,7
nv set system telemetry hft target local
Configures the switch to save the collected data locally in the /var/run/cumulus/hft directory. You can then export the json file to an external location with NVUE commands (or the API). The json file includes the data for each sampling interval and a timestamp showing when the data was collected.
- Cumulus Linux supports high frequency telemetry on Spectrum-4 switches only.
- Cumulus Linux does not support high frequency telemetry on ports using 8 lanes. On the Spectrum-4 switch, swp1 through swp64 use all 8 lanes; to run high frequency telemetry, you must break out these ports.
- To correlate counters from different switches, the switches must have the same time (Cumulus Linux adds timestamps in the metadata of the counters it collects). You can use either NTP or PTP; however, NVIDIA recommends using PTP because the timestamp is accurate between switches in the fabric at the microsecond level.
- The collected data is available on the switch until you trigger the next data collection job or until you reboot the switch.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry hft target local
nv set system telemetry hft profile <profile-id> traffic-class
Configures the egress queue priorities (traffic class 0 through 15) for the high frequency telemetry profile. The standard profile setting is 3.
- Cumulus Linux supports high frequency telemetry on Spectrum-4 switches only.
- Cumulus Linux does not support high frequency telemetry on ports using 8 lanes. On the Spectrum-4 switch, swp1 through swp64 use all 8 lanes; to run high frequency telemetry, you must break out these ports.
- To correlate counters from different switches, the switches must have the same time (Cumulus Linux adds timestamps in the metadata of the counters it collects). You can use either NTP or PTP; however, NVIDIA recommends using PTP because the timestamp is accurate between switches in the fabric at the microsecond level.
- The collected data is available on the switch until you trigger the next data collection job or until you reboot the switch.
Command Syntax
| Syntax | Description |
|---|---|
<profile-id> |
The name of the profile. High frequency telemetry uses profiles for data collection. A profile is a set of configurations. Cumulus Linux provides a default profile called standard. You can create a maximum of four new profiles (four profiles in addition to the default profile). |
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry hft profile profile1 traffic-class 0,3,7
nv set system telemetry histogram counter bin-min-boundary
Configures the minimum boundary size of the counter histograms. Adding this number to the size of the histogram produces the maximum boundary size. These values represent the number of counters per bin. You can specify a value, which must be a multiple of 96, between 1 and 4294967295. The default minimum boundary size is 960 bytes.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram counter bin-min-boundary.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram counter bin-min-boundary 5000
nv set system telemetry histogram counter histogram-size
Configures the size of the counter buffer histogram for the specified traffic class and interface. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. These values represent the number of counters per bin. You can specify a value, which must be a multiple of 96, between 1 and 4294967295.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram counter histogram-size.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram counter histogram-size 12288
nv set system telemetry histogram counter sample-interval
Configures the counter histogram sampling interval. You can specify a value between 128 and 1000000000. The default value is 1024 nanoseconds.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram counter sample-interval.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram counter sample-interval 1024
nv set system telemetry histogram egress-buffer bin-min-boundary
Configures the minimum boundary size of the egress queue histograms. Adding this number to the size of the histogram produces the maximum boundary size. These values represent the range of egress queues per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295. The default minimum boundary size is 960 bytes.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram egress-buffer bin-min-boundary.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram egress-buffer bin-min-boundary
nv set system telemetry histogram egress-buffer histogram-size
Configures the size of the egress queue histogram. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. These values represent the range of egress queues per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram egress-buffer histogram-size.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram egress-buffer histogram-size 12288
nv set system telemetry histogram egress-buffer sample-interval
Configures the egress queue histogram sampling interval. You can specify a value between 128 and 1000000000. The default value is 1024 nanoseconds.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram egress-buffer sample-interval.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram egress-buffer sample-interval 1024
nv set system telemetry export otlp grpc insecure
Enables and disables insecure mode for gRPC connections for telemetry. By default, OTLP export is in secure mode that requires a certificate. For connections without a configured certificate, you must enable insecure mode. You can specify enabled or disabled.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry export otlp grpc insecure enabled
nv set system telemetry export otlp grpc cert-id <certificate>
Configures an X.509 certificate to secure the gRPC connection for telemetry export.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
Command Syntax
| Syntax | Description |
|---|---|
<certificate> |
The X.509 certificate. |
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry export otlp grpc cert-id <certificate>
nv set system telemetry export otlp grpc destination <destination> port <port-id>
Configures open telemetry export to use gRPC to communicate with the collector. You must provide the collector destination IP address or hostname. Specify the port to use for communication if it is different from the default port 8443.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
Command Syntax
| Syntax | Description |
|---|---|
<destination> |
The IP address of the collector. |
<port-id> |
The port number (if different from the default port 8443). |
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry export otlp grpc destination 10.1.1.100 port 4317
nv set system telemetry histogram export state enabled
Enables or disables open telemetry export for histogram collection. You can specify enabled or disabled.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
- When you enable open telemetry export for histogram data, your histogram collection configuration defines the data that the switch exports.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry histogram export state enabled
nv set system telemetry histogram ingress-buffer bin-min-boundary
Configures the minimum boundary size of the ingress queue histograms. Adding this number to the size of the histogram produces the maximum boundary size. These values represent the range of ingress queues per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295. The default minimum boundary size is 960 bytes.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram ingress-buffer bin-min-boundary.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram ingress-buffer bin-min-boundary 5000
nv set system telemetry histogram ingress-buffer histogram-size
Configures the size of the ingress queue histogram. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. These values represent the range of ingress queues per bin. You can specify a value, which must be a multiple of 96, between 96 and 4294967295.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram ingress-buffer histogram-size.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram ingress-buffer histogram-size 12288
nv set system telemetry histogram ingress-buffer sample-interval
Configures the ingress queue histogram sampling interval. You can specify a value between 128 and 1000000000. The default value is 1024 nanoseconds.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram ingress-buffer sample-interval.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry histogram ingress-buffer sample-interval 1024
nv set system telemetry interface-stats egress-buffer traffic-class
Configures the egress buffer traffic class for open telemetry export for interface statistics.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry interface-stats egress-buffer traffic-class 0
nv set system telemetry interface-stats ingress-buffer priority-group
Configures the ingress buffer priority group for open telemetry export for interface statistics. You can set a value between 0 and 7.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry interface-stats ingress-buffer priority-group 3
nv set system telemetry interface-stats export state
Enables and disables open telemetry export for interface statistics. You can specify enabled or disabled.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
- When you enable open telemetry export for interface statistics, the switch exports counters on all interfaces.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry interface-stats export state enabled
nv set system telemetry interface-stats sample-interval
Configures the interface statistics sample interval for open telemetry export. You can specify a value between 1 and 86400. The default value is 1.
- Cumulus Linux supports open telemetry export on switches with the Spectrum-4 ASIC only in Cumulus Linux 5.10.0 and later.
- Open telemetry export is a beta feature in Cumulus Linux 5.10.0.
- When you enable open telemetry export for interface statistics, the switch exports counters on all interfaces.
Version History
Introduced in Cumulus Linux 5.10.0
Example
cumulus@switch:~$ nv set system telemetry interface-stats sample-interval 100
nv set system telemetry histogram latency bin-min-boundary
Configures the global minimum boundary size of the latency histogram. Adding this number to the size of the histogram produces the maximum boundary size. You can specify a value, which must be a multiple of 96, between 96 and 4294967295. The default minimum boundary size is 960 bytes.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram latency bin-min-boundary.
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set system telemetry histogram latency bin-min-boundary 960
nv set system telemetry histogram latency histogram-size
Configures the global latency histogram size. Adding this number to the minimum boundary size of the histogram produces the maximum boundary size. You can specify a value, which must be a multiple of 96, between 96 and 4294967295.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry histogram latency histogram-size.
Version History
Introduced in Cumulus Linux 5.9.0
Example
cumulus@switch:~$ nv set system telemetry histogram latency histogram-size 12288
nv set system telemetry snapshot-file count
Configures the number of snapshots you can create before Cumulus Linux overwrites the first snapshot file. For example, if you set the snapshot file count to 30, the first snapshot file is histogram_stats_0 and the thirtieth snapshot is histogram_stats_30. After the thirtieth snapshot, Cumulus Linux overwrites the original snapshot file (histogram_stats_0) and the sequence restarts. The default value is 64.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry snapshot-file count.
You can specify a value between 3 and 100.
Snapshots provide you with more data; however, they can occupy a lot of disk space on the switch. To reduce disk usage, you can use a volatile partition for the snapshot files; for example, /var/run/cumulus/histogram_stats.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry snapshot-file count 10
nv set system telemetry snapshot-file name <value>
Configures the snapshot file name and location. The default location and file name is /var/lib/cumulus/histogram_stats.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry snapshot-file name.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry snapshot-file name /var/lib/cumulus/histogram_stats
nv set system telemetry snapshot-interval
Configures how often to write to a snapshot file. You can specify a value between 1 and 604800. The default value is 1 second.
In Cumulus Linux 5.9 and earlier, this command is nv set service telemetry snapshot-interval.
Version History
Introduced in Cumulus Linux 5.7.0
Example
cumulus@switch:~$ nv set system telemetry snapshot-interval 5
nv set system telemetry snapshot port-group
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group all-packet-pg
nv set system telemetry snapshot port-group <port-group-id>snapshot-file name
Configures the name of the snapshot file for all interface packet and buffer statistics.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group all-packet-pg snapshot-file name /var/run/cumulus/all_packet_stats1
nv set system telemetry snapshot port-group <port-group-id>snapshot-file count
Configures the number of snapshots that you can create before the first snapshot file is overwritten.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group all-packet-pg snapshot-file count 80
nv set system telemetry snapshot port-group <port-group-id>threshold <threshold-stats-id> value
Configures the threshold value for the statistics type; packet-congestion-drops or packet-error-drops.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
<threshold-stats-id> |
The type of threshold statistics; packet-congestion-drops or packet-error-drops. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group all-packet-pg threshold packet-error-drops value 100
nv set system telemetry snapshot port-group <port-group-id>threshold <threshold-stats-id> action log
Configures the action to log for the statistics type; packet-congestion-drops or packet-error-drops.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
<threshold-stats-id> |
The type of threshold statistics; packet-congestion-drops or packet-error-drops. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group all-packet-pg threshold packet-error-drops action log
nv set system telemetry snapshot port-group <port-group-id>threshold <threshold-stats-id> action collect port-group
Configures the action to collect information for the port group statistics type; packet-congestion-drops or packet-error-drops.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
<threshold-stats-id> |
The type of threshold statistics; packet-congestion-drops or packet-error-drops. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group all-packet-pg threshold packet-error-drops action collect port-group
nv set system telemetry snapshot port-group <port-group-id>stats-type
Configures the type of packet and buffer statistics you want to collect. You can collect the following data types:
- All, good, and dropped packets, and the ingress and egress queue occupancy (
packet-all) - All and good packets (
packet) - All, good, and dropped packets (
packet-extended) - Ingress and egress queue occupancy (
buffer)
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group packet-all-pg stats-type packet
nv set system telemetry snapshot port-group <port-group-id>interface <interface-id>
Configures the interfaces on which you want to monitor interface and buffer statistics. Specify all to monitor all interfaces.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
interface-id> |
The name of the interface. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group packet-all-pg interface all
nv set system telemetry snapshot port-group <port-group-id>timer-interval
Configures the interval timer (how often to send the interface statistics to the snapshot file). There is no default value for this setting. If you do not configure this setting, you must configure the collect action. You also have the option to send a message to the /var/log/syslog file.
Command Syntax
| Syntax | Description |
|---|---|
<port-group-id> |
The port group ID. |
Version History
Introduced in Cumulus Linux 5.11.0
Example
cumulus@switch:~$ nv set system telemetry snapshot port-group packet-all-pg timer-interval 15