X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ceph%2Fsrc%2Fspdk%2Fdpdk%2Fdoc%2Fguides%2Fhowto%2Ftelemetry.rst;fp=ceph%2Fsrc%2Fspdk%2Fdpdk%2Fdoc%2Fguides%2Fhowto%2Ftelemetry.rst;h=b4a34ed674684afabb0e243174f80984602b7675;hb=f67539c23b11f3b8a2ecaeeddf7a403ae1c442a8;hp=00f8f7a85c3d8499e408b45a3d6ad34a9935c690;hpb=64a4c04e6850c6d9086e4c37f57c4eada541b05e;p=ceph.git diff --git a/ceph/src/spdk/dpdk/doc/guides/howto/telemetry.rst b/ceph/src/spdk/dpdk/doc/guides/howto/telemetry.rst index 00f8f7a85..b4a34ed67 100644 --- a/ceph/src/spdk/dpdk/doc/guides/howto/telemetry.rst +++ b/ceph/src/spdk/dpdk/doc/guides/howto/telemetry.rst @@ -1,85 +1,80 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2018 Intel Corporation. + Copyright(c) 2020 Intel Corporation. -DPDK Telemetry API User Guide -============================== -This document describes how the Data Plane Development Kit(DPDK) Telemetry API -is used for querying port statistics from incoming traffic. +DPDK Telemetry User Guide +========================= -Introduction ------------- +The Telemetry library provides users with the ability to query DPDK for +telemetry information, currently including information such as ethdev stats, +ethdev port list, and eal parameters. -The ``librte_telemetry`` provides the functionality so that users may query -metrics from incoming port traffic. The application which initializes packet -forwarding will act as the server, sending metrics to the requesting application -which acts as the client. +.. Note:: -In DPDK, applications are used to initialize the ``telemetry``. To view incoming -traffic on featured ports, the application should be run first (ie. after ports -are configured). Once the application is running, the service assurance agent -(for example the collectd plugin) should be run to begin querying the API. + This library is experimental and the output format may change in the future. -A client connects their Service Assurance application to the DPDK application -via a UNIX socket. Once a connection is established, a client can send JSON -messages to the DPDK application requesting metrics via another UNIX client. -This request is then handled and parsed if valid. The response is then -formatted in JSON and sent back to the requesting client. -Pre-requisites -~~~~~~~~~~~~~~ +Telemetry Interface +------------------- -* Python >= 2.5 +The :doc:`../prog_guide/telemetry_lib` opens a socket with path +*/dpdk_telemetry.*. The version represents the +telemetry version, the latest is v2. For example, a client would connect to a +socket with path */var/run/dpdk/\*/dpdk_telemetry.v2* (when the primary process +is run by a root user). -* Jansson library for JSON serialization -Test Environment ----------------- +Telemetry Initialization +------------------------ -``telemetry`` offers a range of selftests that a client can run within -the DPDK application. +The library is enabled by default, however an EAL flag to enable the library +exists, to provide backward compatibility for the previous telemetry library +interface. -Selftests are disabled by default. They can be enabled by setting the 'selftest' -variable to 1 in rte_telemetry_initial_accept(). +.. code-block:: console -Note: this 'hardcoded' value is temporary. + --telemetry -Configuration -------------- +A flag exists to disable Telemetry also. -Enable the telemetry API by modifying the following config option before -building DPDK:: +.. code-block:: console - CONFIG_RTE_LIBRTE_TELEMETRY=y + --no-telemetry -Note: Meson will pick this up automatically if ``libjansson`` is available. -Running the Application ------------------------ +Running Telemetry +----------------- -The following steps demonstrate how to run the ``telemetry`` API to query all -statistics on all active ports, using the ``telemetry_client`` python script -to query. -Note: This guide assumes packet generation is applicable and the user is -testing with testpmd as a DPDK primary application to forward packets, although -any DPDK application is applicable. +The following steps show how to run an application with telemetry support, +and query information using the telemetry client python script. -#. Launch testpmd as the primary application with ``telemetry``.:: +#. Launch testpmd as the primary application with telemetry. - ./app/testpmd --telemetry + .. code-block:: console -#. Launch the ``telemetry`` python script with a client filepath.:: + ./app/dpdk-testpmd - python usertools/telemetry_client.py /var/run/some_client +#. Launch the telemetry client script. - The client filepath is going to be used to setup our UNIX connection with the - DPDK primary application, in this case ``testpmd`` - This will initialize a menu where a client can proceed to recursively query - statistics, request statistics once or unregister the file_path, thus exiting - the menu. + .. code-block:: console -#. Send traffic to any or all available ports from a traffic generator. - Select a query option(recursive or singular polling). - The metrics will then be displayed on the client terminal in JSON format. + python usertools/dpdk-telemetry.py -#. Once finished, unregister the client using the menu command. +#. When connected, the script displays the following, waiting for user input. + + .. code-block:: console + + Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2 + {"version": "DPDK 20.05.0-rc0", "pid": 60285, "max_output_len": 16384} + --> + +#. The user can now input commands to send across the socket, and receive the + response. + + .. code-block:: console + + --> / + {"/": ["/", "/eal/app_params", "/eal/params", "/ethdev/list", + "/ethdev/link_status", "/ethdev/xstats", "/help", "/info"]} + --> /ethdev/list + {"/ethdev/list": [0, 1]}