Skip to content

Commit f52cb9f

Browse files
committed
Added links to dashboards
1 parent d02295e commit f52cb9f

File tree

4 files changed

+30
-2
lines changed

4 files changed

+30
-2
lines changed

ydb/docs/en/core/dev/troubleshooting/performance/hardware/_includes/cpu-bottleneck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
1. Analyze CPU utilization in all pools:
22

3-
1. Open the **CPU** dashboard in Grafana.
3+
1. Open the **[CPU](../../../../../reference/observability/metrics/grafana-dashboards.md#cpu)** dashboard in Grafana.
44

55
1. See if the following charts show any spikes:
66

ydb/docs/en/core/dev/troubleshooting/performance/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Addressing database performance issues often requires a holistic approach, which
77
Troubleshooting performance issues in {{ ydb-short-name }} involves the following tools:
88

99
- [{{ ydb-short-name }} metrics](../../../reference/observability/metrics/index.md)
10+
11+
Diagnistic steps for most performance issues involve analyzing [Grafana dashboards](../../../reference/observability/metrics/grafana-dashboards.md) that use {{ ydb-short-name }} metrics collected by Prometheus. For information on installing Grafana and Prometheus, see [{#T}](../../../devops/manual/monitoring.md).
12+
1013
- [{{ ydb-short-name }} logs](../../../devops/manual/logging.md)
1114
- [Tracing](../../../reference/observability/tracing/setup.md)
1215
- [{{ ydb-short-name }} CLI](../../../reference/ydb-cli/index.md)

ydb/docs/en/core/dev/troubleshooting/performance/ydb/_includes/tablets-moved.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1. See if the **Tablets moved by Hive** chart in the **DB status** Grafana dashboard shows any spikes.
1+
1. See if the **Tablets moved by Hive** chart in the **[DB status](../../../../../reference/observability/metrics/grafana-dashboards.md#dbstatus)** Grafana dashboard shows any spikes.
22

33
![](../_assets/tablets-moved.png)
44

ydb/docs/en/core/reference/observability/metrics/grafana-dashboards.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This page describes Grafana dashboards for {{ ydb-short-name }}. For information
66

77
General database dashboard.
88

9+
Download the [dbstatus.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/dbstatus.json) file with the **DB status** dashboard.
10+
911
## Actors {#actors}
1012

1113
CPU utilization in an actor system.
@@ -17,6 +19,21 @@ CPU utilization in an actor system.
1719
| CPU | CPU utilization in different execution pools (by actor type) |
1820
| Events | Actor system event handling metrics |
1921

22+
Download the [actors.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/actors.json) file with the **Actors** dashboard.
23+
24+
## CPU {#cpu}
25+
26+
CPU utilization in execution pools.
27+
28+
| Name | Description |
29+
|---|---|
30+
| CPU by execution pool | CPU utilization in different execution pools across all nodes, microseconds per second (one million indicates utilization of a single core) |
31+
| Actor count | Number of actors (by actor type) |
32+
| CPU | CPU utilization in each execution pool |
33+
| Events | Event handling metrics in each execution pool |
34+
35+
Download the [cpu.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/cpu.json) file with the **CPU** dashboard.
36+
2037
## gRPC {#grpc}
2138

2239
gRPC layer metrics.
@@ -31,6 +48,8 @@ gRPC layer metrics.
3148
| Requests in flight | Number of requests that a database is simultaneously handling (by gRPC method type) |
3249
| Request bytes in flight | Size of requests that a database is simultaneously handling (by gRPC method type) |
3350

51+
Download the [grpc.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/grpc.json) file with the **gRPC API** dashboard.
52+
3453
## Query engine {#queryengine}
3554

3655
Information about the query engine.
@@ -44,6 +63,8 @@ Information about the query engine.
4463
| Sessions | Information about running sessions |
4564
| Latencies | Request execution time histograms for different types of requests |
4665

66+
Download the [queryengine.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/queryengine.json) file with the **Query engine** dashboard.
67+
4768
## TxProxy {#txproxy}
4869

4970
Information about transactions from the DataShard transaction proxy layer.
@@ -53,6 +74,8 @@ Information about transactions from the DataShard transaction proxy layer.
5374
| Transactions | Datashard transaction metrics |
5475
| Latencies | Execution time histograms for different stages of datashard transactions |
5576

77+
Download the [txproxy.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/txproxy.json) file with the **TxProxy** dashboard.
78+
5679
## DataShard {#datashard}
5780

5881
DataShard tablet metrics.
@@ -66,3 +89,5 @@ DataShard tablet metrics.
6689
| Compactions | Information about LSM compaction operations performed |
6790
| ReadSets | Information about ReadSets that are sent when executing a customer transaction |
6891
| Other | Other metrics |
92+
93+
Download the [datashard.json](https://raw.githubusercontent.com/ydb-platform/ydb/refs/heads/main/ydb/deploy/helm/ydb-prometheus/dashboards/datashard.json) file with the **DataShard** dashboard.

0 commit comments

Comments
 (0)