infra: export interface statistics through DPDK telemetry socket #234

spk-hebbar · 2025-06-09T04:49:33Z

Implement per interface statistics
Export them via DPDK telemetry socket
Export them via grcli with show interface stats
Implement clear stats with clear stats

modules/infra/api/stats.c

rjarry · 2025-06-10T15:13:26Z

I'm thinking about this a bit more and the interface statistics should be attached to interfaces themselves.

Otherwise statistics will be displayed in multiple locations.

What do you think about splitting this in multiple steps:

Implement per interface software statistics (rx_packets, rx_bytes, tx_packets, tx_bytes).
Export these statistics via the grout API attached to struct gr_iface.

Expose interface details under "/grout/ifaces".

--> /grout/ifaces
[
  {
    "name": "p0",
    "id": 1,
    "type": "port",
    "mtu": 1500,
    "flags": ["up", "running"],
    "mode": "l3",
    "vrf_id": 0
  },
  ...
]

Include software statistics per interface in "/grout/ifaces".

--> /grout/ifaces
[
  {
    "name": "p0",
    "id": 1,
    "type": "port",
    "mtu": 1500,
    "flags": ["up", "running"],
    "mode": "l3",
    "vrf_id": 0,
    "statistics": {
       "rx_packets": 123501,
       "rx_bytes": 78135123501,
       "tx_packets": 123451,
       "tx_bytes": 81543213211
    }
  },
  ...
]

Include extended hardware statistics for type=port interfaces.

--> /grout/ifaces
[
  {
    "name": "p0",
    "id": 1,
    "type": "port",
    "mtu": 1500,
    "flags": ["up", "running"],
    "mode": "l3",
    "vrf_id": 0,
    "statistics": {
       "rx_packets": 123501,
       "rx_bytes": 78135123501,
       "tx_packets": 123451,
       "tx_bytes": 81543213211,
       // extra hardware statistics
       "rx_missed": 2,
       "tx_errors": 1,
       // xstats
       "rx_good_packets": 2,
       "rx_good_bytes": 750,
       "rx_multicast_packets": 2,
       "rx_broadcast_packets": 1,
       "rx_unknown_protocol_packets": 3,
       "mac_remote_errors": 1,
       "rx_size_256_to_511_packets": 3
    }
  },
  ...
]

What do you think?

modules/infra/api/stats.c

spk-hebbar · 2025-06-23T11:15:54Z

@rjarry I agree with your suggestion, please have a look at what I have now.

rjarry

Could you split that in multiple commits to follow the specs I gave earlier? Also, you forgot to update the grout API to expose the per-iface statistics.

modules/infra/api/stats.c

modules/infra/datapath/tx.c

modules/infra/datapath/rx.c

modules/infra/datapath/eth_input.c

spk-hebbar · 2025-06-23T14:07:34Z

Thanks for the review @rjarry, I have incorporated the changes. I'm working getting another commit for grout API. Will mark the PR as WIP.

modules/infra/api/stats.c

spk-hebbar · 2025-06-27T09:36:36Z

@rjarry this is now ready for review. Please have a look. Thanks

rjarry

You need to reset all interface statistics when the user calls clear stats. Also, Make sure to reset the stats for a given interface when creating a new one.

modules/infra/api/gr_infra.h

modules/infra/api/stats.c

modules/infra/cli/iface.c

rjarry

Hey Spoorthi, thanks for the update. We're almost there :)

Could you squash the last commit (infra: clear interface stats) with the one that adds interface stats (infra: implement per interface statistics)? No need to have them separate.

Thanks!

modules/infra/api/gr_infra.h

rjarry · 2025-06-30T08:25:10Z

modules/infra/api/stats.c

