Difference between revisions of "Plugin:DPDK Telemetry"

From collectd Wiki
Jump to: navigation, search
m
 
Line 5: Line 5:
 
   | Callbacks={{Callback|init}}, {{Callback|read}}, {{Callback|config}}
 
   | Callbacks={{Callback|init}}, {{Callback|read}}, {{Callback|config}}
 
   | Status={{supported}}
 
   | Status={{supported}}
   | FirstVersion={{Version|5.9}}
+
   | FirstVersion={{Version|5.11}}
 
   | Copyright=''2019'' Intel Corporation
 
   | Copyright=''2019'' Intel Corporation
 
   | License={{MIT License}}
 
   | License={{MIT License}}

Latest revision as of 22:35, 21 September 2021

DPDK Telemetry plugin
Type: read
Callbacks: init, read, config
Status: supported
First version: 5.11
Copyright: 2019 Intel Corporation
License: MIT license
Manpage: collectd-dpdk_telemetry(5)
List of Plugins


The DPDK telemetry plugin collects interface, application and global statistics. It is used as a replacement for the dpdkstat plugin from the DPDK 19.08.

The plugin retrieves metrics from a DPDK packet forwarding application by sending the JSON formatted message via a UNIX domain socket. The DPDK telemetry component will respond with a JSON formatted reply, delivering the requested metrics. The plugin parses the JSON data, and publishes the metric values to collectd for further use.

Configuration options are documented in the collectd-dpdk_telemetry(5) manual page.


Synopsis

 LoadPlugin dpdk_telemetry
 <Plugin dpdk_telemetry>
   ClientSocketPath "/var/run/.client"
   DpdkSocketPath "/var/run/dpdk/rte/telemetry"
 </Plugin>

Parameters

Plugin configuration:

  • The plugin is disabled by default , so it should be enabled in collectd.config file  by uncommenting the line "#LoadPlugin dpdk_telemetry"
  • The  plugin uses below default socket paths for the client and the server, to use configuration other than default below has to be updated in collectd.conf file
   ClientSocketPath "/var/run/.client"
   DpdkSocketPath "/var/run/dpdk/rte/telemetry"

Metrics

Disclaimer: This is not a comprehensive list, this only contains the most common metrics and descriptions, The following metrics are taken from DPDK binded to a Fortville NIC, Different NIC's may show differences in these metrics and their metric names, however most NIC's will generally output similar information.


Metric

Data Type

Description

Comment

dpdk_telemetry-empty_poll

INT

The number of receive polls that l3fwd-power application did not receive any packets .


dpdk_telemetry-full_poll

INT

The number of receive polls that l3fwd-power application did receive the packets.



dpdk_telemetry-busy_percent

INT

How much % is the l3fwd-power application busy in receiving the packets.


dpdk_telemetry-rx_good_packets

INT

number of packets received by the port


dpdk_telemetry-tx_good_packets

INT

number of packets transmitted by the port


dpdk_telemetry-rx_good_bytes

INT

number of bytes received by the port


dpdk_telemetry-tx_good_bytes

INT

number of the bytes transmitted by port


dpdk_telemetry-rx_missed_errors

INT

Number of missed errors


dpdk_telemetry-rx_errors

INT

total number of errors that have been encountered for receive


dpdk_telemetry-tx_errors

INT

number of errors the port has encountered on transmit


dpdk_telemetry-rx_q0packets

INT

number of packets received on queue 0


dpdk_telemetry-rx_q0bytes

INT

number of bytes received on queue 0


dpdk_telemetry-rx_q0errors

INT

number of errors received on queue 0


dpdk_telemetry-tx_q0packets

INT

number of packets transmitted on queue 0


dpdk_telemetry-tx_q0bytes

INT

number of bytes transmitted on queue 0


dpdk_telemetry-tx_q1packets

INT

number of packets transmitted on queue 1


dpdk_telemetry-tx_q1bytes

INT

number of bytes transmitted on queue 1


dpdk_telemetry-tx_q2packets

INT

number of packets transmitted on queue 2


dpdk_telemetry-tx_q2bytes

