.. include:: /includes.rst.txt

.. comments - headings

   # with overline, for parts
   * with overline, for chapters
   = for sections
   - for subsections
   ^ for subsubsections
   " for paragraphs
   * for H5
   + for H6

.. index:: pair: Configuring ; Active Logging

.. _logging:

Logging
-------

EDG generates several different logs:

* :ref:`edg_log`
* :ref:`tomcat_access_log`
* :ref:`other_tomcat_logs`

.. _edg_log:

The EDG log
^^^^^^^^^^^

This is a general application log. It is located in the workspace directory (as specified in the :ref:`setup_file`) under ``logs/edg.log``.
The latest log can also be downloaded via the :ref:`DownloadEDGLogAdminLink`.

EDG uses the `Log4j <https://logging.apache.org/log4j/2.x/index.html>`_ logging library.
As a result, the customer can set the log level, the format of the log, and the log file rotation policy.

The configuration files are in ``<CATALINA_BASE>/webapps/edg/WEB-INF/setupdata``.

.. note:: For **EDG Studio**, these files are located in the ``conf`` subdirectory of the Studio download instead.

Configuring log file sizes and rotation policy
""""""""""""""""""""""""""""""""""""""""""""""

To configure the log file size and rotation policy, modify the EDG configuration file ``<CATALINA_BASE>/webapps/edg/WEB-INF/setupdata/log4j2-base.xml``.
Refer to the `Log4j Appenders documentation <https://logging.apache.org/log4j/2.x/manual/appenders.html>`_ for details.

Configuring log levels
""""""""""""""""""""""

To configure log levels, modify the EDG configuration file ``<CATALINA_BASE>/webapps/edg/WEB-INF/setupdata/log4j2-loggers.xml``.

This file contains a Log4j ``<Loggers>`` configuration. It is described in detail `here <https://logging.apache.org/log4j/2.x/manual/configuration.html#configuring-loggers>`_.

Here, the log level of certain "loggers" can be changed to enable or disable the logging of certain information.
This is done by adding ``<Logger>`` elements:

.. code-block:: xml

  <Logger name="loggername" level="LEVEL"/>

Supported levels are (from least to most information logged): ``OFF``, ``FATAL``, ``ERROR``, ``WARN``, ``INFO``, ``DEBUG``, ``TRACE``, ``ALL``.

* To enable verbose logging for all of TopBraid EDG, set the following loggers to ``ALL``: ``org.topbraid``, ``org.topbraidlive``, ``com.topquadrant``.
* To enable the logging of failed HTTP requests to remote SPARQL endpoints (for Remote Data Support and SPARQL queries that use the SERVICE keyword), set the logger ``org.topbraid.sparql.RemoteSparqlLogger`` to ``ALL``



.. _tomcat_access_log:

The Tomcat access log
^^^^^^^^^^^^^^^^^^^^^

This is a web server access log that records all HTTP requests. It is maintained by Tomcat and usually located at ``<CATALINA_BASE>/logs/localhost_access_log.*``.

See also: :ref:`tomcat_configuration`


.. _other_tomcat_logs:

Other Tomcat logs
^^^^^^^^^^^^^^^^^

Tomcat maintains a number of other logs that provide information on Tomcat's setup and events or problems during EDG startup and shutdown.
They are usually located at ``<CATALINA_BASE>/logs/catalina.*.log`` and ``<CATALINA_BASE>/logs/localhost.*.log``.