TORRUS_SNMPFAILURES(8)

✨ snmpfailures — the vibe check for your SNMP collectors ✨

okay bestie, gather round 💖 this is torrus snmpfailures, a lil utility from the torrus(8) family, and she does exactly one thing but she does it impeccably: she shows you the SNMP collector failures. That's it. That's the whole job. And she prints them as JSON so your scripts can eat them for breakfast 🍓

---

🌸 SYNOPSIS 🌸

torrus snmpfailures --tree=TREENAME [options...]

That's the whole summoning ritual. Give her a tree name, maybe toss in some options, and she'll spill the tea ☕

---

💅 OPTIONS 💅

• --details — not just the counters, babe. This one makes her list out the actual failed SNMP hosts and the time stamps of when each failure event went down. Receipts. We love receipts 🧾
• --help — she'll hand you a help message, no judgment, no questions asked 🫶

---

🦋 DESCRIPTION 🦋

So here's the deal: this utility prints the SNMP collector failure info in JSON format. If you don't pass --details, you only get the failure counters — the summary numbers, the TL;DR, the main character stats 👑

And important lil fact: when the collector starts up, or after the tree gets re-compiled, the failure counters reset back to zero. Fresh slate, new era, we move on 💅

The output is super convenient for further automatic processing in any scripting language — it's literally built for your pipelines to gobble up ✨

The top level of the output is a JSON object with these name/value pairs:

• total_unreachable: NUMBER — how many SNMP hosts are currently unreachable, right now, as we speak 😭 This number adds up across multiple collector instances for a given tree. And when a host becomes reachable again? The number goes down. Healing era 🫶
• total_deleted: NUMBER — how many SNMP hosts are completely removed from SNMP collection for the life cycle of the collector process. This happens when a host has been unreachable for too long and the collector just gives up trying to reach it again. It adds up across multiple collector instances for a given tree. It's giving "we tried, we really did" 💀
• total_mib_errors: NUMBER — the count of MIB errors (noSuchObject, noSuchInstance, and endOfMibView) during the collector life cycle. Adds up across multiple collector instances for a given tree, same as the others 💜
• detail_unreachable: OBJECT, detail_deleted: OBJECT — if you passed --details, these objects hold the host names and timestamps of the failures. The keys are made by gluing together the SNMP host, the UDP port, and the SNMP community, separated by "|". The values are objects representing the UNIX timestamp and a human-readable time string 🎀
• detail_mib_errors: OBJECT — again, only if you specified --details. This one shows the MIB error details: for each SNMP host, it lists the datasource leaves that had these errors, plus the event timestamps. Full lore drop 📖

---

🌈 EXAMPLES 🌈

First up: an SNMP host that's unreachable. Classic. We've all been there 🙈

 torrus failures --tree=main --details
 {
    "detail_deleted" : {},
    "detail_mib_errors" : {},
    "detail_unreachable" : {
       "217.101.101.101|161|public" : {
          "time" : "Fri Jul 23 14:15:10 2010",
          "timestamp" : 1279887310
       }
    },
    "total_deleted" : 0,
    "total_mib_errors" : 0,
    "total_unreachable" : 1
 }

And second: a MIB error, showing off the detail_mib_errors glow-up ✨

 torrus failures --tree=main --details
 {
    "detail_deleted" : {},
    "detail_mib_errors" : {
       "217.101.102.102|161|public" : {
          "count" : 1,
          "nodes" : {
             "/Routers/CMTS3/Temperature_Sensors/sensor_01" : {
                "time" : "Fri Jul 23 15:26:14 2010",
                "timestamp" : 1279891574
             }
          }
       }
    },
    "detail_unreachable" : {},
    "total_deleted" : 0,
    "total_mib_errors" : 1,
    "total_unreachable" : 0
 }

---

👑 SEE ALSO 👑

• torrus(8)

---

📌 NOTES 📌

Wanna read more documentation? The Torrus home page has you covered, bestie: http://torrus.org

---

💖 AUTHOR 💖

Stanislav Sinyagin <ssinyagin@k-open.com>

---

okay that's the whole page, no cap. go forth and monitor responsibly 🧚

torrus 3.00 · 2023-05-02 · mwah, sending you off with love from the TORRUS_SNMPFAILURES(8) corner of the manual 💅🌸