aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-11-16 13:40:49 +0100
committerAlex Auvolat <alex@adnab.me>2022-11-16 13:40:49 +0100
commit555a54ec4063f253e2afdc54a07c43d6d3cb582d (patch)
tree1449beb2982cdd10b336adb36eac97622bc48a54
parentfc8f795bba1e23c8932af322959e0e3db2ef1233 (diff)
downloadgarage-doc-0.8.tar.gz
garage-doc-0.8.zip
doc precisions and fixesdoc-0.8
-rw-r--r--doc/book/cookbook/monitoring.md5
-rw-r--r--doc/book/cookbook/real-world.md2
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/book/cookbook/monitoring.md b/doc/book/cookbook/monitoring.md
index fd014c4e..8206f645 100644
--- a/doc/book/cookbook/monitoring.md
+++ b/doc/book/cookbook/monitoring.md
@@ -193,6 +193,7 @@ block_resync_queue_length 0
The number of block hashes that we were unable to resync last time we tried.
**THIS SHOULD BE ZERO, OR FALL BACK TO ZERO RAPIDLY, IN A HEALTHY CLUSTER.**
+Persistent nonzero values indicate that some data is likely to be lost.
```
block_resync_errored_blocks 0
@@ -211,7 +212,7 @@ rpc_request_counter{from="<this node>",rpc_endpoint="garage_block/manager.rs/Rpc
#### `rpc_netapp_error_counter` (counter)
-Number of communication errors (errors in the Netapp library)
+Number of communication errors (errors in the Netapp library, generally due to disconnected nodes)
```
rpc_netapp_error_counter{from="<this node>",rpc_endpoint="garage_block/manager.rs/Rpc",to="<remote node>"} 354
@@ -219,7 +220,7 @@ rpc_netapp_error_counter{from="<this node>",rpc_endpoint="garage_block/manager.r
#### `rpc_timeout_counter` (counter)
-Number of RPC timeouts
+Number of RPC timeouts, should be close to zero in a healthy cluster.
```
rpc_timeout_counter{from="<this node>",rpc_endpoint="garage_rpc/membership.rs/SystemRpc",to="<remote node>"} 1
diff --git a/doc/book/cookbook/real-world.md b/doc/book/cookbook/real-world.md
index f0fe3bd1..0571969f 100644
--- a/doc/book/cookbook/real-world.md
+++ b/doc/book/cookbook/real-world.md
@@ -60,7 +60,7 @@ to store 2 TB of data in total.
- For the data directory, Garage already does checksumming and integrity verification,
so there is no need to use a filesystem such as BTRFS or ZFS that does it.
We recommend using XFS for the data partition, as it has the best performance.
- Ext4 is not recommended as it has more strict limitations on the number of inodes,
+ EXT4 is not recommended as it has more strict limitations on the number of inodes,
which might cause issues with Garage when large numbers of objects are stored.
- If you only have an HDD and no SSD, it's fine to put your metadata alongside the data