Dovecot icon



Plugin: python.d.plugin Module: dovecot


This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.

It uses the dovecot socket and executes the EXPORT global command to get the statistics.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior


If no configuration is given, the collector will attempt to connect to dovecot using unix socket localized in /var/run/dovecot/stats


The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.



Dovecot configuration

The Dovecot UNIX socket should have R/W permissions for user netdata, or Dovecot should be configured with a TCP/IP socket.



The configuration file name for this integration is python.d/dovecot.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/dovecot.conf


There are 2 sections:

  • Global variables
  • One or more JOBS that can define multiple different instances to monitor.

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
socket Use this socket to communicate with Devcot /var/run/dovecot/stats no
host Instead of using a socket, you can point the collector to an ip for devcot statistics. no
port Used in combination with host, configures the port devcot listens to. no


Local TCP

A basic TCP configuration.

 name: 'local'
 host: ''
 port: 24242

Local socket

A basic local socket configuration

 name: 'local'
 socket: '/var/run/dovecot/stats'


Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Dovecot instance

These metrics refer to the entire monitored application.

This scope has no labels.


Metric Dimensions Unit
dovecot.sessions active sessions number
dovecot.logins logins number
dovecot.commands commands commands
dovecot.faults minor, major faults
dovecot.context_switches voluntary, involuntary switches read, write KiB/s read, write kilobits/s
dovecot.syscalls read, write syscalls/s
dovecot.lookup path, attr number/s
dovecot.cache hits hits/s
dovecot.auth ok, failed attempts
dovecot.auth_cache hit, miss number


There are no alerts configured by default for this integration.


Debug Mode

To troubleshoot issues with the dovecot 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 dovecot debug trace

Getting Logs

If you’re encountering problems with the dovecot collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

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 dovecot

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:

grep dovecot /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:

docker logs netdata 2>&1 | grep dovecot

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo