DOC-464 | Add metrics for delays in sending cluster-internal requests (#1355)

* Add metrics for delays in sending cluster-internal requests * Add ArangoSearch primary doc count metric

Author: Simran-B

3.10/release-notes-api-changes310.md

@@ -694,6 +694,20 @@ been added:
 |:------|:------------|
 | `arangodb_replication_clients` | Number of currently connected/active replication clients. |
 
+---
+
+The following metrics for diagnosing delays in cluster-internal network requests
+have been added:
+
+<small>Introduced in: v3.9.11, v3.10.6</small>
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_network_dequeue_duration` | Internal request duration for the dequeue in seconds. |
+| `arangodb_network_response_duration` | Internal request duration from fully sent till response received in seconds. |
+| `arangodb_network_send_duration` | Internal request send duration in seconds. |
+| `arangodb_network_unfinished_sends_total` | Number of internal requests for which sending has not finished. |
+
 #### Pregel API
 
 When loading the graph data into memory, a `"loading"` state is now returned by

3.10/release-notes-new-features310.md

@@ -1445,6 +1445,20 @@ can be used for each individual edge index, and separately for the `_from` and
 values but the full-length edge IDs. The compressed values are also used
 in-memory only and are not persisted on disk.
 
+### Sending delay metrics for internal requests
+
+The following metrics for diagnosing delays in cluster-internal network requests
+have been added:
+
+<small>Introduced in: v3.9.11, v3.10.6</small>
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_network_dequeue_duration` | Internal request duration for the dequeue in seconds. |
+| `arangodb_network_response_duration` | Internal request duration from fully sent till response received in seconds. |
+| `arangodb_network_send_duration` | Internal request send duration in seconds. |
+| `arangodb_network_unfinished_sends_total` | Number of internal requests for which sending has not finished. |
+
 ## Client tools
 
 ### arangobench

3.11/release-notes-api-changes311.md

@@ -401,6 +401,14 @@ following two new statistics in the `stats` attribute of the response now:
 
 #### Metrics API
 
+The following ArangoSearch metric has been added in version 3.11:
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_search_num_primary_docs` | Number of primary documents for current snapshot. |
+
+---
+
 <small>Introduced in: v3.8.9, v3.9.6, v3.10.2</small>
 
 The metrics endpoints include the following new traffic accounting metrics:
@@ -443,6 +451,20 @@ been added:
 |:------|:------------|
 | `arangodb_replication_clients` | Number of currently connected/active replication clients. |
 
+---
+
+The following metrics for diagnosing delays in cluster-internal network requests
+have been added:
+
+<small>Introduced in: v3.9.11, v3.10.6</small>
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_network_dequeue_duration` | Internal request duration for the dequeue in seconds. |
+| `arangodb_network_response_duration` | Internal request duration from fully sent till response received in seconds. |
+| `arangodb_network_send_duration` | Internal request send duration in seconds. |
+| `arangodb_network_unfinished_sends_total` | Number of internal requests for which sending has not finished. |
+
 #### Log level API
 
 <small>Introduced in: v3.10.2</small>

3.11/release-notes-new-features311.md

@@ -887,6 +887,14 @@ See [Pregel HTTP API](http/pregel.html) for details.
 You can still use the old interfaces (the `pregel.status()` method as well as
 the `GET /_api/control_pregel` and `GET /_api/control_pregel/{id}` endpoints).
 
+### ArangoSearch metric
+
+The following ArangoSearch metric has been added in version 3.11:
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_search_num_primary_docs` | Number of primary documents for current snapshot. |
+
 ### Traffic accounting metrics
 
 <small>Introduced in: v3.8.9, v3.9.6, v3.10.2</small>
@@ -966,6 +974,20 @@ can be used for each individual edge index, and separately for the `_from` and
 values but the full-length edge IDs. The compressed values are also used
 in-memory only and are not persisted on disk.
 
+### Sending delay metrics for internal requests
+
+The following metrics for diagnosing delays in cluster-internal network requests
+have been added:
+
+<small>Introduced in: v3.9.11, v3.10.6</small>
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_network_dequeue_duration` | Internal request duration for the dequeue in seconds. |
+| `arangodb_network_response_duration` | Internal request duration from fully sent till response received in seconds. |
+| `arangodb_network_send_duration` | Internal request send duration in seconds. |
+| `arangodb_network_unfinished_sends_total` | Number of internal requests for which sending has not finished. |
+
 ## Internal changes
 
 ### Upgraded bundled library versions

3.9/release-notes-api-changes39.md

@@ -360,6 +360,20 @@ The following metrics for write-ahead log (WAL) file tracking have been added:
 | `rocksdb_wal_released_tick_replication` | Lower bound sequence number from which WAL files need to be kept because of replication. |
 | `arangodb_flush_subscriptions` | Number of currently active flush subscriptions. |
 
+---
+
+The following metrics for diagnosing delays in cluster-internal network requests
+have been added:
+
+<small>Introduced in: v3.9.11</small>
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_network_dequeue_duration` | Internal request duration for the dequeue in seconds. |
+| `arangodb_network_response_duration` | Internal request duration from fully sent till response received in seconds. |
+| `arangodb_network_send_duration` | Internal request send duration in seconds. |
+| `arangodb_network_unfinished_sends_total` | Number of internal requests for which sending has not finished. |
+
 ### Endpoints moved
 
 #### Cluster API redirects

3.9/release-notes-new-features39.md

@@ -1085,6 +1085,20 @@ The following metrics for write-ahead log (WAL) file tracking have been added:
 | `rocksdb_wal_released_tick_replication` | Lower bound sequence number from which WAL files need to be kept because of replication. |
 | `arangodb_flush_subscriptions` | Number of currently active flush subscriptions. |
 
+### Sending delay metrics for internal requests
+
+The following metrics for diagnosing delays in cluster-internal network requests
+have been added:
+
+<small>Introduced in: v3.9.11</small>
+
+| Label | Description |
+|:------|:------------|
+| `arangodb_network_dequeue_duration` | Internal request duration for the dequeue in seconds. |
+| `arangodb_network_response_duration` | Internal request duration from fully sent till response received in seconds. |
+| `arangodb_network_send_duration` | Internal request send duration in seconds. |
+| `arangodb_network_unfinished_sends_total` | Number of internal requests for which sending has not finished. |
+
 Client tools
 ------------