This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.

Statistics

This page is about the statistics support for Dovecot v2.3. For v2.1 and v2.2 see Statistics/Old.

Dovecot v2.3 supports gathering statistics from "events". Eventually all of the log messages should be events, so it will be possible to configure Dovecot to get statistics for anything that is logged. For debug messages it's possible to get statistics even if the message itself isn't logged.

Currently there are no statistics logged by default (but this might change). You'll need to add some metrics:

metric name {
  # Individual events can be identified either by their name or source file:line location.
  # The source location of course can change between Dovecot versions, so it should be
  # avoided.
  event_name = example_event_name
  #source_location = example.c:123

  # Space-separated list of categories that must match the event (e.g. "mail" or "storage")
  #categories = 

  # List of fields in event parameters that are included in the metrics.
  # All events have a default "duration" field that doesn't need to be listed here.
  #fields = 

  # List of key=value pairs that must match the event. The value can contain '?' and '*' wildcards.
  #filter {
  #  field_key = wildcard
  #}
}

Listing Statistics

The gathered statistics are available by running:

doveadm stats dump

Each event has a "duration" field, which tracks in microseconds how long the event existed. For example with imap_command_finished field it could be:

metric_name          field    count sum     min max    avg   median %95
imap_commands        duration 35    1190122 162 340477 34003 244    188637

The above means:

The other fields (than duration) track whatever that field represents. For example with imap_command_finished's bytes_in field could be tracking how many bytes were being used by the IMAP commands. Non-numeric fields can also be tracked, although only the "count" is relevant to those.

The stats counters are reset whenever the stats process is started, which also means a dovecot reload will reset statistics. Using doveadm stats -r parameter will also reset the statistics atomically after they're dumped.

Events

Current list of named events and their parameters:

imap_command_finished

http_request_finished

Examples

metric imap_select_no {
  event_name = imap_command_finished
  filter {
    name = SELECT
    tagged_reply_state = NO
  }
}
metric imap_select_no_notfound {
  event_name = imap_command_finished
  filter {
    name = SELECT
    tagged_reply = NO*Mailbox doesn't exist:*
  }
}

metric storage_http_gets {
  event_name = http_request_finished
  categories = storage
  filter {
    method = get
  }
}

Statistics (last edited 2018-04-24 09:24:28 by TimoSirainen)