1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2020 Intel Corporation.
5 DPDK Telemetry User Guide
6 =========================
8 The Telemetry library provides users with the ability to query DPDK for
9 telemetry information, currently including information such as ethdev stats,
10 ethdev port list, and eal parameters.
14 This library is experimental and the output format may change in the future.
20 The :doc:`../prog_guide/telemetry_lib` opens a socket with path
21 *<runtime_directory>/dpdk_telemetry.<version>*. The version represents the
22 telemetry version, the latest is v2. For example, a client would connect to a
23 socket with path */var/run/dpdk/\*/dpdk_telemetry.v2* (when the primary process
24 is run by a root user).
27 Telemetry Initialization
28 ------------------------
30 The library is enabled by default, however an EAL flag to enable the library
31 exists, to provide backward compatibility for the previous telemetry library
34 .. code-block:: console
38 A flag exists to disable Telemetry also.
40 .. code-block:: console
48 The following steps show how to run an application with telemetry support,
49 and query information using the telemetry client python script.
51 #. Launch testpmd as the primary application with telemetry.
53 .. code-block:: console
57 #. Launch the telemetry client script.
59 .. code-block:: console
61 python usertools/dpdk-telemetry.py
63 #. When connected, the script displays the following, waiting for user input.
65 .. code-block:: console
67 Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
68 {"version": "DPDK 20.05.0-rc0", "pid": 60285, "max_output_len": 16384}
71 #. The user can now input commands to send across the socket, and receive the
74 .. code-block:: console
77 {"/": ["/", "/eal/app_params", "/eal/params", "/ethdev/list",
78 "/ethdev/link_status", "/ethdev/xstats", "/help", "/info"]}
80 {"/ethdev/list": [0, 1]}