XYMON-MAILACK(8)

✨ xymon-mailack(8) ✨

okay bestie, welcome to your new favorite thing β€” this is a page from the System Manager's Manual, and it's literally all about letting you yell "I'M ON IT" at Xymon via email πŸ’Œ


πŸ’– NAME πŸ’–

xymon-mailack β€” the little icon that lets you acknowledge alerts via e-mail, no cap


πŸŽ€ SYNOPSIS πŸŽ€

xymon-mailack --env=FILENAME [--debug]

πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea: xymon-mailack normally runs as an input mail-filter for the xymon user. Like, it gets called from the xymon user's procmailrc(5) file. Very demure, very mail-filter of it.

What does it do tho? It recognizes e-mails that are replies to xymond_alert(8) mail alerts, and then converts that reply mail into an acknowledge message that gets sent to the Xymon system. Translation: it lets an administrator acknowledge an alert via e-mail. Slay. πŸ‘‘


✨ ADDING INFORMATION TO THE REPLY MAIL ✨

ngl the default is kinda short β€” an acknowledgment is valid for 1 hour. So if you already know solving the problem is gonna take longer than that, you can change it πŸ’…

How? Just add delay=DURATION to the subject of your mail reply, or on a line in the reply message. The duration is in minutes, unless you add a trailing:

  • 'h' β€” for 'hours'
  • 'd' β€” for 'days'
  • 'w' β€” for 'weeks'

Obsessed with the flexibility fr fr.

You can also include a message that shows up on the status-page together with the acknowledgment β€” like to give an explanation for the issue, or drop some other info for the users 🌸 Two ways to do it:

  • tack it onto the end of the subject line as msg=Some random text, or
  • just enter it in the e-mail as the first non-blank line of text in the mail.
heads up: a "delay=N" line is ignored when looking for the message text, so don't stress about that one πŸ’œ

🧚 USE WITH PROCMAIL 🧚

To set up xymon-mailack, create a .procmailrc file in the xymon-users home-directory with the following contents:

DEFAULT=$HOME/Mailbox
LOGFILE=$HOME/procmail.log
:0
| $HOME/server/bin/xymon-mailack --env=$HOME/server/etc/xymonserver.cfg

copy-paste core, no notes πŸ’…


🌈 USE WITH QMAIL 🌈

If you're using Qmail to deliver mail locally, you can run xymon-mailack directly from a .qmail file. Set up the xymon-users .qmail file like this:

| $HOME/server/bin/xymon-mailack --env=$HOME/server/etc/xymonserver.cfg

iconic. one line. main character energy. ✨


πŸ‘‘ OPTIONS πŸ‘‘

  • --env=FILENAME β€” loads the environment from FILENAME, which is usually xymonserver.cfg. (your config bestie 🫢)
  • --debug β€” does NOT send a message to xymond, and instead dumps the message to stdout. perfect for snooping on what it's actually doing πŸ”

πŸ’€ SEE ALSO πŸ’€

xymond_alert(8), xymond(8), xymon(7)


okay that's the whole page, you ate that πŸ’… and for the cute sign-off: this lil masterpiece is brought to you by Xymon, Version 4.3.30: 4 Sep 2019. periodt. πŸ’–

πŸ“¦ where this page comes from