Skip to content

Openmetric stats improvements #617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
maxime-leroy wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Openmetric stats improvements #617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
07abbee
iface: add id and mac labels to metrics
maxime-leroy May 11, 2026
d27c0e7
iface: add speed metric
maxime-leroy May 11, 2026
74cdf4c
port: expose hardware rx errors as a metric
maxime-leroy May 11, 2026
a52f1c7
iface: emit vrf name instead of vrf_id in metric label
maxime-leroy May 11, 2026
53372c5
vlan: expose parent as a metric label
maxime-leroy May 11, 2026
04a531a
port: expose hardware rx/tx byte counters
maxime-leroy May 18, 2026
31346bc
rxtx: generalize iface stats accumulator macros
maxime-leroy May 20, 2026
467c644
iface: count parent port stats on vlan demux
maxime-leroy May 20, 2026
a8ba60d
port: expose hardware xstats as iface_port_xstat label series
maxime-leroy May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions modules/infra/api/iface.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#include "module.h"

#include <gr_infra.h>
#include <gr_net_types.h>
#include <gr_string.h>

static struct gr_iface *iface_to_api(const struct iface *priv) {
Expand Down Expand Up @@ -235,17 +236,22 @@ METRIC_COUNTER(
);
METRIC_COUNTER(m_cp_tx_bytes, "iface_cp_tx_bytes", "Number of bytes transmitted by control plane.");

METRIC_GAUGE(m_speed_bps, "iface_speed_bps", "Interface speed in bits per second.");

static void iface_metrics_collect(struct metrics_writer *w) {
struct iface *iface = NULL;
struct metrics_ctx ctx;
char vrf[16];

while ((iface = iface_next(GR_IFACE_TYPE_UNDEF, iface)) != NULL) {
const struct iface_type *type = iface_type_get(iface->type);
char id_str[8];

snprintf(id_str, sizeof(id_str), "%u", iface->id);
metrics_ctx_init(
&ctx,
w,
"id",
id_str,
"name",
iface->name,
"type",
Expand All @@ -258,15 +264,25 @@ static void iface_metrics_collect(struct metrics_writer *w) {
);

if (iface->mode == GR_IFACE_MODE_VRF) {
snprintf(vrf, sizeof(vrf), "%u", iface->vrf_id);
metrics_labels_add(&ctx, "vrf", vrf, NULL);
const struct iface *vrf_iface = iface_from_id(iface->vrf_id);
metrics_labels_add(
&ctx, "vrf", vrf_iface ? vrf_iface->name : "[deleted]", NULL
);
} else {
const struct iface *domain = iface_from_id(iface->domain_id);
metrics_labels_add(
&ctx, "domain", domain ? domain->name : "[deleted]", NULL
);
}

// Attach the MAC as a label so the address is reported on
// every per-iface metric without requiring a separate API call.
struct rte_ether_addr mac_addr = {0};
char mac_str[18] = "00:00:00:00:00:00";
if (iface_get_eth_addr(iface, &mac_addr) == 0)
snprintf(mac_str, sizeof(mac_str), ETH_F, &mac_addr);
Comment thread
maxime-leroy marked this conversation as resolved.
metrics_labels_add(&ctx, "mac", mac_str, NULL);

metric_emit(&ctx, &m_up, !!(iface->flags & GR_IFACE_F_UP));
metric_emit(&ctx, &m_running, !!(iface->state & GR_IFACE_S_RUNNING));
metric_emit(&ctx, &m_mtu, iface->mtu);
Expand Down Expand Up @@ -297,6 +313,10 @@ static void iface_metrics_collect(struct metrics_writer *w) {
metric_emit(&ctx, &m_cp_tx_packets, cp_tx_pkts);
metric_emit(&ctx, &m_cp_tx_bytes, cp_tx_bytes);

// gr_iface.speed is in Megabit/sec; convert to bit/sec for
// the metric. 0 means unknown / link down.
metric_emit(&ctx, &m_speed_bps, (uint64_t)iface->speed * 1000000ULL);
Comment on lines +317 to +318
Copy link
Copy Markdown
Collaborator

@rjarry rjarry May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be checked, but I think "unknown" is UINT32_MAX.


// Dispatch to type-specific collector
if (type->metrics_collect != NULL)
type->metrics_collect(&ctx, iface);
Expand Down
42 changes: 42 additions & 0 deletions modules/infra/control/port.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,44 @@ METRIC_GAUGE(m_txqs, "iface_port_txqs", "Number of TX queues.");
METRIC_GAUGE(m_rxq_size, "iface_port_rxq_size", "Number of descriptors in RX queues.");
METRIC_GAUGE(m_txq_size, "iface_port_txq_size", "Number of descriptors in TX queues.");
METRIC_COUNTER(m_rx_missed, "iface_port_rx_missed", "Number of packets dropped by HW.");
METRIC_COUNTER(m_rx_errors, "iface_port_rx_errors", "Number of RX packets with errors.");
Copy link
Copy Markdown
Collaborator

@rjarry rjarry May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps also add iface_port_rx_nobuf --> stats.rx_nombuf

METRIC_COUNTER(m_tx_errors, "iface_port_tx_errors", "Number of TX failures.");
METRIC_COUNTER(m_port_rx_bytes, "iface_port_rx_bytes", "Number of bytes received by HW.");
Copy link
Copy Markdown
Collaborator

@rjarry rjarry May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already covered by the generic software interface stats.

METRIC_COUNTER(m_port_tx_bytes, "iface_port_tx_bytes", "Number of bytes transmitted by HW.");
METRIC_COUNTER(
m_port_xstat,
"iface_port_xstat",
"Raw PMD extended statistic. The xstat label carries the driver-native counter name."
);

static void port_xstats_emit(struct metrics_ctx *ctx, uint16_t port_id) {
int n = rte_eth_xstats_get_names(port_id, NULL, 0);
if (n <= 0)
return;

struct rte_eth_xstat_name *names = calloc(n, sizeof(*names));
struct rte_eth_xstat *values = calloc(n, sizeof(*values));
if (names == NULL || values == NULL)
goto out;

if (rte_eth_xstats_get_names(port_id, names, n) != n)
goto out;
if (rte_eth_xstats_get(port_id, values, n) != n)
goto out;

// Save the base label set; rewind it between iterations so each emit
// replaces (not appends) the xstat label.
size_t base_len = ctx->labels_len;
for (int i = 0; i < n; i++) {
ctx->labels_len = base_len;
metrics_labels_add(ctx, "xstat", names[i].name, NULL);
metric_emit(ctx, &m_port_xstat, values[i].value);
}
ctx->labels_len = base_len;
out:
free(names);
free(values);
}

static void port_metrics_collect(struct metrics_ctx *ctx, const struct iface *iface) {
const struct iface_info_port *port = iface_info_port(iface);
Expand All @@ -765,8 +802,13 @@ static void port_metrics_collect(struct metrics_ctx *ctx, const struct iface *if

if (rte_eth_stats_get(port->port_id, &stats) == 0) {
metric_emit(ctx, &m_rx_missed, stats.imissed);
metric_emit(ctx, &m_rx_errors, stats.ierrors);
metric_emit(ctx, &m_tx_errors, stats.oerrors);
metric_emit(ctx, &m_port_rx_bytes, stats.ibytes);
metric_emit(ctx, &m_port_tx_bytes, stats.obytes);
}

port_xstats_emit(ctx, port->port_id);
}

static struct event *link_event;
Expand Down
9 changes: 9 additions & 0 deletions modules/infra/control/vlan.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include "event.h"
#include "iface.h"
#include "log.h"
#include "metrics.h"
#include "module.h"
#include "rcu.h"
#include "vlan.h"
Expand Down Expand Up @@ -228,6 +229,13 @@ static void vlan_to_api(void *info, const struct iface *iface) {
*api = vlan->base;
}

static void vlan_metrics_collect(struct metrics_ctx *ctx, const struct iface *iface) {
const struct iface_info_vlan *vlan = iface_info_vlan(iface);
const struct iface *parent = iface_from_id(vlan->parent_id);

metrics_labels_add(ctx, "parent", parent ? parent->name : "[deleted]", NULL);
Copy link
Copy Markdown
Collaborator

@rjarry rjarry May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a vlan-specific metric for VLAN ID.

}

static const struct iface_type iface_type_vlan = {
.id = GR_IFACE_TYPE_VLAN,
.pub_size = sizeof(struct gr_iface_info_vlan),
Expand All @@ -242,6 +250,7 @@ static const struct iface_type iface_type_vlan = {
.del_eth_addr = iface_vlan_del_eth_addr,
.set_promisc = iface_vlan_promisc_set,
.to_api = vlan_to_api,
.metrics_collect = vlan_metrics_collect,
};

static void vlan_init(struct event_base *) {
Expand Down
6 changes: 3 additions & 3 deletions modules/infra/datapath/bond_output.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ bond_output_process(struct rte_graph *graph, struct rte_node *node, void **objs,
const struct iface *member;
rte_edge_t edge;

IFACE_STATS_VARS(tx);
IFACE_STATS_VARS(tx, self);

for (unsigned i = 0; i < nb_objs; i++) {
struct rte_mbuf *mbuf = objs[i];
Expand All @@ -224,14 +224,14 @@ bond_output_process(struct rte_graph *graph, struct rte_node *node, void **objs,
t->member_iface_id = member->id;
}

IFACE_STATS_INC(tx, mbuf, member);
IFACE_STATS_INC(tx, self, mbuf, member);

edge = PORT_OUTPUT;
next:
rte_node_enqueue_x1(graph, node, edge, mbuf);
}

IFACE_STATS_FLUSH(tx);
IFACE_STATS_FLUSH(tx, self);

return nb_objs;
}
Expand Down
12 changes: 9 additions & 3 deletions modules/infra/datapath/iface_input.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,14 @@ static uint16_t
iface_input_process(struct rte_graph *graph, struct rte_node *node, void **objs, uint16_t nb_objs) {
uint16_t last_iface_id, last_vlan_id;
const struct iface *vlan_iface;
const struct iface *parent_iface;
struct iface_mbuf_data *d;
struct rte_mbuf *m;
uint16_t vlan_id;
rte_edge_t edge;

IFACE_STATS_VARS(rx);
IFACE_STATS_VARS(rx, self);
IFACE_STATS_VARS(rx, parent);

last_iface_id = GR_IFACE_ID_UNDEF;
last_vlan_id = UINT16_MAX;
Expand All @@ -67,6 +69,7 @@ iface_input_process(struct rte_graph *graph, struct rte_node *node, void **objs,
m = objs[i];
d = iface_mbuf_data(m);
vlan_id = d->vlan_id;
parent_iface = d->iface;

if (d->vlan_id != 0 && d->iface->mode == GR_IFACE_MODE_VRF) {
if (last_iface_id != d->iface->id || d->vlan_id != last_vlan_id) {
Expand All @@ -87,7 +90,9 @@ iface_input_process(struct rte_graph *graph, struct rte_node *node, void **objs,
goto next;
}

IFACE_STATS_INC(rx, m, d->iface);
IFACE_STATS_INC(rx, self, m, d->iface);
if (parent_iface != d->iface)
IFACE_STATS_INC(rx, parent, m, parent_iface);

edge = edges[d->iface->mode];
next:
Expand All @@ -100,7 +105,8 @@ iface_input_process(struct rte_graph *graph, struct rte_node *node, void **objs,
rte_node_enqueue_x1(graph, node, edge, m);
}

IFACE_STATS_FLUSH(rx);
IFACE_STATS_FLUSH(rx, self);
IFACE_STATS_FLUSH(rx, parent);

return nb_objs;
}
Expand Down
13 changes: 10 additions & 3 deletions modules/infra/datapath/iface_output.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,25 @@ static uint16_t iface_output_process(
uint16_t nb_objs
) {
const struct iface *iface;
const struct iface *parent;
struct iface_mbuf_data *d;
struct rte_mbuf *m;
rte_edge_t edge;

IFACE_STATS_VARS(tx);
IFACE_STATS_VARS(tx, self);
IFACE_STATS_VARS(tx, parent);

for (uint16_t i = 0; i < nb_objs; i++) {
m = objs[i];
d = iface_mbuf_data(m);
iface = d->iface;
parent = NULL;

if (iface->type == GR_IFACE_TYPE_VLAN) {
const struct iface_info_vlan *vlan = iface_info_vlan(iface);
d->vlan_id = vlan->vlan_id;
iface = iface_from_id(vlan->parent_id);
parent = iface;
}

if (gr_mbuf_is_traced(m)) {
Expand All @@ -89,15 +93,18 @@ static uint16_t iface_output_process(
goto next;
}

IFACE_STATS_INC(tx, m, d->iface);
IFACE_STATS_INC(tx, self, m, d->iface);
if (parent != NULL)
IFACE_STATS_INC(tx, parent, m, parent);

d->iface = iface;
edge = iface_type_edges[iface->type];
next:
rte_node_enqueue_x1(graph, node, edge, m);
}

IFACE_STATS_FLUSH(tx);
IFACE_STATS_FLUSH(tx, self);
IFACE_STATS_FLUSH(tx, parent);

return nb_objs;
}
Expand Down
46 changes: 24 additions & 22 deletions modules/infra/datapath/rxtx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,35 +80,37 @@ uint16_t rx_bond_process(struct rte_graph *, struct rte_node *, void **, uint16_
uint16_t tx_process(struct rte_graph *, struct rte_node *, void **, uint16_t);
uint16_t tx_shared_process(struct rte_graph *, struct rte_node *, void **, uint16_t);

#define IFACE_STATS_VARS(dir) \
struct iface_stats *dir##_stats; \
uint16_t dir##_last_iface_id = GR_IFACE_ID_UNDEF; \
uint16_t dir##_packets = 0; \
uint64_t dir##_bytes = 0;
#define IFACE_STATS_VARS(dir, acc) \
struct iface_stats *dir##_##acc##_stats; \
uint16_t dir##_##acc##_last_iface_id = GR_IFACE_ID_UNDEF; \
uint16_t dir##_##acc##_packets = 0; \
uint64_t dir##_##acc##_bytes = 0;

#define IFACE_STATS_INC(dir, mbuf, iface) \
#define IFACE_STATS_INC(dir, acc, mbuf, iface) \
do { \
if (iface->id != dir##_last_iface_id) { \
if (dir##_packets != 0) { \
dir##_stats = iface_get_stats( \
rte_lcore_id(), dir##_last_iface_id \
if (iface->id != dir##_##acc##_last_iface_id) { \
if (dir##_##acc##_packets != 0) { \
dir##_##acc##_stats = iface_get_stats( \
rte_lcore_id(), dir##_##acc##_last_iface_id \
); \
dir##_stats->dir##_packets += dir##_packets; \
dir##_stats->dir##_bytes += dir##_bytes; \
dir##_packets = 0; \
dir##_bytes = 0; \
dir##_##acc##_stats->dir##_packets += dir##_##acc##_packets; \
dir##_##acc##_stats->dir##_bytes += dir##_##acc##_bytes; \
dir##_##acc##_packets = 0; \
dir##_##acc##_bytes = 0; \
} \
dir##_last_iface_id = iface->id; \
dir##_##acc##_last_iface_id = iface->id; \
} \
dir##_packets += 1; \
dir##_bytes += rte_pktmbuf_pkt_len(mbuf); \
dir##_##acc##_packets += 1; \
dir##_##acc##_bytes += rte_pktmbuf_pkt_len(mbuf); \
} while (0)

#define IFACE_STATS_FLUSH(dir) \
#define IFACE_STATS_FLUSH(dir, acc) \
do { \
if (dir##_packets != 0) { \
dir##_stats = iface_get_stats(rte_lcore_id(), dir##_last_iface_id); \
dir##_stats->dir##_packets += dir##_packets; \
dir##_stats->dir##_bytes += dir##_bytes; \
if (dir##_##acc##_packets != 0) { \
dir##_##acc##_stats = iface_get_stats( \
rte_lcore_id(), dir##_##acc##_last_iface_id \
); \
dir##_##acc##_stats->dir##_packets += dir##_##acc##_packets; \
dir##_##acc##_stats->dir##_bytes += dir##_##acc##_bytes; \
} \
} while (0)
12 changes: 6 additions & 6 deletions modules/infra/datapath/xconnect.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ xconnect_process(struct rte_graph *graph, struct rte_node *node, void **objs, ui
struct rte_mbuf *mbuf;
rte_edge_t edge;

IFACE_STATS_VARS(rx);
IFACE_STATS_VARS(tx);
IFACE_STATS_VARS(rx, self);
IFACE_STATS_VARS(tx, self);

for (uint16_t i = 0; i < nb_objs; i++) {
mbuf = objs[i];
iface = mbuf_data(mbuf)->iface;
peer = iface_from_id(iface->domain_id);

IFACE_STATS_INC(rx, mbuf, iface);
IFACE_STATS_INC(rx, self, mbuf, iface);

if (peer != NULL && peer->type == GR_IFACE_TYPE_PORT) {
mbuf_data(mbuf)->iface = peer;
edge = OUTPUT;

IFACE_STATS_INC(tx, mbuf, peer);
IFACE_STATS_INC(tx, self, mbuf, peer);
} else {
edge = NO_PORT;
}
Expand All @@ -45,8 +45,8 @@ xconnect_process(struct rte_graph *graph, struct rte_node *node, void **objs, ui
rte_node_enqueue_x1(graph, node, edge, mbuf);
}

IFACE_STATS_FLUSH(rx);
IFACE_STATS_FLUSH(tx);
IFACE_STATS_FLUSH(rx, self);
IFACE_STATS_FLUSH(tx, self);

return nb_objs;
}
Expand Down
Loading
Loading