Network Statistics Library

Network statistics library . More...

Data Structures
struct	net_stats_bytes
	Number of bytes sent and received. More...
struct	net_stats_pkts
	Number of network packets sent and received. More...
struct	net_stats_ip
	IP layer statistics. More...
struct	net_stats_ip_errors
	IP layer error statistics. More...
struct	net_stats_icmp
	ICMP statistics. More...
struct	net_stats_tcp
	TCP statistics. More...
struct	net_stats_udp
	UDP statistics. More...
struct	net_stats_ipv6_nd
	IPv6 neighbor discovery statistics. More...
struct	net_stats_ipv6_pmtu
	IPv6 Path MTU Discovery statistics. More...
struct	net_stats_ipv4_pmtu
	IPv4 Path MTU Discovery statistics. More...
struct	net_stats_ipv6_mld
	IPv6 multicast listener daemon statistics. More...
struct	net_stats_ipv4_igmp
	IPv4 IGMP daemon statistics. More...
struct	net_stats_dns
	DNS statistics. More...
struct	net_stats_tx_time
	Network packet transfer times for calculating average TX time. More...
struct	net_stats_rx_time
	Network packet receive times for calculating average RX time. More...
struct	net_stats_tc
	Traffic class statistics. More...
struct	net_stats_pm
	Power management statistics. More...
struct	net_stats
	All network statistics in one struct. More...
struct	net_stats_eth_errors
	Ethernet error statistics. More...
struct	net_stats_eth_flow
	Ethernet flow control statistics. More...
struct	net_stats_eth_csum
	Ethernet checksum statistics. More...
struct	net_stats_eth_hw_timestamp
	Ethernet hardware timestamp statistics. More...
struct	net_stats_eth
	All Ethernet specific statistics. More...
struct	net_stats_ppp
	All PPP specific statistics. More...
struct	net_stats_sta_mgmt
	All Wi-Fi management statistics. More...
struct	net_stats_wifi
	All Wi-Fi specific statistics. More...

Macros
#define	NET_STATS_GET_METRIC_NAME(_name)
#define	NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx)
#define	NET_STATS_GET_VAR(dev_id, sfx, var)
#define	NET_STATS_GET_INSTANCE(dev_id, sfx, _not_used)
#define	NET_STATS_PROMETHEUS_COUNTER_DEFINE(_desc, _labelval, _not_used, _collector, _name, _stat_var_ptr)
#define	NET_STATS_PROMETHEUS_GAUGE_DEFINE(_desc, _labelval, _not_used, _collector, _name, _stat_var_ptr)
#define	NET_STATS_PROMETHEUS_SUMMARY_DEFINE(_desc, _labelval, _not_used, _collector, _name, _stat_var_ptr)
#define	NET_STATS_PROMETHEUS_HISTOGRAM_DEFINE(_desc, _labelval, _not_used, _collector, _name, _stat_var_ptr)
#define	NET_STATS_PROMETHEUS_IPV6(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_IPV4(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_ICMP(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_UDP(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_TCP(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_IPV6_ND(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_IPV6_PMTU(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_IPV4_PMTU(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_MLD(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_IGMP(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_DNS(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_TX_TIME(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS_RX_TIME(iface, dev_id, sfx)
#define	NET_STATS_PROMETHEUS(iface, dev_id, sfx)

Typedefs
typedef uint32_t	net_stats_t
	Network statistics counter.

Detailed Description

Network statistics library .

Since

1.5

Version

0.8.0

Macro Definition Documentation

NET_STATS_GET_COLLECTOR_NAME

#define NET_STATS_GET_COLLECTOR_NAME	(		dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

Value:

net_stats_##dev_id##_##sfx##_collector

NET_STATS_GET_INSTANCE

#define NET_STATS_GET_INSTANCE	(		dev_id,
			sfx,
			_not_used )

#include <zephyr/net/net_stats.h>

Value:

STRINGIFY(_##dev_id##_##sfx)

NET_STATS_GET_METRIC_NAME

#define NET_STATS_GET_METRIC_NAME

(

_name

)

#include <zephyr/net/net_stats.h>

Value:

_name

NET_STATS_GET_VAR

#define NET_STATS_GET_VAR	(		dev_id,
			sfx,
			var )

#include <zephyr/net/net_stats.h>

Value:

zephyr_net_##var

NET_STATS_PROMETHEUS

#define NET_STATS_PROMETHEUS	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

Value:

        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "Processing error",                                     \
                NET_STATS_GET_INSTANCE(dev_id, sfx, process_error),     \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, processing_error),       \
                &(iface)->stats.processing_error);                      \
        /* IP layer error statistics */                                 \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "IP proto error",                                       \
                NET_STATS_GET_INSTANCE(dev_id, sfx, ip_proto_error),    \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, ip_errors_protoerr),     \
                &(iface)->stats.ip_errors.protoerr);                    \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "IP version/header len error",                          \
                NET_STATS_GET_INSTANCE(dev_id, sfx, ip_vhl_error),      \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, ip_errors_vhlerr),       \
                &(iface)->stats.ip_errors.vhlerr);                      \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "IP header len error (high byte)",                      \
                NET_STATS_GET_INSTANCE(dev_id, sfx, ip_hblen_error),    \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, ip_errors_hblenerr),     \
                &(iface)->stats.ip_errors.hblenerr);                    \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "IP header len error (low byte)",                       \
                NET_STATS_GET_INSTANCE(dev_id, sfx, ip_lblen_error),    \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, ip_errors_lblenerr),     \
                &(iface)->stats.ip_errors.lblenerr);                    \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "IP fragment error",                                    \
                NET_STATS_GET_INSTANCE(dev_id, sfx, ip_frag_error),     \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, ip_errors_fragerr),      \
                &(iface)->stats.ip_errors.fragerr);                     \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "IP checksum error",                                    \
                NET_STATS_GET_INSTANCE(dev_id, sfx, ip_chk_error),      \
                "error_count",                                          \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, ip_errors_chkerr),       \
                &(iface)->stats.ip_errors.chkerr);                      \
        /* General network statistics */                                \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "Bytes received",                                       \
                NET_STATS_GET_INSTANCE(dev_id, sfx, bytes_recv),        \
                "byte_count",                                           \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, bytes_recv),             \
                &(iface)->stats.bytes.received);                        \
        NET_STATS_PROMETHEUS_COUNTER_DEFINE(                            \
                "Bytes sent",                                           \
                NET_STATS_GET_INSTANCE(dev_id, sfx, bytes_sent),        \
                "byte_count",                                           \
                NET_STATS_GET_COLLECTOR_NAME(dev_id, sfx),              \
                NET_STATS_GET_VAR(dev_id, sfx, bytes_sent),             \
                &(iface)->stats.bytes.sent);                            \
        NET_STATS_PROMETHEUS_IPV6(iface, dev_id, sfx);                  \
        NET_STATS_PROMETHEUS_IPV4(iface, dev_id, sfx);                  \
        NET_STATS_PROMETHEUS_ICMP(iface, dev_id, sfx);                  \
        NET_STATS_PROMETHEUS_UDP(iface, dev_id, sfx);                   \
        NET_STATS_PROMETHEUS_TCP(iface, dev_id, sfx);                   \
        NET_STATS_PROMETHEUS_IPV6_ND(iface, dev_id, sfx);               \
        NET_STATS_PROMETHEUS_IPV6_PMTU(iface, dev_id, sfx);             \
        NET_STATS_PROMETHEUS_IPV4_PMTU(iface, dev_id, sfx);             \
        NET_STATS_PROMETHEUS_MLD(iface, dev_id, sfx);                   \
        NET_STATS_PROMETHEUS_IGMP(iface, dev_id, sfx);                  \
        NET_STATS_PROMETHEUS_DNS(iface, dev_id, sfx);                   \
        NET_STATS_PROMETHEUS_TX_TIME(iface, dev_id, sfx);               \
        NET_STATS_PROMETHEUS_RX_TIME(iface, dev_id, sfx)