-	while ((iface = iface_next(GR_IFACE_TYPE_PORT, iface)) != NULL) {
-		struct iface_info_port *port = (struct iface_info_port *)iface->info;
-		if ((ret = rte_eth_stats_reset(port->port_id)) < 0)
-			return api_out(-ret, 0);
-		if ((ret = rte_eth_xstats_reset(port->port_id)) < 0)
-			return api_out(-ret, 0);
+
+	while ((iface = iface_next(GR_IFACE_TYPE_UNDEF, iface)) != NULL) {
+		struct iface_stats *sw_stats = iface_get_stats(iface->id);
+		// Reset software stats for all interface types.
+		if (sw_stats != NULL) {
+			memset(sw_stats, 0, sizeof(*sw_stats));
+		}
+
+		if (iface->type == GR_IFACE_TYPE_PORT) {
+			struct iface_info_port *port = (struct iface_info_port *)iface->info;
+			if ((ret = rte_eth_stats_reset(port->port_id)) < 0)
+				return api_out(-ret, 0);
+			if ((ret = rte_eth_xstats_reset(port->port_id)) < 0)
+				return api_out(-ret, 0);
+		}


This was squashed into the wrong commit.

The logic to clear the stats is part of "infra: add API and CLI command to obtain and clear iface stats" commit - d5f812f, I think we are good?

Not really. The statistics already exist in the first commit infra: implement per interface statistics even if they are not exposed in the API yet.

You should implement the reset of these statistics in this commit. Not the one that exposes the stats in the API.

rjarry

Also, could you reset stats when a new interface is created?

spk-hebbar · 2025-06-30T09:38:11Z

modules/infra/api/stats.c

+		s.rx_bytes = 0;
+		s.tx_packets = 0;
+		s.tx_bytes = 0;
+


@rjarry I'm already resetting the stats per iface_id before obtaining the stats. Isn't it enough?

I mean resetting the internal structure.

grout/modules/infra/control/iface.c

Line 175 in 9f716b3

static struct iface_stats stats[MAX_IFACES];

So after this line:

grout/modules/infra/control/iface.c

Line 91 in 9f716b3

ifaces[ifid] = iface;

You need to add:

memset(&stats[ifid], 0, sizeof(stats[ifid]));

So that new interfaces are created with all their statistics reset to 0.

Oh thanks, added this part in latest change.
3ab7143#diff-0b2d0fe2e3aef9dc99b65af53ee4d4ac8a618dc8b3f57fdd8b9a450a223fed2cR95

spk-hebbar · 2025-06-30T09:39:31Z

modules/infra/api/stats.c

-	while ((iface = iface_next(GR_IFACE_TYPE_PORT, iface)) != NULL) {
-		struct iface_info_port *port = (struct iface_info_port *)iface->info;
-		if ((ret = rte_eth_stats_reset(port->port_id)) < 0)
-			return api_out(-ret, 0);
-		if ((ret = rte_eth_xstats_reset(port->port_id)) < 0)
-			return api_out(-ret, 0);
+
+	while ((iface = iface_next(GR_IFACE_TYPE_UNDEF, iface)) != NULL) {
+		struct iface_stats *sw_stats = iface_get_stats(iface->id);
+		// Reset software stats for all interface types.
+		if (sw_stats != NULL) {
+			memset(sw_stats, 0, sizeof(*sw_stats));
+		}
+
+		if (iface->type == GR_IFACE_TYPE_PORT) {
+			struct iface_info_port *port = (struct iface_info_port *)iface->info;
+			if ((ret = rte_eth_stats_reset(port->port_id)) < 0)
+				return api_out(-ret, 0);
+			if ((ret = rte_eth_xstats_reset(port->port_id)) < 0)
+				return api_out(-ret, 0);
+		}


The logic to clear the stats is part of "infra: add API and CLI command to obtain and clear iface stats" commit - d5f812f, I think we are good?

Collect statistics per interface and later expose it via DPDK telemetry and grout API. Signed-off-by: Spoorthi K <[email protected]>

Output snippet: --> /grout/iface { "/grout/iface": { "p0": { "name": "p0", "id": 1, "type": "port", "mtu": 1500, "flags": [ "up", "running" ], "mode": "l3", "vrf_id": 0, "statistics": { "rx_packets": 3, "rx_bytes": 1169, "tx_packets": 3, "tx_bytes": 150 "rx_missed": 0, "tx_errors": 0, "rx_good_packets": 3, "tx_good_packets": 3, "rx_good_bytes": 1169, "tx_good_bytes": 180, "rx_multicast_packets": 3, "rx_broadcast_packets": 1, "rx_unknown_protocol_packets": 4, "tx_unicast_packets": 3, "mac_remote_errors": 1, "rx_size_256_to_511_packets": 4, "tx_size_64_packets": 3 } } } } Signed-off-by: Spoorthi K <[email protected]>

Display interface statistics (rx_packets, rx_bytes, tx_packets and tx_bytes) per interface using 'show interface stats' grcli command. With clear stats, reset the these interface statistics along with software and hardware stats. Sample output: grout# show interface <return> Validate command. type Show interface details. stats Show interface statistics. name Show interface details. grout# show interface stats INTERFACE RX_PACKETS RX_BYTES TX_PACKETS TX_BYTES p0 7 2757 2 100 gr-loop0 0 0 0 0 grout# clear stats grout# show interface stats INTERFACE RX_PACKETS RX_BYTES TX_PACKETS TX_BYTES p0 0 0 0 0 gr-loop0 0 0 0 0 Signed-off-by: Spoorthi K <[email protected]>

spk-hebbar force-pushed the iface_tele branch from 1285d83 to fcfd860 Compare June 9, 2025 04:50

rjarry requested changes Jun 10, 2025

View reviewed changes

modules/infra/api/stats.c Outdated Show resolved Hide resolved

spk-hebbar force-pushed the iface_tele branch 2 times, most recently from ac6fb8d to b2b133a Compare June 10, 2025 10:41

spk-hebbar force-pushed the iface_tele branch 2 times, most recently from f4e7732 to e12d289 Compare June 23, 2025 09:40

rjarry reviewed Jun 23, 2025

View reviewed changes

modules/infra/api/stats.c Outdated Show resolved Hide resolved

spk-hebbar marked this pull request as draft June 23, 2025 09:46

spk-hebbar force-pushed the iface_tele branch 2 times, most recently from 09bc9e2 to 7178082 Compare June 23, 2025 11:06

spk-hebbar marked this pull request as ready for review June 23, 2025 11:14

rjarry requested changes Jun 23, 2025

View reviewed changes

spk-hebbar force-pushed the iface_tele branch from 7178082 to 9f716b3 Compare June 23, 2025 14:03

spk-hebbar marked this pull request as draft June 23, 2025 14:07

spk-hebbar force-pushed the iface_tele branch from 9dc650f to 1ec3c9e Compare June 23, 2025 14:08

spk-hebbar changed the title ~~infra: export hardware statistics through DPDK telemetry socket~~ infra: export interface statistics through DPDK telemetry socket Jun 23, 2025

rjarry requested changes Jun 23, 2025

View reviewed changes

modules/infra/api/stats.c Outdated Show resolved Hide resolved

spk-hebbar force-pushed the iface_tele branch 2 times, most recently from 85dd5e1 to 1082673 Compare June 24, 2025 08:39

spk-hebbar marked this pull request as ready for review June 27, 2025 02:52

rjarry requested changes Jun 27, 2025

View reviewed changes

modules/infra/api/gr_infra.h Outdated Show resolved Hide resolved

modules/infra/api/stats.c Show resolved Hide resolved

modules/infra/cli/iface.c Outdated Show resolved Hide resolved

spk-hebbar force-pushed the iface_tele branch from 2be1e73 to 8745ecb Compare June 30, 2025 05:14

rjarry requested changes Jun 30, 2025

View reviewed changes

modules/infra/api/gr_infra.h Outdated Show resolved Hide resolved

modules/infra/api/gr_infra.h Outdated Show resolved Hide resolved

modules/infra/api/gr_infra.h Outdated Show resolved Hide resolved

spk-hebbar force-pushed the iface_tele branch from 7416b48 to d5f812f Compare June 30, 2025 08:06

rjarry reviewed Jun 30, 2025

View reviewed changes

rjarry requested changes Jun 30, 2025

View reviewed changes

spk-hebbar commented Jun 30, 2025

View reviewed changes

spk-hebbar added 3 commits June 30, 2025 15:27

infra: implement per interface statistics

3ab7143

Collect statistics per interface and later expose it via DPDK telemetry and grout API. Signed-off-by: Spoorthi K <[email protected]>

spk-hebbar force-pushed the iface_tele branch from d5f812f to b605df4 Compare June 30, 2025 09:57

rjarry approved these changes Jun 30, 2025

View reviewed changes

rjarry merged commit 2190714 into DPDK:main Jun 30, 2025
8 checks passed

infra: export interface statistics through DPDK telemetry socket #234

infra: export interface statistics through DPDK telemetry socket #234

Uh oh!

Conversation

spk-hebbar commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

rjarry commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

spk-hebbar commented Jun 23, 2025

Uh oh!

rjarry left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

spk-hebbar commented Jun 23, 2025

Uh oh!

Uh oh!

spk-hebbar commented Jun 27, 2025

Uh oh!

rjarry left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rjarry left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rjarry Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

spk-hebbar Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjarry Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjarry left a comment

Choose a reason for hiding this comment

Uh oh!

spk-hebbar Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjarry Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

spk-hebbar Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

spk-hebbar Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

spk-hebbar commented Jun 9, 2025 •

edited

Loading

rjarry commented Jun 10, 2025 •

edited

Loading