.TH "DOVEADM-STATS" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-stats\fR - Inspect or reset stats
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats add\fR \[lB] \fB--description\fR \fI<string>\fR \[rB] \[lB] \fB--exporter\fR \fI<name>\fR \[rB] \[lB] \fB--exporter-include\fR \fI<fields>\fR \[rB] \[lB] \fB--fields\fR \fI<fields>\fR \[rB] \[lB]\fB--group_by\fR \fI<fields>\fR \[rB] \fIname\fR \fI<filter>\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats dump\fR \[lB] \fB-s\fR \fI<stats socket path>\fR \[rB] \[lB] \fB-r\fR \[rB] \[lB] \fB-f\fR \fI<fields>\fR \[rB]
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats top\fR \[lB]\fB-s <stats socket path>\fR\[rB] \[lB]\fB-b\fR\[rB] \[lB]\fBsort\fR \fI<field>\fR\[rB]
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats remove\fR \[lB] \fI<name>\fR \[rB]
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats reopen\fR
.SH "DESCRIPTION"
.P
Commands to inspect and edit Dovecot stats/metrics generation.
.SH "GLOBAL OPTIONS"
.P
Global doveadm(1) 
.P
\fB-D\fR
.RS 0
.RS 4
.P
Enables \fIverbosity\fR and debug messages.
.RE 0

.RE 0

.P
\fB-O\fR
.RS 0
.RS 4
.P
Do not read any config file, just use defaults. The \fBdovecot_storage_version\fR setting defaults to the latest version, but can be overridden with 
.RE 0

.RE 0

.P
\fB-k\fR
.RS 0
.RS 4
.P
Preserve entire environment for doveadm, not just \fBimport_environment\fR setting.
.RE 0

.RE 0

.P
\fB-v\fR
.RS 0
.RS 4
.P
Enables verbosity, including progress counter.
.RE 0

.RE 0

.P
\fB-i\fR \fIinstance-name\fR
.RS 0
.RS 4
.P
If using multiple Dovecot instances, choose the config file based on this instance name.
.P
See \fBinstance_name\fR setting for more information.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Read configuration from the given \fIconfig-file\fR. By default it first reads config socket, and then falls back to \fI/etc/dovecot/dovecot.conf\fR. You can also point this to config socket of some instance running compatible version.
.RE 0

.RE 0

.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0

.RE 0

.SH "COMMANDS"
.SS "stats add"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats add\fR \[lB] \fB--description\fR \fI<string>\fR \[rB] \[lB] \fB--exporter\fR \fI<name>\fR \[rB] \[lB] \fB--exporter-include\fR \fI<fields>\fR \[rB] \[lB] \fB--fields\fR \fI<fields>\fR \[rB] \[lB]\fB--group_by\fR \fI<fields>\fR \[rB] \fIname\fR \fI<filter>\fR
.P
\fBdoveadm stats add\fR is used to add metrics to statistics.
.SS "OPTIONS"
.P
\fB--description\fR \fI<string>\fR
.RS 0
.RS 4
.P
Human-readable description of the metric. This is included in the HELP text sent to OpenMetrics.
.RE 0

.RE 0

.P
\fB--exporter\fR \fI<name>\fR
.RS 0
.RS 4
.P
Export events matching the filter with this event exporter. If empty, the events are used only for statistics, and no exporting is done.
.RE 0

.RE 0

.P
\fB--exporter-include\fR \fI<fields>\fR
.RS 0
.RS 4
.P
Specifies which parts of the event are exported to the serialized event. The fields are space-separated.
.RE 0

.RE 0

.P
\fB--fields\fR \fI<fields>\fR
.RS 0
.RS 4
.P
A list of fields included in the metric. All events have a default \fBduration\fR field that does not need to be listed explicitly.
.RE 0

.RE 0

.P
\fB--group-by\fR \fI<fields>\fR
.RS 0
.RS 4
.P
Creates a new group_by for dynamically generating sub-metrics based on the specified field's values.
.RE 0

.RE 0

.SS "ARGUMENTS"
.P
\fIname\fR
.RS 0
.RS 4
.P
Metric name.
.RE 0

.RE 0

.P
\fIfilter\fR
.RS 0
.RS 4
.P
Filter options:
.RS 4
.IP \(bu 4
\fBuser=<wildcard>\fR
.RE 0

.P
: Match user.
.RS 4
.IP \(bu 4
\fBdomain=<wildcard>\fR
.RE 0

.P
: Match DNS domain name.
.RS 4
.IP \(bu 4
\fBsession=<str>\fR
.RE 0

.P
: Match session identifier.
.RS 4
.IP \(bu 4
\fBip=<ip>\[lB]/<mask>\[rB]\fR
.RE 0

.P
: Match local or remote IP.
.RS 4
.IP \(bu 4
\fBsince=<timestamp>\fR
.RE 0

.P
: Match session start time.
.RS 4
.IP \(bu 4
\fBconnected\fR
.RE 0

.P
: Show only connected sessions.
.RE 0

.RE 0

.SS "stats dump"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats dump\fR \[lB] \fB-s\fR \fI<stats socket path>\fR \[rB] \[lB] \fB-r\fR \[rB] \[lB] \fB-f\fR \fI<fields>\fR \[rB]
.P
\fBdoveadm stats dump\fR is used to output statistics.
.SS "OPTIONS"
.P
\fB-f\fR
.RS 0
.RS 4
.P
TODO
.RE 0

.RE 0

.P
\fB-r\fR
.RS 0
.RS 4
.P
Resets statistics after dumping.
.RE 0

.RE 0

.P
\fB-s\fR \fIsocketpath\fR
.RS 0
.RS 4
.P
Stats socket path.
.RE 0

.RE 0

.SS "stats remove"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats remove\fR \[lB] \fI<name>\fR \[rB]
.P
\fBdoveadm stats remove\fR is used to remove metrics from statistics.
.SS "ARGUMENTS"
.P
\fIname\fR
.RS 0
.RS 4
.P
The metric name to remove.
.RE 0

.RE 0

.SS "stats reopen"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBstats reopen\fR
.P
\fBdoveadm stats reopen\fR is used to reopen any file exporter files.
.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
doveadm(1)