diff --git a/doc/reference/configuration/configuration_reference.rst b/doc/reference/configuration/configuration_reference.rst index 086ac6977..069f22101 100644 --- a/doc/reference/configuration/configuration_reference.rst +++ b/doc/reference/configuration/configuration_reference.rst @@ -1646,6 +1646,8 @@ The ``failover`` section defines parameters related to a :ref:`supervised failov ``failover`` can be defined in the global :ref:`scope ` only. +- :ref:`failover.log.to ` +- :ref:`failover.log.file ` - :ref:`failover.call_timeout ` - :ref:`failover.connect_timeout ` - :ref:`failover.lease_interval ` @@ -1653,6 +1655,56 @@ The ``failover`` section defines parameters related to a :ref:`supervised failov - :ref:`failover.renew_interval ` - :ref:`failover.stateboard.* ` +.. _configuration_reference_failover_log_to: + +.. confval:: failover.log.to + + **Since:** :doc:`3.3.0 ` + + .. admonition:: Enterprise Edition + :class: fact + + Configuring ``failover.log.to`` and ``failover.log.file`` parameters is available in the `Enterprise Edition `_ only. + + + Define a location Tarantool sends failover logs to. + This option accepts the following values: + + * ``stderr``: write logs to the standard error stream. + * ``file``: write logs to a file (see :ref:`failover.log.file `). + + | + | Type: string + | Default: 'stderr' + | Environment variable: TT_FAILOVER_LOG_TO + + +.. _configuration_reference_failover_log_file: + +.. confval:: failover.log.file + + **Since:** :doc:`3.3.0 ` + + Specify a file for failover logs destination. + To write logs to a file, set :ref:`failover.log.to ` to ``file``. + Otherwise, ``failover.log.file`` is ignored. + + **Example** + + The example below shows how to write failover logs to a file placed in the specified directory: + + .. code-block:: yaml + + failover: + log: + to: file + file: var/log/failover.log + + | + | Type: string + | Default: nil + | Environment variable: TT_FAILOVER_LOG_FILE + .. _configuration_reference_failover_call_timeout: .. confval:: failover.call_timeout