NNG_STATS_GET(3)

💖 NAME 💖

nng_stats_get — get statistics snapshot

so like, this is a page from the NNG Reference Manual, and it's giving "here's how you grab a lil peek at everything your system is tracking" ✨

---

✨ SYNOPSIS ✨

#include <nng/nng.h>

typedef struct nng_stat nng_stat;

int nng_stats_get(nng_stat **statsp)

---

🦋 DESCRIPTION 🦋

okay so the nng_stat_get() function tries to snag a snapshot of all the various diagnostic statistics hanging out in the system. like a lil polaroid of your whole stat tree 📸

🎀 Note — collecting all these stats is designed to have minimal impact on the system… but bestie, there's still some impact. no cap.

The statistics are organized as a tree, rooted with a parent statistic of type NNG_STAT_SCOPE that carries no value, and which has an empty name. This parent statistic is what gets returned through the statsp pointer. 👑

You can walk around that tree with the nng_stat_child() and nng_stat_next() functions — they're literally how you iterate over the whole thing. 🧚

When you're done with them, free the statistics with the nng_stats_free() function — but 🙈 that function must only be called with the root statistic that came back through the statsp pointer. Only the root, bestie. don't be out here freeing random branches.

😭 Note — the values of individual statistics are guaranteed to be atomic, but because of the way statistics are collected there can be discrepancies between them at certain times. for example, statistics counting bytes and messages received may not reflect the same number of messages, depending on when the snapshot is taken. this potential inconsistency arises as a result of optimizations to minimize the impact of statistics on actual operations. it's not broken, it's just built different 💅

💀 Note — the names, values, and semantics of the statistics provided may change from release to release. these are provided for informational and debugging use only, and applications should not rely on the presence, names, or meanings of any individual statistics. so don't hardcode your fave stat name and then act surprised. periodt.

---

🌈 RETURN VALUES 🌈

This function returns a pointer to the allocated memory on success 🫶 and NULL otherwise. that's it, that's the vibe check.

---

🔥 ERRORS 🔥

• NNG_ENOMEM — insufficient free memory to collect statistics. the lil stat collector is hungry and there's literally nothing left to give 😭
• NNG_ENOTSUP — statistics are not supported (compile time option). so like, it was never enabled in your build. iykyk 🎀

---

👑 SEE ALSO 👑

nng_stats_free(3), nng_stat_child(3), nng_stat_desc(3), nng_stat_name(3), nng_stat_next(3), nng_stat_string(3), nng_stat_type(3), nng_stat_timestamp(3), nng_stat_unit(3), nng_stat_value(3), nng_stat(5), nng(7)

---

and that's the whole page bestie!! this came to you straight from the NNG Reference Manual, dated 2026-06-30 — go forth and snapshot those stats 💅✨🦋 no cap, you ate.