From cc7c9a1956ba3fd9186a01161c1c4cfa764fc530 Mon Sep 17 00:00:00 2001
From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>
Date: Tue, 23 Aug 2022 09:12:20 +0800
Subject: [PATCH 1/3] update monitoring
---
docs-2.0/reuse/source-monitoring-metrics.md | 40 ++++++++++-----------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs-2.0/reuse/source-monitoring-metrics.md b/docs-2.0/reuse/source-monitoring-metrics.md
index 37e2b37cfdc..66587c120e3 100644
--- a/docs-2.0/reuse/source-monitoring-metrics.md
+++ b/docs-2.0/reuse/source-monitoring-metrics.md
@@ -23,8 +23,8 @@
| `num_slow_queries` | The number of slow queries. |
| `num_sort_executors` | The number of executions for the Sort operator. |
| `optimizer_latency_us` | The latency of executing optimizer statements. |
-| `query_latency_us` | The average latency of queries. |
-| `slow_query_latency_us` | The average latency of slow queries. |
+| `query_latency_us` | The latency of queries. |
+| `slow_query_latency_us` | The latency of slow queries. |
| `num_queries_hit_memory_watermark` | The number of queries reached the memory watermark. |
### Meta
@@ -38,7 +38,7 @@
| `num_raft_votes` | The number of votes in Raft. |
| `transfer_leader_latency_us` | The latency of transferring the raft leader. |
| `num_agent_heartbeats` | The number of heartbeats for the AgentHBProcessor.|
-| `agent_heartbeat_latency_us` | The average latency of the AgentHBProcessor.|
+| `agent_heartbeat_latency_us` | The latency of the AgentHBProcessor.|
| `replicate_log_latency_us` | The latency of replicating the log record to most nodes by Raft. |
| `num_send_snapshot` | The number of times that Raft sends snapshots to other nodes. |
| `append_log_latency_us` | The latency of replicating the log record to a single node by Raft. |
@@ -50,17 +50,17 @@
| Parameter | Description |
| ---------------------------- | --------------------------------------------------- |
-| `add_edges_atomic_latency_us` | The average latency of adding edge single. |
-| `add_edges_latency_us` | The average latency of adding edges. |
-| `add_vertices_latency_us` | The average latency of adding vertices. |
+| `add_edges_atomic_latency_us` | The latency of adding atomic edge after TOSS is enabled. |
+| `add_edges_latency_us` | The latency of adding edges. |
+| `add_vertices_latency_us` | The latency of adding vertices. |
| `commit_log_latency_us` | The latency of committing logs in Raft. |
| `commit_snapshot_latency_us` | The latency of committing snapshots in Raft. |
-| `delete_edges_latency_us` | The average latency of deleting edges. |
-| `delete_vertices_latency_us` | The average latency of deleting vertices. |
-| `get_neighbors_latency_us` | The average latency of querying neighbor vertices. |
+| `delete_edges_latency_us` | The latency of deleting edges. |
+| `delete_vertices_latency_us` | The latency of deleting vertices. |
+| `get_neighbors_latency_us` | The latency of querying neighbor vertices. |
| `num_get_prop` | The number of executions for the GetPropProcessor. |
| `num_get_neighbors_errors` | The number of execution errors for the GetNeighborsProcessor. |
-| `get_prop_latency_us` | The average latency of executions for the GetPropProcessor.|
+| `get_prop_latency_us` | The latency of executions for the GetPropProcessor.|
| `num_edges_deleted` | The number of deleted edges. |
| `num_edges_inserted` | The number of inserted edges. |
| `num_raft_votes` | The number of votes in Raft. |
@@ -70,24 +70,24 @@
| `num_vertices_deleted` | The number of deleted vertices. |
| `num_vertices_inserted` | The number of inserted vertices. |
| `transfer_leader_latency_us` | The latency of transferring the raft leader. |
-| `lookup_latency_us` | The average latency of executions for the LookupProcessor. |
+| `lookup_latency_us` | The latency of executions for the LookupProcessor. |
| `num_lookup_errors` | The number of execution errors for the LookupProcessor.|
| `num_scan_vertex` | The number of executions for the ScanVertexProcessor.|
| `num_scan_vertex_errors` | The number of execution errors for the ScanVertexProcessor.|
-| `update_edge_latency_us` | The average latency of executions for the UpdateEdgeProcessor.|
+| `update_edge_latency_us` | The latency of executions for the UpdateEdgeProcessor.|
| `num_update_vertex` | The number of executions for the UpdateVertexProcessor.|
| `num_update_vertex_errors` | The number of execution errors for the UpdateVertexProcessor.|
-| `kv_get_latency_us` | The average latency of executions for the Getprocessor.|
-| `kv_put_latency_us` | The average latency of executions for the PutProcessor.|
-| `kv_remove_latency_us` | The average latency of executions for the RemoveProcessor.|
+| `kv_get_latency_us` | The latency of executions for the Getprocessor.|
+| `kv_put_latency_us` | The latency of executions for the PutProcessor.|
+| `kv_remove_latency_us` | The latency of executions for the RemoveProcessor.|
| `num_kv_get_errors` | The number of execution errors for the GetProcessor.|
| `num_kv_get` | The number of executions for the GetProcessor.|
| `num_kv_put_errors` | The number of execution errors for the PutProcessor.|
| `num_kv_put` | The number of executions for the PutProcessor.|
| `num_kv_remove_errors` | The number of execution errors for the RemoveProcessor.|
| `num_kv_remove` | The number of executions for the RemoveProcessor.|
-| `forward_tranx_latency_us` | The average latency of transmission.|
-| `scan_edge_latency_us` | The average latency of executions for the ScanEdgeProcessor. |
+| `forward_tranx_latency_us` | The latency of transmission.|
+| `scan_edge_latency_us` | The latency of executions for the ScanEdgeProcessor. |
| `num_scan_edge_errors` | The number of execution errors for the ScanEdgeProcessor. |
| `num_scan_edge` | The number of executions for the ScanEdgeProcessor. |
| `scan_vertex_latency_us` | The latency of executions for the ScanVertexProcessor. |
@@ -108,7 +108,7 @@
| `update_vertex_latency_us` | The latency of executions for the UpdateVertexProcessor. |
| `append_wal_latency_us` | The Raft write latency for a single WAL. |
| `num_update_edge` | The number of executions for the UpdateEdgeProcessor. |
-| `delete_tags_latency_us` | The average latency of deleting tags. |
+| `delete_tags_latency_us` | The latency of deleting tags. |
| `num_update_edge_errors` | The number of execution errors for the UpdateEdgeProcessor. |
| `num_get_neighbors` | The number of executions for the GetNeighborsProcessor. |
| `num_get_prop_errors` | The number of execution errors for the GetPropProcessor. |
@@ -126,7 +126,7 @@
| `num_queries` | The number of queries. |
| `num_sentences` | The number of statements received by the Graphd service. |
| `optimizer_latency_us` | The latency of executing optimizer statements. |
-| `query_latency_us` | The average latency of queries. |
+| `query_latency_us` | The latency of queries. |
| `num_slow_queries` | The number of slow queries. |
| `num_query_errors` | The number of query errors. |
| `num_query_errors_leader_changes` | The number of raft leader changes due to query errors. |
@@ -144,4 +144,4 @@
| `num_rpc_sent_to_metad` | The number of RPC requests that the Graphd service sent to the Metad service. |
| `num_rpc_sent_to_storaged_failed` | The number of failed RPC requests that the Graphd service sent to the Storaged service. |
| `num_rpc_sent_to_storaged` | The number of RPC requests that the Graphd service sent to the Storaged service. |
-| `slow_query_latency_us` | The average latency of slow queries. |
+| `slow_query_latency_us` | The latency of slow queries. |
From a1e610f86461b0e39557f3935e48a3c159c3a8bc Mon Sep 17 00:00:00 2001
From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>
Date: Tue, 23 Aug 2022 09:54:06 +0800
Subject: [PATCH 2/3] update
---
docs-2.0/reuse/source-monitoring-metrics.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs-2.0/reuse/source-monitoring-metrics.md b/docs-2.0/reuse/source-monitoring-metrics.md
index 66587c120e3..7786ed8e5f7 100644
--- a/docs-2.0/reuse/source-monitoring-metrics.md
+++ b/docs-2.0/reuse/source-monitoring-metrics.md
@@ -2,8 +2,8 @@
| Parameter | Description |
| ---------------------------------------------- | ------------------------------------------------------------ |
-| `num_active_queries` | The number of active query changes in the last 5 seconds.
Formula: The number of queries that started executing in the last 5 seconds minus the number of queries that finished executing in the last 5 seconds. |
-| `num_active_sessions` | The number of active session changes in the last 5 seconds.
Formula: The number of sessions logged in in the last 5 seconds minus the number of sessions logged out in the last 5 seconds.
For example: In the last 5 seconds, there were 10 sessions logged in and 30 sessions logged out, then the value of this metric is `-20` (10-30). |
+| `num_active_queries` | The number of changes in the number of active queries.
Formula: The number of started queries minus the number of finished queries. |
+| `num_active_sessions` | The number of changes in the number of active sessions.
Formula: The number of logged in sessions minus the number of logged out sessions.
For example, query `num_active_sessions.sum.5`. If there were 10 sessions logged in and 30 sessions logged out in the last 5 seconds, the value of this metric is `-20` (10-30). |
| `num_aggregate_executors` | The number of executions for the Aggregation operator. |
| `num_auth_failed_sessions_bad_username_password` | The number of sessions where authentication failed due to incorrect username and password. |
| `num_auth_failed_sessions_out_of_max_allowed` | The number of sessions that failed to authenticate logins because the value of the parameter `FLAG_OUT_OF_MAX_ALLOWED_CONNECTIONS` was exceeded.|
From 40b05bf4dc7c735debacc10a994b37ab29da2982 Mon Sep 17 00:00:00 2001
From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com>
Date: Tue, 23 Aug 2022 10:00:56 +0800
Subject: [PATCH 3/3] Update source-monitoring-metrics.md
---
docs-2.0/reuse/source-monitoring-metrics.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs-2.0/reuse/source-monitoring-metrics.md b/docs-2.0/reuse/source-monitoring-metrics.md
index 7786ed8e5f7..7a1f64e94fa 100644
--- a/docs-2.0/reuse/source-monitoring-metrics.md
+++ b/docs-2.0/reuse/source-monitoring-metrics.md
@@ -2,8 +2,8 @@
| Parameter | Description |
| ---------------------------------------------- | ------------------------------------------------------------ |
-| `num_active_queries` | The number of changes in the number of active queries.
Formula: The number of started queries minus the number of finished queries. |
-| `num_active_sessions` | The number of changes in the number of active sessions.
Formula: The number of logged in sessions minus the number of logged out sessions.
For example, query `num_active_sessions.sum.5`. If there were 10 sessions logged in and 30 sessions logged out in the last 5 seconds, the value of this metric is `-20` (10-30). |
+| `num_active_queries` | The number of changes in the number of active queries.
Formula: The number of started queries minus the number of finished queries within a specified time. |
+| `num_active_sessions` | The number of changes in the number of active sessions.
Formula: The number of logged in sessions minus the number of logged out sessions within a specified time.
For example, when querying `num_active_sessions.sum.5`, if there were 10 sessions logged in and 30 sessions logged out in the last 5 seconds, the value of this metric is `-20` (10-30). |
| `num_aggregate_executors` | The number of executions for the Aggregation operator. |
| `num_auth_failed_sessions_bad_username_password` | The number of sessions where authentication failed due to incorrect username and password. |
| `num_auth_failed_sessions_out_of_max_allowed` | The number of sessions that failed to authenticate logins because the value of the parameter `FLAG_OUT_OF_MAX_ALLOWED_CONNECTIONS` was exceeded.|