Skip to content

Commit 33c859e

Browse files
Danielle9897Danielle9897
committed
RDoc-3179 fix review comments
1 parent 3e37f14 commit 33c859e

File tree

5 files changed

+86
-52
lines changed

5 files changed

+86
-52
lines changed

‎Documentation/4.0/Raven.Documentation.Pages/server/clustering/distribution/cluster-observer.markdown

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
{NOTE: }
55

6-
* The primary goal of the `Cluster Observer` is to maintain the [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor) of each database in the cluster.
6+
* The primary goal of the **Cluster Observer** is to monitor the health of each database in the cluster
7+
and adjust its topology to maintain the desired [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor).
78

89
* This observer is always running on the Leader node.
910
{NOTE/}
@@ -38,17 +39,25 @@ The _Cluster Observer_ stores its information **in memory**, so when the `Leader
3839
| `/admin/cluster/maintenance-stats` | GET | | Fetch the latest reports of the _Cluster Observer_ |
3940
{PANEL/}
4041

41-
{NOTE: For Example}
42+
{NOTE: }
43+
44+
**For example**:
4245

43-
* Let us assume a five node cluster, with servers A, B, C, D, E.
44-
We create a database with a replication factor of 3 and define an ETL task.
46+
* Let us assume a five-node cluster with servers A, B, C, D, E.
47+
We create a database with a replication factor of 3 and define an ETL task.
4548

4649
* The newly created database will be distributed automatically to three of the cluster nodes.
47-
Let's assume it is distributed to B, C and E (So the database group is [B,C,E]),
48-
and the cluster decides that node C is the responsible for performing the ETL task.
50+
Let's assume it is distributed to B, C, and E (so the database group is [B,C,E]),
51+
and the cluster decides that node C is responsible for performing the ETL task.
52+
53+
* If node C goes offline or becomes unreachable, the Cluster Observer detects the issue.
54+
Initially:
55+
* After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration#cluster.timebeforemovingtorehabinsec) configuration,
56+
the observer moves node C to rehab mode, allowing time for recovery.
57+
* The ETL task fails over to another available node in the Database Group.
58+
59+
* If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration#cluster.timebeforeaddingreplicainsec) configuration, the observer begins replicating the database to another node in the Database Group as a last resort.
4960

50-
* If node C goes offline or is not reachable, the Observer will notice it and relocate the database from node C to another available node.
51-
Meanwhile the ETL task will failover to be performed by another available node from the Database Group.
5261
{NOTE/}
5362

5463
## Related articles

‎Documentation/4.2/Raven.Documentation.Pages/server/clustering/distribution/cluster-observer.markdown

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
{NOTE: }
55

6-
* The primary goal of the `Cluster Observer` is to maintain the [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor) of each database in the cluster.
6+
* The primary goal of the **Cluster Observer** is to monitor the health of each database in the cluster
7+
and adjust its topology to maintain the desired [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor).
78

89
* This observer is always running on the Leader node.
910
{NOTE/}
@@ -37,15 +38,23 @@ The _Cluster Observer_ stores its information **in memory**, so when the `Leader
3738
| `/admin/cluster/maintenance-stats` | GET | | Fetch the latest reports of the _Cluster Observer_ |
3839
{PANEL/}
3940

40-
{NOTE: For Example}
41+
{NOTE: }
4142

42-
* Let us assume a five node cluster, with servers A, B, C, D, E.
43-
We create a database with a replication factor of 3 and define an ETL task.
43+
**For example**:
4444

45+
* Let us assume a five-node cluster with servers A, B, C, D, E.
46+
We create a database with a replication factor of 3 and define an ETL task.
47+
4548
* The newly created database will be distributed automatically to three of the cluster nodes.
46-
Let's assume it is distributed to B, C and E (So the database group is [B,C,E]),
47-
and the cluster decides that node C is the responsible for performing the ETL task.
49+
Let's assume it is distributed to B, C, and E (so the database group is [B,C,E]),
50+
and the cluster decides that node C is responsible for performing the ETL task.
51+
52+
* If node C goes offline or becomes unreachable, the Cluster Observer detects the issue.
53+
Initially:
54+
* After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration#cluster.timebeforemovingtorehabinsec) configuration,
55+
the observer moves node C to rehab mode, allowing time for recovery.
56+
* The ETL task fails over to another available node in the Database Group.
4857

