TORRUS_RRDDIR2XML(8)

πŸ“¦
version 3.00 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

πŸ’– NAME πŸ’–

rrddir2xml β€” she goes snooping through a directory for RRD files and then whips up a Torrus XML config file out of them. no cap, that's the whole job.


✨ SYNOPSIS ✨

torrus rrddir2xml --dir=DIR [options...]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so bestie, here's the tea. rrddir2xml walks into a directory you point her at, hunts down all the RRD files chilling in there, and builds you a Torrus XML configuration file that's all set up for browsing those data files. iconic behaviour honestly.

and with the default options? she's literally made for RRD files that Torrus' SNMP collector spat out β€” you know the ones, where the file name kicks off with the host name, then an underscore, then the interface name or whatever other MIB specifics. with those defaults she makes one subtree per host name, and every RRD file belonging to that host name gets sorted alphabetically inside that subtree. so organized. so main character. 🌸


πŸ’… OPTIONS πŸ’…

  • --dir=DIR β€” the absolute path to the directory she should search. ngl, this directory can absolutely contain non-RRD files too, she doesn't care. only regular files get processed, and symlinks get straight-up ignored. πŸ™ˆ
  • --recursive β€” say the word and she'll search that directory recursively. ⚠️ heads up though: all file names across all subdirectories must be unique. also, symlinks pointing to other directories? ignored.
  • --filter=Regexp β€” give her a filter and she'll only list the files and subdirectories whose names match that regular expression. picky queen, we love her for it.
  • --out=FILE β€” the output XML file name. if you hand her a relative path, the file lands in /etc/torrus/xmlconfig. default is rrddir.xml.
  • --subtree=SUBTREE β€” the top subtree path in the generated XML. default is the very top of the tree, "/".
  • --split=REGEXP β€” the regular expression she uses to split the file name into parts so she can build the subtree hierarchy. default is a sequence of underscores, "_+".
  • --levels=INTEGER β€” how many levels of hierarchy to build by splitting the file names. default is 2 levels.
  • --comment=TEXT β€” the text to drop in as the "comment" parameter on the top subtree.
  • --holtwinters β€” if you specify this, Holt-Winters prediction boundaries and failures get displayed in the graphs. πŸ”₯
  • --verbose β€” prints extra diagnostics.
  • --debug β€” prints debugging information.

πŸŽ€ SEE ALSO πŸŽ€

torrus(8)


🌈 NOTES 🌈

more documentation lives at the Torrus home page: http://torrus.org


πŸ‘‘ AUTHOR πŸ‘‘

Stanislav Sinyagin <ssinyagin@k-open.com>


and that's the whole page bestie, you ate it up fr fr πŸ’œ

this was brought to you by torrus 3.00, dated 2023-05-02 β€” she's been serving since way back, periodt ✨

πŸ“¦ where this page comes from