INT

number of bytes transmitted on queue 2


dpdk_telemetry-mac_local_errors

INT

number of local faults in L1


dpdk_telemetry-mac_remote_errors

INT

number of remote faults in L1


dpdk_telemetry-tx_xon_packets

INT

number of xon packets the port has transmitted


dpdk_telemetry-rx_xon_packets

INT

number of xon packets the port has received


dpdk_telemetry-tx_xoff_packets

INT

number of xoff packets the port has transmitted


dpdk_telemetry-rx_xoff_packets

INT

number of xoff packets the port has received


dpdk_telemetry-rx_size_64_packets

INT

number of packets received that are 64 bytes in length


dpdk_telemetry-rx_size_65_to_127_packets

INT

number of packets received that are between 65 and 127 bytes (inclusive) in length


dpdk_telemetry-rx_size_128_to_255_packets

INT

number of packets received that are between 128 and 255 bytes (inclusive) in length


dpdk_telemetry-rx_size_256_to_511_packets

INT

number of packets received that are between 256 and 511 bytes (inclusive) in length


dpdk_telemetry-rx_size_512_to_1023_packets

INT

number of packets received that are between 512 and 1023 bytes (inclusive) in length


dpdk_telemetry-rx_size_1024_to_max_packets

INT

number of packets received that are between 1024 and 1522 bytes (inclusive) in length


dpdk_telemetry-rx_broadcast_packets

INT

number of broacast packets the driver has received


dpdk_telemetry-rx_multicast_packets

INT

number of multicast packets the port has received


dpdk_telemetry-rx_fragment_errors

INT

number of fragmented packets the port has received


dpdk_telemetry-rx_undersize_errors

INT

number of undersized packets the port has received


dpdk_telemetry-rx_oversize_errors

INT

number of oversized packets the port has received


dpdk_telemetry-rx_jabber_errors

INT

number of jabber packets the port has received


dpdk_telemetry-tx_size_64_packets

INT

number of packets transmitted that are 64 bytes in length


dpdk_telemetry-tx_size_65_to_127_packets

INT

number of packets transmitted that are between 65 and 127 bytes (inclusive) in length


dpdk_telemetry-tx_size_128_to_255_packets

INT

number of packets transmitted that are between 128 and 255 bytes (inclusive) in length


dpdk_telemetry-tx_size_256_to_511_packets

INT

number of packets transmitted that are between 256 and 511 bytes (inclusive) in length


dpdk_telemetry-tx_size_512_to_1023_packets

INT

number of packets transmitted that are between 512 and 1023 bytes (inclusive) in length


dpdk_telemetry-tx_size_1024_to_max_packets

INT

number of packets transmitted that are between 1024 and 1522 bytes (inclusive) in length


dpdk_telemetry-tx_multicast_packets

INT

number of multicast packets the port has transmitted


dpdk_telemetry-tx_broadcast_packets

INT

number of broadcast packets the tx has transmitted


dpdk_telemetry-rx_priority0_dropped

INT

number of incoming packets the driver has dropped for priority 0


dpdk_telemetry-rx_priority1_dropped

INT

number of incoming packets the driver has dropped for priority 1


dpdk_telemetry-rx_priority2_dropped

INT

number of incoming packets the driver has dropped for priority 2


dpdk_telemetry-rx_priority3_dropped

INT

number of incoming packets the driver has dropped for priority 3


dpdk_telemetry-rx_priority4_dropped

INT

number of incoming packets the driver has dropped for priority 4


dpdk_telemetry-rx_priority5_dropped

INT

number of incoming packets the driver has dropped for priority 5


dpdk_telemetry-rx_priority6_dropped

INT

number of incoming packets the driver has dropped for priority 6


dpdk_telemetry-rx_priority7_dropped

INT

number of incoming packets the driver has dropped for priority 7


dpdk_telemetry-rx_priority0_xon_packets

INT

number of xon packets the port has received for priority 0


dpdk_telemetry-rx_priority1_xon_packets

INT

number of xon packets the port has received for priority 1


dpdk_telemetry-rx_priority2_xon_packets

