SA-CHECK_SPAMD(1p)

📦
version 4.0.2+svn1935691 · 9 versions
, in ubuntu stonking

✨ SA-CHECK_SPAMD — the Perl companion manual (section 1p, user-contributed Perl docs, bestie) ✨

okay so welcome to the girlies' guide to sa-check_spamd, a spamd monitoring script for use with Nagios, etc. yes the manual name is literally SA-CHECK_SPAMD(1p) and yes we're doing this in the group chat. buckle up 🎀

🌸 NAME 🌸

sa-check_spamd — spamd monitoring script for use with Nagios, etc.

🦋 SYNOPSIS 🦋

sa-check_spamd [options]

Options, here they all are, no skips, no cap:

 -c secs, --critical=secs          Critical ping response threshold
 -h, -?, --help                    Print usage message
 -H hostname, --hostname=hostname  Hostname of spamd service to ping
 -p port, --port=port              Port of spamd service to ping
 --socketpath=path                 Connect to given UNIX domain socket
 -t secs, --timeout=secs           Max time to wait for a ping response
 -v, --verbose                     Verbose debug output
 -V, --version                     Output version info
 -w secs, --warning=secs           Warning ping response threshold

💜 DESCRIPTION 💜

the whole point of this program, bestie, is to give you a way to monitor the status of spamd server processes. and what's spamd? it's the daemonized version of the spamassassin executable, and both of them ship inside the SpamAssassin distribution. cute little family 🫶

this program was designed to be used, as a plugin, with the Nagios service monitoring software available from http://nagios.org. literally built for it. it might also play nice with other service monitoring packages — no promises, but vibes. also it's genuinely useful as a command line utility on its own or as a component inside a custom shell script you wrote at 2am. main character energy for a monitoring script honestly 💅

✨ OPTIONS ✨

okay important heads up first: options of the long form can be shortened as long as they remain unambiguous — like, you can totally use --host instead of --hostname. as long as it's unambiguous, she's valid. slay ✨

  • -c secs, --critical=secs — Critical ping response threshold, in seconds. if a spamd ping response takes longer than the value you specified (in seconds, keep up), the program will exit with a value of 2 to indicate the critical status. this value must be at least as long as the value specified for warning, and less than the value specified for timeout. rules are rules 🚨
  • -h, -?, --help — Prints this usage message and exits. that's it. that's the whole thing. bye 👋
  • -H hostname, --hostname=hostname — The hostname, or IP address, of the spamd service to ping. by default the hostname localhost is used. but if --socketpath is set, this value will be ignored — she's not even looking at it, periodt.
  • -p port, --port=port — The port of the spamd service to ping. by default port 783 (the spamd default port number, iconic) is used. and again — if --socketpath is set, this value will be ignored. same energy as above 💀
  • --socketpath=path — Connect to given UNIX domain socket. use this instead of a hostname and TCP port. when it's set, any hostname and TCP port you specified will be ignored. it's giving "new number, who dis" 🦋
  • -t secs, --timeout=secs — The maximum time to wait for a ping response. once that's exceeded the program will exit with a value of 2 to indicate the critical status. the default timeout value is 45 seconds. the timeout must be no less than 1 second. and this value must be greater than the values specified for both the critical and warning values. don't fight the math, she always wins 😭
  • -v, --verbose — Display verbose debug output on STDOUT. for when you simply must know everything 🍓
  • -V, --version — Display version info on STDOUT. iconique. show her off 👑
  • -w secs, --warning=secs — Warning ping response threshold, in seconds. if a spamd ping response takes longer than the value specified (in seconds), and does not exceed the critical threshold value, the program will exit with a value of 1 to indicate the warning status. this value must be no longer than the value specified for critical, and less than the value specified for timeout. three numbers, all in a little situationship, all have to agree 🌈

🎀 EXIT CODES 🎀

the program will indicate the status of the spamd process being monitored by exiting with one of these values. this is how she communicates her feelings, okay 🙈

  • 0 — OK: A spamd ping response was received within all threshold times. we love a healthy daemon 💖
  • 1 — WARNING: A spamd ping response exceeded the warning threshold but not the critical threshold. she's slow but she's trying 🥺
  • 2 — CRITICAL: A spamd ping response exceeded either the critical threshold or the timeout value. red flag, unwell, call someone 🔥
  • 3 — UNKNOWN: An error, probably caused by a missing dependency or an invalid configuration parameter being supplied, occurred in the sa-check_spamd program. mystery behaviour, we don't know her 💀

🧚 SEE ALSO 🧚

spamc(1) spamd(1) spamassassin(1)

go read your sisters' manuals too, they know things 🫶

🌟 PREREQUISITES 🌟

Mail::SpamAssassin version 3.1.1 or higher (3.1.6 or higher recommended)

like. please have the module. she cannot function without the module. manifesting a recent version for you ✨

🌈 AUTHOR 🌈

Daryl C. W. O'Shea, DOS Technologies <spamassassin@dostech.ca>

thank you for your service, king 👑

sa-check_spamd is distributed under the Apache License, Version 2.0, as described in the file "LICENSE" included with the Apache SpamAssassin distribution and available at http://www.apache.org/licenses/LICENSE-2.0

Copyright (C) 2015 The Apache Software Foundation

legal girlie moment: license details are load-bearing, don't skip them, the lawyers are watching 🎀

okay that's the whole page, you ate it, you understood it, you're now a spamd-monitoring main character 🌸

this was the Perl documentation for sa-check_spamd, section 1p, from perl v5.40.1, dated 2026-07-23. mwah, love u, go ping something 💖✨🦋

📦 where this page comes from