Skip to content

Commit 17bbb7e

Browse files
committed
Update box.info.synchro
1 parent 1d3fb18 commit 17bbb7e

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

doc/reference/reference_lua/box_info.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ Below is a list of all ``box.info`` functions.
9292
- Show the current state of a replica set node
9393
in regards to leader election
9494

95+
* - :doc:`./box_info/synchro`
96+
- Show the current state of synchronous replication
97+
98+
9599
.. toctree::
96100
:hidden:
97101

@@ -102,3 +106,4 @@ Below is a list of all ``box.info`` functions.
102106
box_info/replication
103107
box_info/listen
104108
box_info/election
109+
box_info/synchro
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. _box_info_synchro:
2+
3+
================================================================================
4+
box.info.synchro
5+
================================================================================
6+
7+
.. module:: box.info
8+
9+
.. data:: synchro
10+
11+
Since version :doc:`2.8.1 </release/2.8.1>`.
12+
Show the current state of synchronous replication.
13+
14+
In :ref:`synchronous replication <repl_sync>`, a transaction is considered committed only after achieving
15+
the required quorum number.
16+
While the commit responses from remote nodes are being collected, the data is waiting in the queue.
17+
18+
The following information is provided:
19+
20+
* ``queue``:
21+
22+
- ``len`` -- current number of entries that are waiting in the queue.
23+
24+
* ``quorum`` -- evaluated value of the
25+
:ref:`replication_synchro_quorum <cfg_replication-replication_synchro_quorum>` configuration option.
26+
Since version :doc:`2.5.3 </release/2.5.3>`, the option can be set as a dynamic formula.
27+
In this case, the value in the ``quorum`` member depends on the current number of replicas.
28+
29+
**Example:**
30+
31+
.. code-block:: tarantoolsession
32+
33+
tarantool> box.info.synchro
34+
---
35+
- queue:
36+
len: 0
37+
quorum: 1
38+
...

0 commit comments

Comments
 (0)