INT

number of xon packets the port has received for priority 2


dpdk_telemetry-rx_priority3_xon_packets

INT

number of xon packets the port has received for priority 3


dpdk_telemetry-rx_priority4_xon_packets

INT

number of xon packets the port has received for priority 4


dpdk_telemetry-rx_priority5_xon_packets

INT

number of xon packets the port has received for priority 5


dpdk_telemetry-rx_priority6_xon_packets

INT

number of xon packets the port has received for priority 6


dpdk_telemetry-rx_priority7_xon_packets

INT

number of xon packets the port has received for priority 7


dpdk_telemetry-rx_priority0_xoff_packets

INT

number of xoff packets the port has received for priority 0


dpdk_telemetry-rx_priority1_xoff_packets

INT

number of xoff packets the port has received for priority 1


dpdk_telemetry-rx_priority2_xoff_packets

INT

number of xoff packets the port has received for priority 2


dpdk_telemetry-rx_priority3_xoff_packets

INT

number of xoff packets the port has received for priority 3


dpdk_telemetry-rx_priority4_xoff_packets

INT

number of xoff packets the port has received for priority 4


dpdk_telemetry-rx_priority5_xoff_packets

INT

number of xoff packets the port has received for priority 5


dpdk_telemetry-rx_priority6_xoff_packets

INT

number of xoff packets the port has received for priority 6


dpdk_telemetry-rx_priority7_xoff_packets

INT

number of xoff packets the port has received for priority 7


dpdk_telemetry-tx_priority0_xon_packets

INT

number of xon packets the port has transmitted for priority 0


dpdk_telemetry-tx_priority1_xon_packets

INT

number of xon packets the port has transmitted for priority 1


dpdk_telemetry-tx_priority2_xon_packets

INT

number of xon packets the port has transmitted for priority 2


dpdk_telemetry-tx_priority3_xon_packets

INT

number of xon packets the port has transmitted for priority 3


dpdk_telemetry-tx_priority4_xon_packets

INT

number of xon packets the port has transmitted for priority 4


dpdk_telemetry-tx_priority5_xon_packets

INT

number of xon packets the port has transmitted for priority 5


dpdk_telemetry-tx_priority6_xon_packets

INT

number of xon packets the port has transmitted for priority 6


dpdk_telemetry-tx_priority7_xon_packets

INT

number of xon packets the port has transmitted for priority 7


dpdk_telemetry-tx_priority0_xoff_packets

INT

number of xoff packets the port has transmitted for priority 0


dpdk_telemetry-tx_priority1_xoff_packets

INT

number of xoff packets the port has transmitted for priority 1


dpdk_telemetry-tx_priority2_xoff_packets

INT

number of xoff packets the port has transmitted for priority 2


dpdk_telemetry-tx_priority3_xoff_packets

INT

number of xoff packets the port has transmitted for priority 3


dpdk_telemetry-tx_priority4_xoff_packets

INT

number of xoff packets the port has transmitted for priority 4


dpdk_telemetry-tx_priority5_xoff_packets

INT

number of xoff packets the port has transmitted for priority 5


dpdk_telemetry-tx_priority6_xoff_packets

INT

number of xoff packets the port has transmitted for priority 6


dpdk_telemetry-tx_priority7_xoff_packets

INT

number of xoff packets the port has transmitted for priority 7


dpdk_telemetry-tx_priority0_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 0


dpdk_telemetry-tx_priority1_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 1


dpdk_telemetry-tx_priority2_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 2


dpdk_telemetry-tx_priority3_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 3


dpdk_telemetry-tx_priority4_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 4


dpdk_telemetry-tx_priority5_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 5


dpdk_telemetry-tx_priority6_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 6


dpdk_telemetry-tx_priority7_xon_to_xoff_packets

INT

number of times a transition between xon to xoff has occurred for priority 7


Example graph

None yet. Add one now!

Dependencies

  • libjansson

History

The DPDK telemetry plugin has been available since version 5.11.

See also

DPDK Telemetry plugin tests DPDK Telemetry plugin overview