doveadm-stats1
Inspect or reset stats
Usage
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
Overview
Commands to inspect and edit Dovecot stats/metrics generation.
Options
Global doveadm(1) options:
-
-D -
Enables verbosity and debug messages.
-
-O -
Do not read any config file, just use defaults. The
dovecot_storage_versionsetting defaults to the latest version, but can be overridden with-o.
-
-k -
Preserve entire environment for doveadm, not just
import_environmentsetting.
-
-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_namesetting 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
-ooption 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
durationfield 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.
Releases
6 releases since Debian 9 (Stretch); the text changed 4 times.
--description since Debian 13 (Trixie);
--exporter since Debian 13 (Trixie);
--exporter-include since Debian 13 (Trixie);
--fields since Debian 13 (Trixie);
--group-by since Debian 13 (Trixie);
-D since Debian 13 (Trixie);
-O since Debian 13 (Trixie);
-c since Debian 13 (Trixie);
-f since Debian 13 (Trixie);
-i since Debian 13 (Trixie);
-k since Debian 13 (Trixie);
-o since Debian 13 (Trixie);
-r since Debian 13 (Trixie);
-v since Debian 13 (Trixie).
-b until Debian 12 (Bookworm).