Skip to content

Commit

Permalink
space-level-metrics (#1038)
Browse files Browse the repository at this point in the history
  • Loading branch information
@abby-cyber
abby-cyber authored Jan 17, 2022
1 parent 33bc7b4 commit 054f387
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cluster monitoring

This topic introduces node monitoring and service monitoring of Dashboard.
This topic introduces node monitoring, service monitoring, and graph space monitoring of Dashboard.

## Node

Expand Down Expand Up @@ -29,5 +29,16 @@ On this page, you can view the information of Graph, Meta, and Storage services
![service](../figs/ds-005.png)
- By default, you can view the monitoring data of the latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7days, or 14 days.
- You can select the machine and monitoring metrics that you want to view. For details of monitoring metrics, see [Monitor parameter](../7.monitor-parameter.md).
- The Graph service supports a set of space-level metrics. For more information, see the following section **Graph space**.
- You can set a base line as a reference standard.
- You can view the status of the current service.

## Graph space

!!! note

Before using graph space metrics, you need to set `enable_space_level_metrics` to `true` in the Graph service. For details, see [Update config](4.manage.md).

Space graph metrics record the information of different graph spaces separately. Currently, only the Graph service supports a set of space-level metrics.

Only when the behavior of a graph space metric is triggered, you can specify the graph space to view information about the corresponding graph space metric. For information about the space graph metrics, see [Space graph](../7.monitor-parameter.md).
18 changes: 18 additions & 0 deletions docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,21 @@ The period is the time range of counting metrics. It currently supports 5 second
| 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. |


### Graph space

| Parameter | Description |
| ---------------------------------------------- | ----------------------------------------- |
| num_active_queries | The number of queries currently being executed. |
| num_aggregate_executors | The number of executions for the Aggregation operator. |
| num_indexscan_executors | The number of executions for index scan operators. |
| num_killed_queries | The number of killed queries. |
| num_queries | The number of queries. |
| num_query_errors_leader_changes | The number of raft leader changes due to query errors. |
| num_query_errors | The number of query errors. |
| num_sentences | The number of statements received by the Graphd service. |
| 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. |
2 changes: 2 additions & 0 deletions docs-2.0/nebula-dashboard/4.use-dashboard.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Machine consists of the following parts:

- You can choose the machine and monitoring metrics that you want to check. For more information, see [monitor parameter](6.monitor-parameter.md).

- The Graph service supports a set of graph space metrics. For details, see [Graph space](../nebula-dashboard-ent/4.cluster-operator/2.monitor.md).

- You can set a base line as a reference.

![Machine](machine.png)
Expand Down
18 changes: 18 additions & 0 deletions docs-2.0/nebula-dashboard/6.monitor-parameter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,21 @@ The period is the time range of counting metrics. It currently supports 5 second
| 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. |


### Graph space

| Parameter | Description |
| ---------------------------------------------- | ----------------------------------------- |
| num_active_queries | The number of queries currently being executed. |
| num_aggregate_executors | The number of executions for the Aggregation operator. |
| num_indexscan_executors | The number of executions for index scan operators. |
| num_killed_queries | The number of killed queries. |
| num_queries | The number of queries. |
| num_query_errors_leader_changes | The number of raft leader changes due to query errors. |
| num_query_errors | The number of query errors. |
| num_sentences | The number of statements received by the Graphd service. |
| 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. |

0 comments on commit 054f387

Please sign in to comment.