---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from Dovecot
url: https://docs.influxdata.com/telegraf/v1/input-plugins/dovecot/
estimated_tokens: 1430
product: Telegraf
version: v1
---

-   Telegraf v0.10.3+

# Dovecot Input Plugin

This plugin uses the Dovecot [v2.1 stats protocol](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) to gather metrics about configured domains of [Dovecot](https://www.dovecot.org/) servers. You can use this plugin on Dovecot up to and including version v2.3.x.

Dovecot v2.4+ has the old protocol removed and this plugin will not work. Please use Dovecot’s [Openmetrics exporter](https://doc.dovecot.org/latest/core/config/statistics.html#openmetrics) in combination with the [http input plugin](/telegraf/v1/plugins/#input-http) and `openmetrics` data format for newer versions of Dovecot.

**Introduced in:** Telegraf v0.10.3 **Tags:** server **OS support:** all

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# Read metrics about dovecot servers
[[inputs.dovecot]]
  ## specify dovecot servers via an address:port list
  ##  e.g.
  ##    localhost:24242
  ## or as an UDS socket
  ##  e.g.
  ##    /var/run/dovecot/old-stats
  ##
  ## If no servers are specified, then localhost is used as the host.
  servers = ["localhost:24242"]

  ## Type is one of "user", "domain", "ip", or "global"
  type = "global"

  ## Wildcard matches like "*.com". An empty string "" is same as "*"
  ## If type = "ip" filters should be <IP/network>
  filters = [""]
```

## Metrics

-   dovecot
    -   tags:
        -   server (hostname)
        -   type (query type)
        -   ip (ip addr)
        -   user (username)
        -   domain (domain name)
    -   fields:
        -   reset\_timestamp (string)
        -   last\_update (string)
        -   num\_logins (integer)
        -   num\_cmds (integer)
        -   num\_connected\_sessions (integer)
        -   user\_cpu (float)
        -   sys\_cpu (float)
        -   clock\_time (float)
        -   min\_faults (integer)
        -   maj\_faults (integer)
        -   vol\_cs (integer)
        -   invol\_cs (integer)
        -   disk\_input (integer)
        -   disk\_output (integer)
        -   read\_count (integer)
        -   read\_bytes (integer)
        -   write\_count (integer)
        -   write\_bytes (integer)
        -   mail\_lookup\_path (integer)
        -   mail\_lookup\_attr (integer)
        -   mail\_read\_count (integer)
        -   mail\_read\_bytes (integer)
        -   mail\_cache\_hits (integer)

## Example Output

```text
dovecot,server=dovecot-1.domain.test,type=global clock_time=101196971074203.94,disk_input=6493168218112i,disk_output=17978638815232i,invol_cs=1198855447i,last_update="2016-04-08 11:04:13.000379245 +0200 CEST",mail_cache_hits=68192209i,mail_lookup_attr=0i,mail_lookup_path=653861i,mail_read_bytes=86705151847i,mail_read_count=566125i,maj_faults=17208i,min_faults=1286179702i,num_cmds=917469i,num_connected_sessions=8896i,num_logins=174827i,read_bytes=30327690466186i,read_count=1772396430i,reset_timestamp="2016-04-08 10:28:45 +0200 CEST",sys_cpu=157965.692,user_cpu=219337.48,vol_cs=2827615787i,write_bytes=17150837661940i,write_count=992653220i 1460106266642153907
```

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [Dovecot Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/dovecot/README.md)