28. Metrics 庫

Metrics 庫實現(xiàn)了一個機制，通過這個機制，producers 可以發(fā)布numeric信息，供 consumers 后續(xù)查詢。
實際上，生產(chǎn)者通常是其他庫或者主進程，而消費者通常是應(yīng)用程序。

Metrics 本身是一個靜態(tài)值，并不是有PMD產(chǎn)生的。
Metric 信息是由推送模型填充的，其中生產(chǎn)者通過調(diào)用相關(guān)的更新函數(shù)來跟新metric庫中包含的值。
消費者通過查詢共享內(nèi)存中的metric數(shù)據(jù)來獲取metric信息。

對于每個mettic，為每個端口ID保留一個單獨的值，并且在發(fā)布metric時，生產(chǎn)者需要指定哪個端口正在更新。
此外，還有一個特殊的ID RTE_METRICS_GLOBAL， 用于全局統(tǒng)計，不與任何單個設(shè)備關(guān)聯(lián)。
由于metric庫是自包含的，因此，對端口號的唯一限制是他們小于 RTE_MAX_ETHPORTS，不需要實際端口存在。

28.1. 初始化庫

在使用庫之前，必須通過調(diào)用在共享內(nèi)存中設(shè)置mettic存儲的 rte_metrics_init() 來初始化它。
這也就是生產(chǎn)者將metric信息發(fā)布到哪里以及消費者從哪里查新metric信息。

rte_metrics_init(rte_socket_id());

這個初始化函數(shù)必須在主函數(shù)中調(diào)用，否則生產(chǎn)者和消費者可能在主程序或次進程中多次調(diào)用。？？

28.2. 注冊metrics

Metrics 必須先注冊，這是生產(chǎn)者聲明他們將要發(fā)布的metric的方式。注冊可以單獨完成，也可以將一組metric標(biāo)注為一個組。單獨注冊使用接口 rte_metrics_reg_name() 實現(xiàn)：

id_1 = rte_metrics_reg_name("mean_bits_in");
id_2 = rte_metrics_reg_name("mean_bits_out");
id_3 = rte_metrics_reg_name("peak_bits_in");
id_4 = rte_metrics_reg_name("peak_bits_out");

一組metric注冊使用 rte_metrics_reg_names() 完成：

const char * const names[] = {
    "mean_bits_in", "mean_bits_out",
    "peak_bits_in", "peak_bits_out",
};
id_set = rte_metrics_reg_names(&names[0], 4);

如果返回負數(shù)，表示注冊失敗。否則，返回值表示更新metic時使用的 key 值。可以使用 rte_metrics_get_names() 獲得將這些key值與metric名稱映射起來的映射表。

28.3. 更新 metric 值

一旦注冊，生產(chǎn)者可以使用 rte_metrics_update_value() 函數(shù)更新給定端口的metric。這個函數(shù)使用metric注冊時返回的key值，也可以使用 rte_metrics_get_names() 查找。

rte_metrics_update_value(port_id, id_1, values[0]);
rte_metrics_update_value(port_id, id_2, values[1]);
rte_metrics_update_value(port_id, id_3, values[2]);
rte_metrics_update_value(port_id, id_4, values[3]);

如果metric被注冊為一個集合，則可以使用 rte_metrics_update_value() 單獨更新他們，或者使用 rte_metrics_update_values() 一起更新：

rte_metrics_update_value(port_id, id_set, values[0]);
rte_metrics_update_value(port_id, id_set + 1, values[1]);
rte_metrics_update_value(port_id, id_set + 2, values[2]);
rte_metrics_update_value(port_id, id_set + 3, values[3]);

rte_metrics_update_values(port_id, id_set, values, 4);

注意，rte_metrics_update_values() 不能用來更新 multiple sets 的metric，因為不能保證兩個集合一個接一個地注冊了連續(xù)的ID值。

28.4. 查詢 metrics

消費者可以通過使用返回 struct rte_metric_value 數(shù)組的接口 rte_metrics_get_values() 來查詢metric庫。 該數(shù)組中的每個條目都包含一個metric值及其關(guān)聯(lián)的key。key值和名稱的映射可以使用 rte_metrics_get_names() 函數(shù)來獲得，該函數(shù)返回由key索引的 struct rte_metric_name 數(shù)組。以下將打印給定端口的所有metric：

