Skip to content

Commit 822af97

Browse files
committed
New configuration options failover.log.to and failover.log.file added in config reference
Fixes #4657
1 parent 52cbbf7 commit 822af97

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

doc/reference/configuration/configuration_reference.rst

+52
Original file line numberDiff line numberDiff line change
@@ -1646,13 +1646,65 @@ The ``failover`` section defines parameters related to a :ref:`supervised failov
16461646

16471647
``failover`` can be defined in the global :ref:`scope <configuration_scopes>` only.
16481648

1649+
- :ref:`failover.call_timeout <configuration_reference_failover_log_to>`
1650+
- :ref:`failover.call_timeout <configuration_reference_failover_log_file>`
16491651
- :ref:`failover.call_timeout <configuration_reference_failover_call_timeout>`
16501652
- :ref:`failover.connect_timeout <configuration_reference_failover_connect_timeout>`
16511653
- :ref:`failover.lease_interval <configuration_reference_failover_lease_interval>`
16521654
- :ref:`failover.probe_interval <configuration_reference_failover_probe_interval>`
16531655
- :ref:`failover.renew_interval <configuration_reference_failover_renew_interval>`
16541656
- :ref:`failover.stateboard.* <configuration_reference_failover_stateboard>`
16551657

1658+
.. _configuration_reference_failover_log_to:
1659+
1660+
.. confval:: failover.log.to
1661+
1662+
**Since:** :doc:`3.3.0 </release/3.3.0>`
1663+
1664+
.. admonition:: Enterprise Edition
1665+
:class: fact
1666+
1667+
Configuring ``failover.log.to`` and ``failover.log.file`` parameters is available in the `Enterprise Edition <https://www.tarantool.io/compare/>`_ only.
1668+
1669+
1670+
Define a location Tarantool sends failover logs.
1671+
This option accepts the following values:
1672+
1673+
* ``stderr``: write logs to the standard error stream.
1674+
* ``file``: write logs to a file (see :ref:`failover.log.file <configuration_reference_failover_log_file>`).
1675+
1676+
|
1677+
| Type: string
1678+
| Default: 'stderr'
1679+
| Environment variable: TT_FAILOVER_LOG_TO
1680+
1681+
1682+
.. _configuration_reference_failover_log_file:
1683+
1684+
.. confval:: failover.log.file
1685+
1686+
**Since:** :doc:`3.3.0 </release/3.3.0>`
1687+
1688+
Specify a file for failover logs destination.
1689+
To write logs to a file, you need to set :ref:`failover.log.to <configuration_reference_failover_log_to>` to ``file``.
1690+
Otherwise, ``failover.log.file`` is ignored.
1691+
1692+
**Example**
1693+
1694+
The example below shows how to write failover logs to a file placed in the specified directory:
1695+
1696+
.. code-block:: yaml
1697+
1698+
failover:
1699+
log:
1700+
to: file
1701+
file: var/log/failover.log
1702+
1703+
|
1704+
| Type: string
1705+
| Default: nil
1706+
| Environment variable: TT_FAILOVER_LOG_FILE
1707+
16561708
.. _configuration_reference_failover_call_timeout:
16571709

16581710
.. confval:: failover.call_timeout

0 commit comments

Comments
 (0)