DOVEAD-STATS

Section: Dovecot (1)
Updated: February 2026
Index Return to Main Contents

---

 

NAME

dovead-stats- Inspect or reset stats  

SYNOPSIS

doveadm [lB]GLOBAL OPTIONS[rB] stats add [lB] -description <string> [rB] [lB] -exporter <name> [rB] [lB] -exporte-include <fields> [rB] [lB] -fields <fields> [rB] [lB]-group_by <fields> [rB] name <filter> doveadm [lB]GLOBAL OPTIONS[rB] stats dump [lB] -s <stats socket path> [rB] [lB] -r [rB] [lB] -f <fields> [rB] doveadm [lB]GLOBAL OPTIONS[rB] stats top [lB]-s <stats socket path>[rB] [lB]-b[rB] [lB]sort <field>[rB] doveadm [lB]GLOBAL OPTIONS[rB] stats remove [lB] <name> [rB] doveadm [lB]GLOBAL OPTIONS[rB] stats reopen  

DESCRIPTION

Commands to inspect and edit Dovecot stats/metrics generation.  

GLOBAL OPTIONS

Global doveadm(1) -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

-k

Preserve entire environment for doveadm, not just import_environment setting.

-v

Enables verbosity, including progress counter.

-i instanc-name

If using multiple Dovecot instances, choose the config file based on this instance name. See instance_name setting for more information.

-c confi-file

Read configuration from the given confi-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 [lB]GLOBAL OPTIONS[rB] stats add [lB] -description <string> [rB] [lB] -exporter <name> [rB] [lB] -exporte-include <fields> [rB] [lB] -fields <fields> [rB] [lB]-group_by <fields> [rB] name <filter> doveadm stats add is used to add metrics to statistics.  

OPTIONS

-description <string>

Huma-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.

-exporte-include <fields>

Specifies which parts of the event are exported to the serialized event. The fields are spac-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.

-grou-by <fields>

Creates a new group_by for dynamically generating su-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>[lB]/<mask>[rB]

: Match local or remote IP.

*

since=<timestamp>

: Match session start time.

*

connected

: Show only connected sessions.

 

stats dump

doveadm [lB]GLOBAL OPTIONS[rB] stats dump [lB] -s <stats socket path> [rB] [lB] -r [rB] [lB] -f <fields> [rB] doveadm stats dump is used to output statistics.  

OPTIONS

-f

TODO

-r

Resets statistics after dumping.

-s socketpath

Stats socket path.

 

stats remove

doveadm [lB]GLOBAL OPTIONS[rB] stats remove [lB] <name> [rB] doveadm stats remove is used to remove metrics from statistics.  

ARGUMENTS

name

The metric name to remove.

 

stats reopen

doveadm [lB]GLOBAL OPTIONS[rB] 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 ladovecot@dovecot.orgra. Information about reporting bugs is available at: https://dovecot.org/bugreport.html  

SEE ALSO

doveadm(1)

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

GLOBAL OPTIONS

COMMANDS

stats add

OPTIONS

ARGUMENTS

stats dump

OPTIONS

stats remove

ARGUMENTS

stats reopen

REPORTING BUGS

SEE ALSO