void print_metrics() {
    struct rte_metric_name *names;
    int len;

    len = rte_metrics_get_names(NULL, 0);
    if (len < 0) {
        printf("Cannot get metrics count\n");
        return;
    }
    if (len == 0) {
        printf("No metrics to display (none have been registered)\n");
        return;
    }
    metrics = malloc(sizeof(struct rte_metric_value) * len);
    names =  malloc(sizeof(struct rte_metric_name) * len);
    if (metrics == NULL || names == NULL) {
        printf("Cannot allocate memory\n");
        free(metrics);
        free(names);
        return;
    }
    ret = rte_metrics_get_values(port_id, metrics, len);
    if (ret < 0 || ret > len) {
        printf("Cannot get metrics values\n");
        free(metrics);
        free(names);
        return;
    }
    printf("Metrics for port %i:\n", port_id);
    for (i = 0; i < len; i++)
        printf("  %s: %"PRIu64"\n",
            names[metrics[i].key].name, metrics[i].value);
    free(metrics);
    free(names);
}

28.5. Bit-rate 統(tǒng)計庫

Bit-rate 庫計算每個活動端口（即網(wǎng)絡(luò)設(shè)備）的指數(shù)加權(quán)平均值和峰值比特率。
這些統(tǒng)計信息通過metric庫使用以下名稱進行發(fā)布：

• mean_bits_in: 平均入站比特率
• mean_bits_out: 平均出站比特率
• ewma_bits_in: 平均入站比特率 (EWMA 平滑)
• ewma_bits_out: 平均出站比特率 (EWMA 平滑)
• peak_bits_in: 峰值入站比特率
• peak_bits_out: 峰值出站比特率

一旦初始化，并以適當(dāng)?shù)念l率計時，可以通過查詢metric庫來獲取metric值。

28.5.1. 初始化

在使用庫之前，必須通過接口 rte_stats_bitrate_create() 來初始化，這個函數(shù)返回一個bit-rate計算對象。由于bit-rate庫使用metric來報告計算的統(tǒng)計量，因此bit-rate庫需要將計算的統(tǒng)計量與metric庫一起注冊。這通過輔助函數(shù) rte_stats_bitrate_reg() 完成。

struct rte_stats_bitrates *bitrate_data;

bitrate_data = rte_stats_bitrate_create();
if (bitrate_data == NULL)
    rte_exit(EXIT_FAILURE, "Could not allocate bit-rate data.\n");
rte_stats_bitrate_reg(bitrate_data);

28.5.2. 控制采樣速率

由于庫通過定期采樣來工作，而不是使用內(nèi)部線程，應(yīng)用程序必須定期調(diào)用 rte_stats_bitrate_calc() 。 這個函數(shù)被調(diào)用的頻率應(yīng)該是計算統(tǒng)計所需要的預(yù)期采樣頻率。 例如，需要按秒統(tǒng)計，那么應(yīng)該每秒鐘調(diào)用一次這個函數(shù)。

tics_datum = rte_rdtsc();
tics_per_1sec = rte_get_timer_hz();

while( 1 ) {
    /* ... */
    tics_current = rte_rdtsc();
    if (tics_current - tics_datum >= tics_per_1sec) {
        /* Periodic bitrate calculation */
        for (idx_port = 0; idx_port < cnt_ports; idx_port++)
                rte_stats_bitrate_calc(bitrate_data, idx_port);
            tics_datum = tics_current;
        }
    /* ... */
}

28.6. 延遲統(tǒng)計庫

延遲統(tǒng)計庫計算DPDK應(yīng)用程序的數(shù)據(jù)包處理延遲，報告數(shù)據(jù)包處理所需的最小，平均和最大納秒，以及處理延遲中的抖動。使用以下名稱通過metric庫報告這些統(tǒng)計信息：

• min_latency_ns: 最小處理延遲（納秒）
• avg_latency_ns: 平均處理延遲（納秒）
• mac_latency_ns: 最大處理延遲（納秒）
• jitter_ns: 處理等待時間的變化（納秒）

一旦初始化并以適當(dāng)?shù)念l率采樣，可以通過查詢metric庫來獲得這些統(tǒng)計數(shù)據(jù)。

28.6.1. 初始化

使用庫之前，需要調(diào)用函數(shù) rte_latencystats_init() 進行初始化。

lcoreid_t latencystats_lcore_id = -1;

int ret = rte_latencystats_init(1, NULL);
if (ret)
    rte_exit(EXIT_FAILURE, "Could not allocate latency data.\n");

28.6.2. 觸發(fā)統(tǒng)計值更新

需要定期調(diào)用 rte_latencystats_update() 函數(shù)，以便更新延遲統(tǒng)計值信息。

if (latencystats_lcore_id == rte_lcore_id())
    rte_latencystats_update();

28.6.3. 關(guān)閉庫

完成之后，需要調(diào)用 rte_latencystats_uninit() 來關(guān)閉延遲統(tǒng)計庫。

rte_latencystats_uninit();