1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
|
.TH "DOVEADM-SERVICE-STATUS" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-service-status\fR - Show information about dovecot services
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBservice status\fR \[lB]\fIservice\fR \[lB]...\[rB]\[rB]
.SH "DESCRIPTION"
.P
\fBdoveadm service status\fR produces a table with a line for each service, containing the following details:
.P
\fIname\fR
.RS 0
.RS 4
.P
the name of the service
.RE 0
.RE 0
.P
\fIprocess_count\fR
.RS 0
.RS 4
.P
the number of processes actually running for the service
.RE 0
.RE 0
.P
\fIprocess_avail\fR
.RS 0
.RS 4
.P
the number of additional processes that can be spawned for the service
.RE 0
.RE 0
.P
\fIprocess_limit\fR
.RS 0
.RS 4
.P
the maximum number of processes that can be active for the service
.RE 0
.RE 0
.P
\fIclient_limit\fR
.RS 0
.RS 4
.P
the maximum number of connections that the service will handle simultaneously
.RE 0
.RE 0
.P
\fIthrottle_secs\fR
.RS 0
.RS 4
.P
seconds to wait before launching another process when processes are dying unexpectedly early for the service
.RE 0
.RE 0
.P
\fIexit_failure_last\fR
.RS 0
.RS 4
.P
timestamp when the last process was terminated abnormally for the service
.RE 0
.RE 0
.P
\fIexit_failures_in_sec\fR
.RS 0
.RS 4
.P
number of abnormally terminated processes for the service in the last second
.RE 0
.RE 0
.P
\fIlast_drop_warning\fR
.RS 0
.RS 4
.P
timestamp when the last time a "dropping client connections" warning was logged
.RE 0
.RE 0
.P
\fIlisten_pending\fR
.RS 0
.RS 4
.P
if the master process is queuing connections that need to be dispatched
.RE 0
.RE 0
.P
\fIlistening\fR
.RS 0
.RS 4
.P
if service is listening
.RE 0
.RE 0
.P
\fIdoveadm_stop\fR
.RS 0
.RS 4
.P
if the service has been stopped by doveadm(1)
.RE 0
.RE 0
.P
\fIprocess_total\fR
.RS 0
.RS 4
.P
the total number of processes forked for the service since the service start.
.RE 0
.RE 0
.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
.P
\fB-f\fR \fIformatter\fR
.RS 0
.RS 4
.P
Specifies the \fIformatter\fR for formatting the output. Supported formatters are:
.P
\fBflow\fR
.RS 4
.P
prints each line with \fIkey\fR\fB=\fR\fIvalue\fR pairs.
.RE 0
.P
\fBpager\fR
.RS 4
.P
prints each \fIkey\fR: \fIvalue\fR pair on its own line and separates records with form feed character (\fB^L\fR).
.RE 0
.P
\fBtab\fR
.RS 4
.P
prints a table header followed by tab separated value lines.
.RE 0
.P
\fBtable\fR
.RS 4
.P
prints a table header followed by adjusted value lines.
.RE 0
.RE 0
.RE 0
.SH "ARGUMENTS"
.P
\fIservice\fR (optional)
.RS 0
.RS 4
.P
Filters the list according to the specified service or services. By default, all dovecot services are listed.
.RE 0
.RE 0
.SH "EXAMPLES"
.P
.RS 2
.nf
doveadm service status
.fi
.RE
.P
.RS 2
.nf
name: fs-auth
process_count: 0
process_avail: 0
process_limit: 1
client_limit: 1000
throttle_secs: 0
exit_failure_last: 0
exit_failures_in_sec: 0
last_drop_warning: 0
listen_pending: n
listening: y
doveadm_stop: n
process_total: 0
name: fs-server
.fi
.RE
.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), doveadm-process-status(1)
|