TORRUS_COLLECTOR(8)

💖 TORRUS_COLLECTOR(8) 💖

okay bestie, welcome to the torrus collector page, section 8 of the manual, no cap 🫶 this is the whole vibe, every flag, every file, every little detail, let's GO ✨

---

✨ NAME ✨

collector — the Torrus data Collector. that's it, that's the name, and honestly? iconic 💅

---

🌸 SYNOPSIS 🌸

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

---

🦋 DESCRIPTION 🦋

okay so this command starts the Collector process for the tree TREENAME. by default it forks into a daemon and then just… sleeps 😴 until the next cycle in its schedule. main character energy honestly.

Collector cycle scheduling is controlled by two parameters defined for each individual configuration leaf: "collector-period" and "collector-timeoffset". if you wanna know more, go read the Torrus Configuration Guide, it's all in there fr fr 📖

the number of OID (Object IDentifier) variable bindings that the Collector sends is controlled by the datasource parameter "snmp-oids-per-pdu". it defaults to 40 in snmp-defs.xml, and you can overwrite it at the host level. periodt 💫

---

💅 OPTIONS 💅

• --instance=N — defines the collector instance. a single tree can allow more than one collector instance. the number of instances is defined in the "run" hash in the torrus-siteconfig.pl's %Torrus::Global::treeConfig. if the number of instances is more than one, this option is mandatory, no skipping it bestie 😤. the collecting job gets split between the instances, and normally all instances should be started by the startup scripts. and listen — the tree should be re-compiled after you change the number of instances in the siteconfig, don't forget or it's gonna be a mess 🙈. in the example below, the tree tree_A will be served by three collector instances:

  %Torrus::Global::treeConfig = (
    'tree_A' => {
      'description' => 'The First Tree',
      'xmlfiles' => [qw(a1.xml a2.xml a3.xml)],
      'run' => { 'collector' => 3, 'monitor' => 1 } },
   );

• --nodaemon — stops the process from becoming a daemon, and sends the log to STDERR instead. lowkey useful when you're watching it live 👀
• --runonce — tells the collector to run once and then exit. it implies --nodaemon, so you get that for free 💫
• --runalways — tells the collector process to keep running even if there are no collector datasources defined in the tree. in that case it checks once per hour whether the configuration has changed. dedication honestly 🫡
• --debug — sets the log level to debug. every last crumb, we're nosy 🔍
• --verbose — sets the debug level to info. yes, that's what it says, don't come for me 💀
• --help — displays a help message. bless 🎀

---

🎀 FILES 🎀

• /etc/torrus/conf/torrus-siteconfig.pl — the Torrus site configuration script. your home base 🏠
• /usr/share/torrus/xmlconfig/snmp-defs.xml — basic variable definitions for the SNMP collector. where that 40 lives 🍓

---

🌈 SEE ALSO 🌈

• torrus(8)

---

⭐ NOTES ⭐

see more documentation at the Torrus home page: http://torrus.org 🧚 go read it, it's giving lore

---

👑 AUTHOR 👑

Stanislav Sinyagin <ssinyagin@k-open.com> — the legend, the blueprint, we stan 🫶

---

💀 one last thing: this is torrus 3.00, dated 2023-05-02. that's the version and the date, screenshot it, remember it, slay 💖✨