Plugin: python.d.plugin Module: exim
This collector monitors Exim mail queue.
It uses the exim
command line binary to get the statistics.
This collector is supported on all platforms.
This collector only supports collecting metrics from a single instance of this integration.
Assuming setup prerequisites are met, the collector will try to gather statistics using the method described above, even without any configuration.
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
The module uses the exim
binary, which can only be executed as root by default. We need to allow other users to exim
binary. We solve that adding queue_list_requires_admin
statement in exim configuration and set to false
, because it is true
by default. On many Linux distributions, the default location of exim
configuration is in /etc/exim.conf
.
exim
configuration with your preferred editor and add:
queue_list_requires_admin = false
exim
and NetdataOn a WHM server, you can reconfigure exim
over the WHM interface with the following steps.
queue_list_requires_admin
and set to false
The configuration file name for this integration is python.d/exim.conf
.
You can edit the configuration file using the edit-config
script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/exim.conf
There are 2 sections:
The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
Every configuration JOB starts with a job_name
value which will appear in the dashboard, unless a name
parameter is specified.
Name | Description | Default | Required |
---|---|---|---|
update_every | Sets the default data collection frequency. | 5 | no |
priority | Controls the order of charts at the netdata dashboard. | 60000 | no |
autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |
penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |
name | Job name. This value will overwrite the job_name value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. |
no | |
command | Path and command to the exim binary |
exim -bpc | no |
A basic local exim install
local:
command: 'exim -bpc'
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
Metric | Dimensions | Unit |
---|---|---|
exim.qemails | emails | emails |
There are no alerts configured by default for this integration.
To troubleshoot issues with the exim
collector, run the python.d.plugin
with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
Navigate to the plugins.d
directory, usually at /usr/libexec/netdata/plugins.d/
. If that’s not the case on
your system, open netdata.conf
and look for the plugins
setting under [directories]
.
cd /usr/libexec/netdata/plugins.d/
Switch to the netdata
user.
sudo -u netdata -s
Run the python.d.plugin
to debug the collector:
./python.d.plugin exim debug trace
If you’re encountering problems with the exim
collector, follow these steps to retrieve logs and identify potential issues:
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep exim
Locate the collector log file, typically at /var/log/netdata/collector.log
, and use grep
to filter for collector’s name:
grep exim /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep exim