Debian Codegraph @

doc/html/_sources/imap/reference/faqs/o-telemetry.rst.txt

raw
1 .. _faqs-o-telemetry:
2
3 How to enable telemetry
4 -----------------------
5
6 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.
7
8
9 The directory path is:
10
11 .. code-block:: bash
12
13 mkdir $configdirectory/log/$userid/ # for example /var/imap/log/darth
14 chown cyrus $configdirectory/log/$userid/ # The cyrus user needs write access to this directory.
15
16 If you have virtdomains enabled, then the username is the login name. In this case if you login as ``[email protected]``, then the path is ``/var/imap/log/[email protected]/``
17
18 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)`.
19
20 .. warning::
21
22 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!