~ubuntu-branches/ubuntu/utopic/dovecot/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/wiki/Plugins.Stats.txt

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2014-01-08 09:35:49 UTC
  • mfrom: (4.1.35 sid)
  • Revision ID: package-import@ubuntu.com-20140108093549-i72o93pux8p0dlaf
Tags: 1:2.2.9-1ubuntu1
* Merge from Debian unstable, remaining changes:
  + Add mail-stack-delivery package:
    - Update d/rules
    - d/control: convert existing dovecot-postfix package to a dummy
      package and add new mail-stack-delivery package.
    - Update maintainer scripts.
    - Rename d/dovecot-postfix.* to debian/mail-stack-delivery.*
    - d/mail-stack-delivery.preinst: Move previously installed backups and
      config files to a new package namespace.
    - d/mail-stack-delivery.prerm: Added to handle downgrades.
  + Use Snakeoil SSL certificates by default:
    - d/control: Depend on ssl-cert.
    - d/dovecot-core.postinst: Relax grep for SSL_* a bit.
  + Add autopkgtest to debian/tests/*.
  + Add ufw integration:
    - d/dovecot-core.ufw.profile: new ufw profile.
    - d/rules: install profile in dovecot-core.
    - d/control: dovecot-core - suggest ufw.
  + d/dovecot-core.dirs: Added usr/share/doc/dovecot-core
  + Add apport hook:
    - d/rules, d/source_dovecot.py
  + Add upstart job:
    - d/rules, d/dovecot-core.dovecot.upstart, d/control,
      d/dovecot-core.dirs, dovecot-imapd.{postrm, postinst, prerm},
      d/dovecot-pop3d.{postinst, postrm, prerm}.
      d/mail-stack-deliver.postinst: Convert init script to upstart.
  + Use the autotools-dev dh addon to update config.guess/config.sub for
    arm64.
* Dropped changes, included in Debian:
  - Update Dovecot name to reflect distribution in login greeting.
  - Update Drac plugin for >= 2.0.0 support.
* d/control: Drop dovecot-postfix package as its no longer required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Stats plugin
 
2
============
 
3
 
 
4
Stats plugin can be used to send statistics (CPU, disk usage, etc.) from mail
 
5
processes to the stats process. The stats process can later be queried what's
 
6
going on in the system. With imap_stats plugin you can get per-command level
 
7
statistics for IMAP commands.
 
8
 
 
9
Configuration
 
10
-------------
 
11
 
 
12
---%<-------------------------------------------------------------------------
 
13
mail_plugins = $mail_plugins stats
 
14
protocol imap {
 
15
  mail_plugins = $mail_plugins imap_stats
 
16
}
 
17
plugin {
 
18
  # How often to send statistics to the stats process. (Must be specified or
 
19
stats are disabled.)
 
20
  stats_refresh = 5s
 
21
  # Track per-command statistics.
 
22
  stats_track_cmds = yes
 
23
}
 
24
---%<-------------------------------------------------------------------------
 
25
 
 
26
Since the stats process tracks quite a lot of statistics, its memory usage has
 
27
to be limited by forgetting the more detailed stats first. These settings
 
28
configure how the memory usage it handled:
 
29
 
 
30
---%<-------------------------------------------------------------------------
 
31
stats_memory_limit = 16 M
 
32
 
 
33
stats_command_min_time = 1 mins
 
34
stats_domain_min_time = 12 hours
 
35
stats_ip_min_time = 12 hours
 
36
stats_session_min_time = 15 mins
 
37
stats_user_min_time = 1 hours
 
38
---%<-------------------------------------------------------------------------
 
39
 
 
40
Looking
 
41
=======
 
42
 
 
43
The 'doveadm stats dump' can be used to output raw statistics data. Ideally
 
44
there would be a nice GUI that could be used to zoom around in the data, but
 
45
that's not implemented yet. For now there is an internal 'doveadm stats top'
 
46
command, but a much better one can be found as a perl script:stats-top.pl
 
47
[http://www.dovecot.org/tools/stats-top.pl], which also requires stats.pl
 
48
[http://www.dovecot.org/tools/stats.pl].
 
49
 
 
50
(This file was created from the wiki on 2013-11-24 04:42)