aspamd - Monitoring

PROBLEM

How can I monitor my aspamd service? 

ENVIRONMENT

• atmail aspamd

CAUSE

Requirement for logging and metrics.

RESOLUTION

 aspamd provides a number of ways to monitor its operation including logging and metrics.

Logging

aspamd logs information for every individual email scanned. The information gathered includes; scan engine, score, action, message recipients, mail from, ip address and headers returned. By default, if run in the terminal, aspamd logs to console. The systemd services aspamd and aspamd@egress log using syslog. The following configuration settings control logging.

   --logLevel value           Log Level (panic,fatal,error,warn,info,debug,trace) [$LOG_LEVEL]
   --syslogEnable             enable syslog [$SYSLOG_ENABLE]
   --syslogAddr value         syslog server. Value can be host:port. If not set, uses local syslog [$SYSLOG_ADDR]
   --syslogFacility value     set syslog facility, defaults to mail. See /usr/include/sys/syslog.h (default: 16) [$SYSLOG_FACILITY]

Metrics

aspamd integrates with Prometheus by publishing various metrics to an endpoint (default http://127.0.0.1:9996/metrics). The address can be configured as follows:

   --metricsAddr value        Prometheus /metrics address (default: "127.0.0.1:9996") [$METRICS]