File: o-telemetry.rst.txt

package info (click to toggle)
cyrus-imapd 3.6.1-4%2Bdeb12u3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 80,688 kB
  • sloc: ansic: 255,928; perl: 97,730; javascript: 9,266; sh: 5,537; yacc: 2,651; cpp: 2,128; makefile: 2,099; lex: 660; xml: 621; python: 388; awk: 303; asm: 262
file content (22 lines) | stat: -rw-r--r-- 1,145 bytes parent folder | download | duplicates (20)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.. _faqs-o-telemetry:

How to enable telemetry
-----------------------

To enable telemetry logging for a user, create a directory on disk for that user. Cyrus will automatically write logging information to this directory for all new connections. You don't need to restart Cyrus; closing the mail client and restarting it will do the trick.


The directory path is:

.. code-block:: bash

    mkdir $configdirectory/log/$userid/             # for example /var/imap/log/darth
    chown cyrus $configdirectory/log/$userid/       # The cyrus user needs write access to this directory.

If you have virtdomains enabled, then the username is the login name. In this case if you login as ``darth@vader.net``, then the path is ``/var/imap/log/darth@vader.net/``

The folder will contain files called ``imapd-$pid``, e.g. imapd-12345.  It might also have pop3 files, httpd files, one for each daemon.  The first part of the name is the service name from :cyrusman:`cyrus.conf(5)`.

.. warning::

    These log files won't contain passwords, but may contain other confidential user data such as the content of emails. Check them before sharing publicly!