.. _log-files:

*********
Log Files
*********

Every XiVO service has its own log file, placed in :file:`/var/log`.


asterisk
--------

The Asterisk log files are managed by logrotate.

It's configuration files :file:`/etc/logrotate.d/asterisk` and :file:`/etc/asterisk/logger.conf`

The message log level is enabled by default in :file:`logger.conf` and contains notices, warnings
and errors. The full log entry is commented in :file:`logger.conf` and should only be enabled when
verbose debugging is required. Using this option in production would produce VERY large log files.

* Files location: :file:`/var/log/asterisk/\*`
* Number of archived files: 15
* Rotation frequence: Daily

postgresql
----------

* File location: :file:`/var/log/postgresql/postgresql-17-main.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-manage-db`
* Number of archived files: 15
* Rotation frequence: Daily

  
xivo-agentd
-----------

* File location: :file:`/var/log/xivo-agentd.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-agentd`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-agid
---------

* File location: :file:`/var/log/xivo-agid.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-agid`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-amid
---------

* File location: :file:`/var/log/xivo-amid.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-amid`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-auth
---------

* File location: :file:`/var/log/xivo-auth.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-auth`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-call-logd
--------------

* File location: :file:`/var/log/xivo-call-logd.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-call-logd`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-confd
----------

* File location: :file:`/var/log/xivo-confd.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-confd`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-confgend
-------------

The xivo-confgend daemon output is sent to the file specified with the ``--logfile`` parameter when
launched with twistd.

The file location can be changed by customizing the xivo-confgend.service unit file.

* File location: :file:`/var/log/xivo-confgend.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-confgend`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-ctid
---------

* File location: :file:`/var/log/xivo-ctid.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-ctid`
* Number of archived log files: 15
* Rotation frequence: Daily


xivo-dird
---------

* File location: :file:`/var/log/xivo-dird.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-dird`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-dird-phoned
----------------

* File location: :file:`/var/log/xivo-dird-phoned.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-dird-phoned`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-dxtora
-----------

* File location: :file:`/var/log/xivo-dxtora.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-dxtora`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-provd
----------

* File location: :file:`/var/log/xivo-provd.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-provd`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-purge-db
-------------

* File location: :file:`/var/log/xivo-purge-db.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-purge-db`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-stat
---------

* File location: :file:`/var/log/xivo-stat.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-stat`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-sysconfd
-------------

* File location: :file:`/var/log/xivo-sysconfd.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-sysconfd`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-upgrade
------------

* File location: :file:`/var/log/xivo-upgrade.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-upgrade`
* Number of archived files: 15
* Rotation frequence: Daily


xivo-web-interface
------------------

* File location: :file:`/var/log/xivo-web-interface/\*.log`
* Rotate configuration: :file:`/etc/logrotate.d/xivo-web-interface`
* Number of archived files: 21
* Rotation frequence: Daily


.. _collecting-logs:

Collecting logs
---------------

The ``xivo-collect-logs`` script gathers the logs of a given day into a single directory and tarball,
ready to be attached to a support ticket. It is available on every node type (XiVO PBX, XiVO CC,
media server) and must be run as ``root``::

    xivo-collect-logs <YYYYMMDD> [ticket number]

* ``YYYYMMDD`` is the day to collect logs for (e.g. ``20260610``).
* ``ticket number`` is optional. When given, the logs go to :file:`/var/local/issue<ticket number>`;
  otherwise a temporary directory is used and its path is printed at the end.

The script detects the role of the node and collects the relevant logs (system logs plus the
services running for that role). On a XiVO PBX or UC addon node, the media servers and the XiVO CC
are discovered from the local database and their logs are collected over SSH (as ``root``); each
node's logs land under its own ``<node>/`` sub-directory, all packed into one tarball.

.. note:: Collecting the media servers logs over SSH relies on the :file:`/root/.ssh/rsync_xds` key
   being present on the XiVO PBX node. Any node whose logs could not be collected is listed at the
   end of the run so it can be retrieved manually.