NET_STATS_PROMETHEUS_COUNTER_DEFINE

#define NET_STATS_PROMETHEUS_COUNTER_DEFINE	(		_desc,
			_labelval,
			_not_used,
			_collector,
			_name,
			_stat_var_ptr )

#include <zephyr/net/net_stats.h>

Value:

        static PROMETHEUS_COUNTER_DEFINE(                                       \
                NET_STATS_GET_METRIC_NAME(_name),                               \
                _desc, ({ .key = "nic", .value = &_labelval[1] }),              \
                &(_collector), _stat_var_ptr)

NET_STATS_PROMETHEUS_DNS

#define NET_STATS_PROMETHEUS_DNS	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_GAUGE_DEFINE

#define NET_STATS_PROMETHEUS_GAUGE_DEFINE	(		_desc,
			_labelval,
			_not_used,
			_collector,
			_name,
			_stat_var_ptr )

#include <zephyr/net/net_stats.h>

Value:

        static PROMETHEUS_GAUGE_DEFINE(                                         \
                NET_STATS_GET_METRIC_NAME(_name),                               \
                _desc, ({ .key = "nic", .value = &_labelval[1] }),              \
                &(_collector), _stat_var_ptr)

NET_STATS_PROMETHEUS_HISTOGRAM_DEFINE

#define NET_STATS_PROMETHEUS_HISTOGRAM_DEFINE	(		_desc,
			_labelval,
			_not_used,
			_collector,
			_name,
			_stat_var_ptr )

#include <zephyr/net/net_stats.h>

Value:

        static PROMETHEUS_HISTOGRAM_DEFINE(                                     \
                NET_STATS_GET_METRIC_NAME(_name),                               \
                _desc, ({ .key = "nic", .value = &_labelval[1] }),              \
                &(_collector), _stat_var_ptr)

NET_STATS_PROMETHEUS_ICMP

#define NET_STATS_PROMETHEUS_ICMP	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_IGMP

#define NET_STATS_PROMETHEUS_IGMP	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_IPV4

#define NET_STATS_PROMETHEUS_IPV4	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_IPV4_PMTU

#define NET_STATS_PROMETHEUS_IPV4_PMTU	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_IPV6

#define NET_STATS_PROMETHEUS_IPV6	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_IPV6_ND

#define NET_STATS_PROMETHEUS_IPV6_ND	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_IPV6_PMTU

#define NET_STATS_PROMETHEUS_IPV6_PMTU	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_MLD

#define NET_STATS_PROMETHEUS_MLD	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_RX_TIME

#define NET_STATS_PROMETHEUS_RX_TIME	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_SUMMARY_DEFINE

#define NET_STATS_PROMETHEUS_SUMMARY_DEFINE	(		_desc,
			_labelval,
			_not_used,
			_collector,
			_name,
			_stat_var_ptr )

#include <zephyr/net/net_stats.h>

Value:

        static PROMETHEUS_SUMMARY_DEFINE(                                       \
                NET_STATS_GET_METRIC_NAME(_name),                               \
                _desc, ({ .key = "nic", .value = &_labelval[1] }),              \
                &(_collector), _stat_var_ptr)

NET_STATS_PROMETHEUS_TCP

#define NET_STATS_PROMETHEUS_TCP	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_TX_TIME

#define NET_STATS_PROMETHEUS_TX_TIME	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

NET_STATS_PROMETHEUS_UDP

#define NET_STATS_PROMETHEUS_UDP	(		iface,
			dev_id,
			sfx )

#include <zephyr/net/net_stats.h>

Typedef Documentation

net_stats_t

typedef uint32_t net_stats_t

#include <zephyr/net/net_stats.h>

Network statistics counter.