DPDK  19.11.14-rc1
Functions
rte_telemetry.h File Reference
#include <stdint.h>

Go to the source code of this file.

Functions

__rte_experimental int32_t rte_telemetry_init (void)
 
__rte_experimental int32_t rte_telemetry_cleanup (void)
 
__rte_experimental int32_t rte_telemetry_selftest (void)
 

Detailed Description

RTE Telemetry.

Warning
EXPERIMENTAL: All functions in this file may be changed or removed without prior notice.

The telemetry library provides a method to retrieve statistics from DPDK by sending a JSON encoded message over a socket. DPDK will send a JSON encoded response containing telemetry data.

Definition in file rte_telemetry.h.

Function Documentation

◆ rte_telemetry_init()

__rte_experimental int32_t rte_telemetry_init ( void  )
Warning
EXPERIMENTAL: this API may change without prior notice

Initialize Telemetry

Returns
0 on successful initialisation.
-ENOMEM on memory allocation error
-EPERM on unknown error failure
-EALREADY if Telemetry is already initialised.

◆ rte_telemetry_cleanup()

__rte_experimental int32_t rte_telemetry_cleanup ( void  )
Warning
EXPERIMENTAL: this API may change without prior notice

Clean up and free memory.

Returns
0 on success
-EPERM on failure

◆ rte_telemetry_selftest()

__rte_experimental int32_t rte_telemetry_selftest ( void  )
Warning
EXPERIMENTAL: this API may change without prior notice

Runs various tests to ensure telemetry initialisation and register/unregister functions are working correctly.

Returns
0 on success when all tests have passed
-1 on failure when the test has failed