Skip to content

Commit d0edf8a

Browse files
authored
Add the upstream and downstream diagram to the box.info.replication and Monitoring a replica set sections
Fixes #3059
1 parent f2f60fe commit d0edf8a

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

doc/book/replication/repl_monitoring.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Monitoring a replica set
44
========================
55

6-
To learn what instances belong in the replica set, and obtain statistics for all
6+
To learn what instances belong to the replica set and obtain statistics for all
77
these instances, issue a :doc:`/reference/reference_lua/box_info/replication` request:
88

99
.. code-block:: tarantoolsession
@@ -52,7 +52,7 @@ The primary indicators of replication health are:
5252

5353
.. _heartbeat:
5454

55-
* :ref:`idle <box_info_replication_upstream_idle>`, the time (in seconds) since
55+
* :ref:`idle <box_info_replication_upstream_idle>`: the time (in seconds) since
5656
the instance received the last event from a master.
5757

5858
If the master has no updates to send to the replicas, it sends heartbeat messages
@@ -65,7 +65,7 @@ The primary indicators of replication health are:
6565
seriously behind, because the master is running ahead of the replica, or the
6666
network link between the instances is down.
6767

68-
* :ref:`lag <box_info_replication_upstream_lag>`, the time difference between
68+
* :ref:`lag <box_info_replication_upstream_lag>`: the time difference between
6969
the local time at the instance, recorded when the event was received, and the
7070
local time at another master recorded when the event was written to the
7171
:ref:`write ahead log <internals-wal>` on that master.
@@ -75,3 +75,9 @@ The primary indicators of replication health are:
7575
remote master clock being consistently behind the local instance's clock.
7676

7777
For multi-master configurations, ``lag`` is the maximal lag.
78+
79+
For better understanding, see the following diagram illustrating the ``upstream`` and ``downstream`` connections within the replica set of three instances:
80+
81+
.. image:: replication.svg
82+
:align: left
83+

doc/reference/reference_lua/box_info/replication.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
box.info.replication
55
================================================================================
66

7-
.. module:: box.info
7+
.. module:: box.info
88

9-
.. data:: replication
9+
.. data:: replication
1010

1111
The **replication** section of ``box.info()`` is a table array with
1212
statistics for all instances in the replica set that the current instance
@@ -126,3 +126,10 @@ box.info.replication
126126
``status = 'stopped'``, ``message = 'unexpected EOF when reading
127127
from socket'``, and ``system_message = 'Broken pipe'``.
128128
See also :ref:`degraded state <replication-recover>`.
129+
130+
131+
For better understanding, see the following diagram illustrating the ``upstream`` and ``downstream`` connections within the replica set of three instances:
132+
133+
.. image:: /book/replication/replication.svg
134+
:align: left
135+

0 commit comments

Comments
 (0)