49-
* If node C goes offline or is not reachable, the Observer will notice it and relocate the database from node C to another available node.
50-
Meanwhile the ETL task will failover to be performed by another available node from the Database Group.
58+
* If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration#cluster.timebeforeaddingreplicainsec) configuration, the observer begins replicating the database to another node in the Database Group as a last resort.
59+
5160
{NOTE/}

‎Documentation/5.2/Raven.Documentation.Pages/server/clustering/distribution/cluster-observer.markdown

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
{NOTE: }
55

6-
* The primary goal of the `Cluster Observer` is to maintain the [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor) of each database in the cluster.
6+
* The primary goal of the **Cluster Observer** is to monitor the health of each database in the cluster
7+
and adjust its topology to maintain the desired [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor).
78

89
* This observer is always running on the Leader node.
910
{NOTE/}
@@ -37,15 +38,23 @@ The _Cluster Observer_ stores its information **in memory**, so when the `Leader
3738
| `/admin/cluster/maintenance-stats` | GET | | Fetch the latest reports of the _Cluster Observer_ |
3839
{PANEL/}
3940

40-
{NOTE: For Example}
41+
{NOTE: }
42+
43+
**For example**:
4144

42-
* Let us assume a five node cluster, with servers A, B, C, D, E.
43-
We create a database with a replication factor of 3 and define an ETL task.
45+
* Let us assume a five-node cluster with servers A, B, C, D, E.
46+
We create a database with a replication factor of 3 and define an ETL task.
4447

4548
* The newly created database will be distributed automatically to three of the cluster nodes.
46-
Let's assume it is distributed to B, C and E (So the database group is [B,C,E]),
47-
and the cluster decides that node C is the responsible for performing the ETL task.
49+
Let's assume it is distributed to B, C, and E (so the database group is [B,C,E]),
50+
and the cluster decides that node C is responsible for performing the ETL task.
51+
52+
* If node C goes offline or becomes unreachable, the Cluster Observer detects the issue.
53+
Initially:
54+
* After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration#cluster.timebeforemovingtorehabinsec) configuration,
55+
the observer moves node C to rehab mode, allowing time for recovery.
56+
* The ETL task fails over to another available node in the Database Group.
57+
58+
* If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration#cluster.timebeforeaddingreplicainsec) configuration, the observer begins replicating the database to another node in the Database Group as a last resort.
4859

49-
* If node C goes offline or is not reachable, the Observer will notice it and relocate the database from node C to another available node.
50-
Meanwhile the ETL task will failover to be performed by another available node from the Database Group.
5160
{NOTE/}

‎Documentation/6.2/Raven.Documentation.Pages/server/clustering/distribution/cluster-observer.markdown

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
---
33

44
{NOTE: }
5-
6-
* The primary goal of the `Cluster Observer` is to maintain the [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor) of each database in the cluster.
5+
6+
* The primary goal of the **Cluster Observer** is to monitor the health of each database in the cluster
7+
and adjust its topology to maintain the desired [Replication Factor](../../../server/clustering/distribution/distributed-database#replication-factor).
78

89
* This observer is always running on the [Leader](../../../server/clustering/rachis/cluster-topology#leader) node.
910

@@ -34,11 +35,17 @@
3435
We create a database with a replication factor of 3 and define an ETL task.
3536

3637
* The newly created database will be distributed automatically to three of the cluster nodes.
37-
Let's assume it is distributed to B, C and E (so the database group is [B,C,E]),
38+
Let's assume it is distributed to B, C, and E (so the database group is [B,C,E]),
3839
and the cluster decides that node C is responsible for performing the ETL task.
39-
40-
* If node C goes offline or is not reachable, the Observer will notice it and relocate the database from node C to another available node.
41-
Meanwhile, the ETL task will fail over to another available node from the Database Group.
40+
41+
* If node C goes offline or becomes unreachable, the Cluster Observer detects the issue.
42+
Initially:
43+
* After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration#cluster.timebeforemovingtorehabinsec) configuration,
44+
the observer moves node C to rehab mode, allowing time for recovery.
45+
* The ETL task fails over to another available node in the Database Group.
46+
47+
* If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration#cluster.timebeforeaddingreplicainsec) configuration,
48+
the observer begins replicating the database to another node in the Database Group as a last resort.
4249

4350
{NOTE/}
4451

‎Documentation/6.2/Raven.Documentation.Pages/server/configuration/cluster-configuration.markdown

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,30 @@
1515

1616
* In this page:
1717
* Server-wide scope:
18-
[Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../../server/configuration/cluster-configuration#compareexchangeexpireddeletefrequencyinsec)
19-
[Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration#compareexchangetombstonescleanupintervalinmin)
18+
[Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../../server/configuration/cluster-configuration#cluster.compareexchangeexpireddeletefrequencyinsec)
19+
[Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration#cluster.compareexchangetombstonescleanupintervalinmin)
2020
[Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration#cluster.electiontimeoutinms)
21-
[Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration#harddeleteonreplacement)
22-
[Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration#loghistorymaxentries)
23-
[Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration#maxchangevectordistance)
24-
[Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration#maxclustertransactioncompareexchangetombstonecheckintervalinmin)
25-
[Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration#maxsizeofsingleraftcommandinmb)
26-
[Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration#maximalallowedclusterversion)
27-
[Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration#onerrordelaytimeinms)
28-
[Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration#operationtimeoutinsec)
29-
[Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration#receivefromWorkertimeoutinms)
30-
[Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration#statsstabilizationtimeinsec)
31-
[Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration#supervisorsampleperiodinms)
32-
[Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration#tcpreceivebuffersizeInbytes)
33-
[Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration#tcpsendbuffersizeinbytes)
34-
[Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration#tcptimeoutinms)
35-
[Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration#timebeforeaddingreplicainsec)
36-
[Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration#timebeforenovingtorehabinsec)
37-
[Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration#timebeforerotatingpreferrednodeinsec)
38-
[Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration#workersampleperiodInms)
21+
[Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration#cluster.harddeleteonreplacement)
22+
[Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration#cluster.loghistorymaxentries)
23+
[Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration#cluster.maxchangevectordistance)
24+
[Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration#cluster.maxclustertransactioncompareexchangetombstonecheckintervalinmin)
25+
[Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration#cluster.maxsizeofsingleraftcommandinmb)
26+
[Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration#cluster.maximalallowedclusterversion)
27+
[Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration#cluster.onerrordelaytimeinms)
28+
[Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration#cluster.operationtimeoutinsec)
29+
[Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration#cluster.receivefromworkertimeoutinms)
30+
[Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration#cluster.statsstabilizationtimeinsec)
31+
[Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration#cluster.supervisorsampleperiodinms)
32+
[Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration#cluster.tcpreceivebuffersizeinbytes)
33+
[Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration#cluster.tcpsendbuffersizeinbytes)
34+
[Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration#cluster.tcptimeoutinms)
35+
[Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration#cluster.timebeforeaddingreplicainsec)
36+
[Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration#cluster.timebeforemovingtorehabinsec)
37+
[Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration#cluster.timebeforerotatingpreferrednodeinsec)
38+
[Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration#cluster.workersampleperiodinms)
3939
* Server-wide, or database scope:
40-
[Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration#disableatomiccocumentwrites)
41-
[Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration#maxclustertransactionbatchsize)
40+
[Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration#cluster.disableatomicdocumentwrites)
41+
[Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration#cluster.maxclustertransactionbatchsize)
4242

4343
{NOTE/}
4444

0 commit comments

Comments
 (0)