DOCA Flow Tune Server

本指南概述了 DOCA Flow Tune Server API 及其配置说明。

DOCA Flow Tune Server (TS) 是 DOCA Flow 的一个子组件，用于收集正在运行的 DOCA Flow 应用程序的预定义内部关键绩效指标 (KPI) 和管道信息。所有信息都通过进程间通信通道（Unix 域套接字）传输到 DOCA Flow Tune Tool 以进行进一步的分析和监控。

仅当使用 DOCA Flow 和 DOCA Flow Tune Server 跟踪库时，DOCA Flow Tune Server API 才可用。

DOCA Flow Tune Server 具有配置文件，允许自定义各种设置。配置文件分为不同的部分，以便于使用。

配置文件默认值

如果未提供配置文件，DOCA Flow Tune Server 将对其强制字段使用默认值。所有默认值的列表可以在“配置文件示例”部分中看到。

自定义配置文件

用户可以创建自己的文件，并使用 doca_flow_tune_server_cfg_set_cfg_file_path() API 调用来提供文件路径，而不是使用默认配置值。

一旦使用，DOCA Flow Tune Server 会直接从文件中加载所有提供的值，而其余字段（如果有）则使用各自的默认值。

配置文件示例

            

            
 {
	"network": {
		"uds_path": "/tmp/tune_server.sock"
	}
} 
        

• 网络

  • uds_path – Tune Server 要绑定的 Unix 域套接字 (AF_UNIX) 路径。此套接字用于 DOCA Flow Tune Server 和 DOCA Flow Tune Tool 之间的进程间通信 (IPC) 通道。默认值为 /tmp/tune_server.sock。

以下小节提供了有关库 API 的更多详细信息。

struct doca_flow_tune_server_cfg

要在配置 API 调用中使用的不透明配置结构。

doca_flow_tune_server_cfg_create

分配并创建 DOCA Flow Tune Server 配置结构。

            

            
doca_error_t doca_flow_tune_server_cfg_create(struct doca_flow_tune_server_cfg **cfg);
        

doca_flow_tune_server_cfg_set_cfg_file_path

在不透明配置结构中设置本地配置文件路径，供 DOCA Flow Tune Server 在搜索 JSON 配置文件时使用。

提供 JSON 配置文件是可选的。如果未提供文件，DOCA Flow Tune Server 将使用内部默认值。

            

            
doca_error_t doca_flow_tune_server_cfg_set_bind_path(struct doca_flow_tune_server_cfg *cfg, const char *path);
        

doca_flow_tune_server_cfg_destroy

销毁并释放 DOCA Flow Tune Server 不透明配置结构。

应在调用 doca_flow_tune_server_init() 后调用。

            

            
doca_error_t doca_flow_tune_server_cfg_destroy(struct doca_flow_tune_server_cfg *cfg);
        

doca_flow_tune_server_init

启动 DOCA Flow Tune Server 主线程。

            

            
doca_error_t doca_flow_tune_server_init(struct doca_flow_tune_server_cfg *cfg);
        

doca_flow_tune_server_destroy

停止 DOCA Flow Tune Server 主线程。

            

            
void doca_flow_tune_server_destroy(void);