Man page - doveadm-stats(1)
Packages contas this manual
- doveadm-compress-connect(1)
- doveadm-mail-fs(1)
- doveadm-proxy(1)
- doveadm-save(1)
- doveadm-instance(1)
- deliver(1)
- doveadm-service-stop(1)
- doveadm-purge(1)
- doveadm-help(1)
- doveadm-who(1)
- doveadm-auth(1)
- doveadm-altmove(1)
- doveadm-quota(1)
- maildirmake.dovecot(1)
- doveadm-flags(1)
- doveadm-process-status(1)
- dovecot-sysreport(1)
- doveadm-deduplicate(1)
- doveadm-penalty(1)
- doveadm-acl(1)
- doveadm-search-query(7)
- doveadm-pw(1)
- doveadm-service-status(1)
- doveadm-stats(1)
- doveadm-exec(1)
- doveadm-force-resync(1)
- doveadm-kick(1)
- doveadm-mailbox(1)
- doveadm-user(1)
- doveadm-sync(1)
- doveadm-stop(1)
- doveadm-indexer(1)
- doveadm(1)
- dovecot(1)
- doveadm-index(1)
- doveadm-import(1)
- doveadm-search(1)
- dovecot-lda(1)
- doveadm-copy(1)
- pigeonhole(7)
- doveadm-dump(1)
- doveconf(1)
- doveadm-config(1)
- doveadm-mail-dict(1)
- doveadm-fetch(1)
- doveadm-fts(1)
- doveadm-log(1)
- doveadm-rebuild(1)
- doveadm-mailbox-cryptokey(1)
- doveadm-dict(1)
- doveadm-move(1)
- doveadm-expunge(1)
- doveadm-sieve(1)
- doveadm-reload(1)
- doveadm-backup(1)
- doveadm-fs(1)
apt-get install dovecot-core
Manual
| DOVEADM-STATS(1) | Dovecot | DOVEADM-STATS(1) |
NAME
doveadm-stats - Inspect or reset stats
SYNOPSIS
doveadm [GLOBAL OPTIONS] stats add [ --description <string> ] [ --exporter <name> ] [ --exporter-include <fields> ] [ --fields <fields> ] [--group_by <fields> ] name <filter>
doveadm [GLOBAL OPTIONS] stats dump [ -s <stats socket path> ] [ -r ] [ -f <fields> ]
doveadm [GLOBAL OPTIONS] stats top [-s <stats socket path>] [-b] [sort <field>]
doveadm [GLOBAL OPTIONS] stats remove [ <name> ]
doveadm [GLOBAL OPTIONS] stats reopen
DESCRIPTION
Commands to inspect and edit Dovecot stats/metrics generation.
GLOBAL OPTIONS
Global doveadm(1) options:
-D
Enables verbosity and debug messages.
-O
Do not read any config file, just use defaults. The dovecot_storage_version setting defaults to the latest version, but can be overridden with -o.
-k
Preserve entire environment for doveadm, not just import_environment setting.
-v
Enables verbosity, including progress counter.
-i instance-name
If using multiple Dovecot instances, choose the config file based on this instance name.
See instance_name setting for more information.
-c config-file
Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.
-o setting=value
Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.
COMMANDS
stats add
doveadm [GLOBAL OPTIONS] stats add [ --description <string> ] [ --exporter <name> ] [ --exporter-include <fields> ] [ --fields <fields> ] [--group_by <fields> ] name <filter>
doveadm stats add is used to add metrics to statistics.
OPTIONS
--description <string>
Human-readable description of the metric. This is included in the HELP text sent to OpenMetrics.
--exporter <name>
Export events matching the filter with this event exporter. If empty, the events are used only for statistics, and no exporting is done.
--exporter-include <fields>
Specifies which parts of the event are exported to the serialized event. The fields are space-separated.
--fields <fields>
A list of fields included in the metric. All events have a default duration field that does not need to be listed explicitly.
--group-by <fields>
Creates a new group_by for dynamically generating sub-metrics based on the specified field's values.
ARGUMENTS
name
Metric name.
filter
Filter options:
- •
- user=<wildcard>
: Match user.
- •
- domain=<wildcard>
: Match DNS domain name.
- •
- session=<str>
: Match session identifier.
- •
- ip=<ip>[/<mask>]
: Match local or remote IP.
- •
- since=<timestamp>
: Match session start time.
- •
- connected
: Show only connected sessions.
stats dump
doveadm [GLOBAL OPTIONS] stats dump [ -s <stats socket path> ] [ -r ] [ -f <fields> ]
doveadm stats dump is used to output statistics.
OPTIONS
-f
TODO
-r
Resets statistics after dumping.
-s socketpath
Stats socket path.
stats remove
doveadm [GLOBAL OPTIONS] stats remove [ <name> ]
doveadm stats remove is used to remove metrics from statistics.
ARGUMENTS
name
The metric name to remove.
stats reopen
doveadm [GLOBAL OPTIONS] stats reopen
doveadm stats reopen is used to reopen any file exporter files.
REPORTING BUGS
Report bugs, including doveconf -n output, to the Dovecot Mailing List ⟨dovecot@dovecot.org⟩. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
SEE ALSO
doveadm(1)
| March 2026 | 2b97ab9 |