.. include:: _include.rst
.. highlight:: html+jinja
.. _options_logging:

###########################
Logging
###########################

.. include:: _include_local_toc.rst

.. _options_logging_api_stats:

**********************************
Record API stats
**********************************

Use this option to determine whether API requests should be logged. When activated, a dashboard widget is displayed to present the data.

Learn more: :ref:`api_stats`

**********************************
Log errors
**********************************

If activated, |asa2| will log errors, e.g. |api| response error message.

.. note::

    It is recommended to enable "Log errors" to be aware of errors which might occur in communication with the |api|.

.. image:: _static/option_log_errors.png
    :height: 46px
    :width: 255px
    :scale: 100%
    :alt: Option log errors

***********************************
Log template errors
***********************************

Logs errors from the template engine. This is useful when you are working on a template or if a template does not work as expected.

.. note::

    It is recommended to enable "Log template errors" to be aware of syntax errors which might occurs in your templates.

.. image:: _static/option_log_template_errors.png
    :height: 46px
    :width: 255px
    :scale: 100%
    :alt: Option log template errors

***************
Log i18n errors    
***************

Logs errors related to the internationalization (i18n) feature, e.g. issues with resolving the vistor's IP address.

.. image:: _static/options_log_i18n_errors.png
    :height: 67px
    :width: 780px
    :scale: 100%
    :alt: Option log i18n errors

************************
Item lookup debug
************************

If activated, |asa2| logs debug information on item lookup, e.g. if the item was loaded via API or Repo.

.. image:: _static/option_log_item_lookup.png
    :height: 40px
    :width: 255px
    :scale: 100%
    :alt: Option log item lookup

************************
Cache debug
************************

If activated, |asa2| logs debug information about cache usage.

.. image:: _static/option_log_cache_debug.png
    :height: 40px
    :width: 249px
    :scale: 100%
    :alt: Option log cache debug

************************
Request limits handling
************************

If activated, |asa2| logs actions regarding the RequestThrottle prevention.

.. image:: _static/option_log_request_limit.png
    :height: 42px
    :width: 254px
    :scale: 100%
    :alt: Option log request limit

********************
Ratings parser debug
********************

Logs the ratings parsing process if an error was detected. These details can help with troubleshooting regarding product ratings issues.

.. image:: _static/options_log_ratings_parser_debug.png
    :height: 65px
    :width: 807px
    :scale: 100%
    :alt: Option log ratings parser

*******************
Log API request URL    
*******************

Logs the URLs used for API requests. Should only be activated temporarily for debugging issues.

.. image:: _static/options_log_api_request_url.png
    :height: 64px
    :width: 786px
    :scale: 100%
    :alt: Option log API request URL

.. _options_log_cronjobs:

*******************
Log Cronjobs
*******************

Logs information about the execution of cronjobs.

.. image:: _static/options_log_cronjobs.png
    :height: 88px
    :width: 573px
    :scale: 100%
    :alt: Option log cronjobs

************
Time to keep
************

.. image:: _static/options_log_time_to_keep.png
    :height: 124px
    :width: 363px
    :scale: 100%
    :alt: Option log time to keep

The selection of this options determines how long the log entries should be kept in the database. This protects against overloading the database. Default is "2 weeks".

***********
Max entries
***********

.. image:: _static/options_log_max_entries.png
    :height: 151px
    :width: 403px
    :scale: 100%
    :alt: Option log max entries

The selection of this option determines the maximum allowed amount of log entries. This limit protects against overloading the database. Cleanup gets processed once per hour. Default is 500.