XYMONFETCH(8)

✨ XYMONFETCH ✨

bestie, welcome to xymonfetch β€” the fetch client data from passive clients girlie πŸ’– it lives in the System Manager's Manual section (section 8, we love a system admin icon) πŸŽ€


🌸 SYNOPSIS 🌸

xymonfetch [--server=XYMON.SERVER.IP] [options]

πŸ’… DESCRIPTION πŸ’…

okay so. this little utility is how you collect data from Xymon clients. that's the whole vibe. πŸ¦‹

normally? the Xymon clients are self-sufficient queens β€” they take care of sending ALL their data straight to the Xymon server themselves. and in that case you literally do not need this utility at all. not even a little. periodt. πŸ’€

BUT. some network setups are lowkey toxic and the clients are prohibited from establishing a connection to an external server like the Xymon server, because of firewall policies. πŸ™ˆ in that setup you can configure the client to store all of the client data locally by enabling the msgcache(8) utility on the client, and then use xymonfetch on the Xymon server to collect data from the clients. main character energy on both sides fr fr. ✨

xymonfetch will only collect data from clients that have the pulldata tag listed in the hosts.cfg(5) file. the IP-address listed in the hosts.cfg file must be correct, because that is the IP-address where xymonfetch will attempt to contact the client. πŸ‘‘

if the msgcache daemon is running on a non-standard IP-address or portnumber, you can specify the portnumber as in pulldata=192.168.1.2:8084 for contacting the msgcache daemon using IP 192.168.1.2 port 8084. if the IP-address is omitted, the default IP in the hosts.cfg file is used. if the port number is omitted, the portnumber from the XYMONDPORT setting in xymonserver.cfg(5) is used (normally, this is port 1984). no cap. 🫢


🌈 OPTIONS 🌈

  • --server=XYMON.SERVER.IP β€” defines the IP address of the Xymon server where the collected client messages are forwarded to. by default, messages are sent to the loopback address 127.0.0.1, i.e. to a Xymon server running on the same host as xymonfetch. 🏠
  • --interval=N β€” sets the interval (in seconds) between polls of a client. default: 60 seconds. ⏰
  • --id=N β€” used when you have a setup with multiple Xymon servers. in that case, you must run xymonfetch on each of the Xymon servers, with xymonfetch instance using a different value of N. this allows several Xymon servers to pick up data from the clients running msgcache, and msgcache can distinguish between which messages have already been forwarded to which server. N is a number in the range 1-31. πŸ”’
  • --log-interval=N β€” limit how often xymonfetch will log problems with fetching data from a host, in seconds. default: 900 seconds (15 minutes). this is to prevent a host that is down or where msgcache has not been started from flooding the xymonfetch logs. note that this is ignored when debugging is enabled. 😭
  • --debug β€” enable debugging output. πŸ›
ngl bestie, if a host is down or msgcache never showed up to the party, --log-interval is your bestie too β€” it keeps your logs from becoming a whole mess. but the moment --debug is on, that limit just ✨does not apply✨. noted. πŸ’…

πŸŽ€ SEE ALSO πŸŽ€


and that's the whole page, bestie πŸ’– this was Xymon, Version 4.3.30: 4 Sep 2019, and the manual page itself is XYMONFETCH(8) β€” slay, ate, no crumbs. πŸŒŸπŸ‘‘

πŸ“¦ where this page comes from