[YDB] Move monitoring

updated

15 files changed, 99 insertions, 68 deletions

diff --git a/ydb/docs/ru/core/_assets/grafana-actors.png b/ydb/docs/ru/core/_assets/grafana-actors.png
new file mode 100644
index 00000000000..90b6f21e04b
--- /dev/null
+++ b/ydb/docs/ru/core/_assets/grafana-actors.png
diff --git a/ydb/docs/ru/core/troubleshooting/_includes/grafana_dashboards.md b/ydb/docs/ru/core/administration/grafana-dashboards.md
index 1e6f88e9f47..a1eccc34131 100644
--- a/ydb/docs/ru/core/troubleshooting/_includes/grafana_dashboards.md
+++ b/ydb/docs/ru/core/administration/grafana-dashboards.md
@@ -1,25 +1,27 @@
-## Сервис {{ ydb-full-name }} {#ydb}
+# Дашборды Grafana
 
-### DB status {#dbstatus}
+На этой странице представлено описание дашбордов Grafana для {{ ydb-short-name }}. Как установить дашборды читайте в разделе [{#T}](monitoring.md#prometheus-grafana).
+
+## DB status {#dbstatus}
 
 Общий дашборд базы данных.
 
-### Actors {#actors}
+## Actors {#actors}
 
 Потребление CPU в актор-системе.
 
-| **Имя** | **Описание** |
+| Имя | Описание |
 |---|---|
 | CPU by execution pool (us) | Потребление CPU в различных пулах исполнения на всех нодах, микросекунды в секунду (один миллион соответствует потреблению одного ядра) |
 | Actor count | Количество акторов (по типу актора) |
 | CPU | Потребление CPU в различных пулах исполнения (по типу актора) |
 | Events | Метрики обработки событий в актор-системе |
 
-### gRPC {#grpc}
+## gRPC {#grpc}
 
 Метрики слоя gRPC.
 
-| **Имя** | **Описание** |
+| Имя | Описание |
 |---|---|
 | Requests | Количество запросов, получаемых базой данных в секунду (по типу метода gRPC) |
 | Request bytes | Размер запросов, получаемых базой данных, байты в секунду (по типу метода gRPC) |
@@ -29,39 +31,38 @@
 | Requests in flight | Количество запросов, которые одновременно обрабатываются базой данных (по типу метода gRPC) |
 | Request bytes in flight | Размер запросов, которые одновременно обрабатываются базой данных (по типу метода gRPC) |
 
-### Query engine {#queryengine}
+## Query engine {#queryengine}
 
 Сведения о движке исполнения запросов.
 
-| **Имя** | **Описание** |
+| Имя | Описание |
 |---|---|
 | Requests | Количество входящих запросов в секунду (по типу запроса) |
 | Request bytes | Размер входящих запросов, байты в секунду (query, parameters, total) |
 | Responses | Количество ответов в секунду (по типу ответа) |
 | Response bytes | Размеры ответов, байты в секунду (total, query result) |
 | Sessions | Сведения об установленных сессиях |
-| Latencies | Гистограммы времён исполнения запросов для различных типов запросов |
+| Latencies | Гистограммы времен исполнения запросов для различных типов запросов |
 
-### TxProxy {#txproxy}
+## TxProxy {#txproxy}
 
 Информация от транзакциях с уровня DataShard transaction proxy.
 
-| **Имя** | **Описание** |
+| Имя | Описание |
 |---|---|
 | Transactions | Метрики транзакций даташардов |
-| Latencies | Гистограммы времён исполнения различных этапов транзакций даташардов |
+| Latencies | Гистограммы времен исполнения различных этапов транзакций даташардов |
 
-### DataShard {#datashard}
+## DataShard {#datashard}
 
 Метрики таблетки DataShard.
 
-| **Имя** | **Описание** |
+| Имя | Описание |
 |---|---|
 | Operations | Статистика операций с даташардом для разных типов операций |
 | Transactions | Информация о транзакциях таблетки даташарда (по типам транзакций) |
-| Latencies | Гистограммы времён выполнения различных этапов пользовательских транзакций |
-| Tablet latencies | Гистограммы времён выполнения транзакций таблетки |
+| Latencies | Гистограммы времен выполнения различных этапов пользовательских транзакций |
+| Tablet latencies | Гистограммы времен выполнения транзакций таблетки |
 | Compactions | Сведения о производимых операциях LSM compaction |
 | ReadSets | Сведения о пересылаемых ReadSets при исполнении пользовательской транзакции |
 | Other | Прочие метрики |
-
diff --git a/ydb/docs/ru/core/administration/monitoring.md b/ydb/docs/ru/core/administration/monitoring.md
new file mode 100644
index 00000000000..d7b67019118
--- /dev/null
+++ b/ydb/docs/ru/core/administration/monitoring.md
@@ -0,0 +1,48 @@
+# Настройка мониторинга локального кластера {{ ydb-short-name }}
+
+На этой странице рассказано, как настроить мониторинг локального однонодового кластера YDB, [запущенного из бинарного файла](../getting_started/self_hosted/ydb_local.md).
+
+{{ ydb-short-name }} предоставляет множество сенсоров состояния системы. Мгновенные значения сенсоров можно посмотреть в веб-интерфейсе:
+
+```http
+http://localhost:31002/counters/
+```
+
+Связанные сенсоры объединены в подгруппы (например `counters auth`). Чтобы посмотреть значения сенсоров только определенной подгруппы, перейдите по URL следующего вида:
+
+```http
+http://localhost:31002/counters/counters=<servicename>/
+```
+
+* `<servicename>` — имя подгруппы сенсоров.
+
+>Например, данные об утилизации аппаратных ресурсов сервера доступны по следующему URL:
+>
+>```http
+>http://localhost:31002/counters/counters=utils
+>```
+
+Для сбора значений метрик вы можете использовать популярный инструмент с открытым исходным кодом [Prometheus](https://prometheus.io/). Значения сенсоров {{ ydb-short-name }} в [формате Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) доступны по URL следующего вида:
+
+```http
+http://localhost:31002/counters/counters=<servicename>/prometheus
+```
+
+* `<servicename>` — имя подгруппы сенсоров.
+
+Визуализировать данные можно с помощью любой системы, которая поддерживает формат Prometheus, например [Zabbix](https://www.zabbix.com/ru/), [Amazon CloudWatch](https://aws.amazon.com/ru/cloudwatch/) или [Grafana](https://grafana.com/):
+
+![grafana-actors](../_assets/grafana-actors.png)
+
+## Настройка мониторинга с помощью Prometheus и Grafana {#prometheus-grafana}
+
+Чтобы настроить мониторинг локального однонодового кластера {{ ydb-short-name }} с помощью [Prometheus](https://prometheus.io/) и [Grafana](https://grafana.com/):
+
+1. [Установите и запустите](https://prometheus.io/docs/prometheus/latest/getting_started/#downloading-and-running-prometheus) Prometheus, используя [файл конфигурации](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml).
+1. [Установите и запустите](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) Grafana.
+1. [Создайте](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source) источник данных с типом `prometheus` в Grafana и подсоедините его к запущенному экземпляру Prometheus.
+1. Загрузите [дашборды {{ ydb-short-name }}](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/) в Grafana.
+
+    Вы можете загрузить дашборды с помощью инструмента [Import](https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-dashboard) Grafana UI или выполнить [скрипт](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_upload_dashboards.sh). Обратите внимание, что скрипт использует [базовую аутентификацию](https://grafana.com/docs/grafana/latest/http_api/create-api-tokens-for-org/#authentication) в Grafana. Для других случаев модифицируйте скрипт.
+
+    Ознакомьтесь со [справочником метрик](grafana-dashboards.md) дашбордов.
diff --git a/ydb/docs/ru/core/cluster/_includes/addition_overlay.md b/ydb/docs/ru/core/cluster/_includes/addition_overlay.md
deleted file mode 100644
index e69de29bb2d..00000000000
--- a/ydb/docs/ru/core/cluster/_includes/addition_overlay.md
+++ /dev/null
diff --git a/ydb/docs/ru/core/cluster/index.md b/ydb/docs/ru/core/cluster/index.md
index 6132db98c1d..02bc5ee767b 100644
--- a/ydb/docs/ru/core/cluster/index.md
+++ b/ydb/docs/ru/core/cluster/index.md
@@ -1,12 +1,9 @@
-# Управление кластером YDB
+# Управление кластером {{ ydb-short-name }}
 
-В данном разделе находятся статьи, описывающие процедуры развертывания, конфигурирования, обслуживания, мониторинга и диагностики многоузловых кластеров YDB.
-
-Статьи опираются на описание внутреннего устройства кластеров YDB, приведенное в разделе [Концепции - Кластер](../concepts/cluster/index.md).
-
-{% include [addition_overlay](_includes/addition_overlay.md) %}
-
-- [Развертывание и конфигурирование кластера](../deploy/index.md) в Kubernetes и на виртуальных/железных серверах
-- [Встроенный UI](../maintenance/embedded_monitoring/index.md)
-- [Системные таблицы кластера](../troubleshooting/system_views_cluster.md)
+В этом разделе описано развертывание, конфигурирование, обслуживание, мониторинг и диагностика многоузловых [кластеров {{ ydb-short-name }}](../concepts/cluster/index.md).
 
+* [{#T}](../deploy/index.md).
+* [{#T}](../maintenance/embedded_monitoring/index.md).
+* [{#T}](../maintenance/manual/index.md)
+* [{#T}](../troubleshooting/system_views_cluster.md).
+* [{#T}](../administration/monitoring.md).
diff --git a/ydb/docs/ru/core/cluster/toc_i.yaml b/ydb/docs/ru/core/cluster/toc_i.yaml
index 0f469b2971c..b2ade5eb578 100644
--- a/ydb/docs/ru/core/cluster/toc_i.yaml
+++ b/ydb/docs/ru/core/cluster/toc_i.yaml
@@ -5,5 +5,11 @@ items:
   include: { mode: link, path: ../maintenance/manual/toc_p.yaml }
 - name: Встроенный UI
   include: { mode: link, path: ../maintenance/embedded_monitoring/toc_p.yaml }
-- name: Системные таблицы
-  href: ../troubleshooting/system_views_cluster.md
\ No newline at end of file
+- name: Системные таблицы кластера
+  href: ../troubleshooting/system_views_cluster.md
+- name: Мониторинг
+  items:
+    - name: Настройка мониторинга локального кластера YDB
+      href: ../administration/monitoring.md
+    - name: Дашборды Grafana
+      href: ../administration/grafana-dashboards.md
diff --git a/ydb/docs/ru/core/db/toc_i.yaml b/ydb/docs/ru/core/db/toc_i.yaml
index e30c0857171..15f453358d7 100644
--- a/ydb/docs/ru/core/db/toc_i.yaml
+++ b/ydb/docs/ru/core/db/toc_i.yaml
@@ -2,4 +2,7 @@ items:
 - name: Резервное копирование и восстановление
   href: ../maintenance/backup_and_recovery.md
 - name: Диагностика
+  hidden: true
   include: { mode: link, path: ../troubleshooting/toc_p.yaml }
+- name: Системные таблицы БД
+  href: ../troubleshooting/system_views_db.md
diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md
index adf56bbd5a8..7a48650ab87 100644
--- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md
+++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md
@@ -72,17 +72,6 @@ ydb -e grpc://localhost:2136 -d /Root/test scheme ls
 
 Для работы со структурой и данными в базе данных также доступен встроенный в процесс `ydbd` web-интерфейс по адресу `http://localhost:8765`. Подробней возможности встроенного веб-интерфейса описаны в разделе [Embedded UI](../../../maintenance/embedded_monitoring/ydb_monitoring.md).
 
-
-## Мониторинг базы данных с помощью Grafana и Prometheus {#dashboards}
-
-Локальный сервер YDB может быть интегрирован с [Prometheus](https://prometheus.io/) и [Grafana](https://grafana.com/), популярными инструментами с открытым исходным кодом для сбора и визуализации метрик. Чтобы настроить стандартные [дашборды](../../../troubleshooting/grafana_dashboards.html), следуйте этой инструкции:
-
-1. [Установите и запустите](https://prometheus.io/docs/prometheus/latest/getting_started/#downloading-and-running-prometheus) Prometheus с этим [файлом конфигурации](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml).
-1. [Установите и запустите](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) Grafana.
-1. [Создайте](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source) источник данных с типом "prometheus" в Grafana и подсоедините его к инстансу Prometheus.
-1. Загрузите [дашборды](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/) в Grafana. Вы можете загрузить дашборды в ручном режиме через функцию Grafana UI [Import](https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-dashboard) или использовать простой [скрипт](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_upload_dashboards.sh). Пожалуйста, обратите внимание на то, что скрипт использует [базовую аутентификацию](https://grafana.com/docs/grafana/latest/http_api/create-api-tokens-for-org/#authentication) в Grafana. Для других случаев модифицируйте скрипт.
-
-
 ## Дополнительные возможности {#advanced}
 
-Описание развертывания многоузловых кластеров и их конфигурирования находится в разделе [Управление кластером](../../../deploy/index.md).
\ No newline at end of file
+Описание развертывания многоузловых кластеров и их конфигурирования находится в разделе [Управление кластером](../../../deploy/index.md).
diff --git a/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md b/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md
index dba0826ce22..67137662d5e 100644
--- a/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md
+++ b/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md
@@ -1,9 +1,8 @@
-# Встроенный UI
+# Использование встроенного web-интерфейса
 
 {{ ydb-short-name }} предоставляет инструменты для мониторинга и определения состояния системы:
 
-* [{{ ydb-short-name }} Monitoring](ydb_monitoring.md) - Основной обозреватель кластера. Показывает состояние узлов, групп хранения.
-* [Interconnect overview](interconnect_overview.md) - состояние соединений узлов кластера друг с другом.
-* [Логи](logs.md) - Каждый компонент {{ ydb-short-name }} пишет сообщения в логи разного уровня. По ним можно детектировать критические проблемы или разобраться в причинах неполадок.
-* [Графики](charts.md) - {{ ydb-short-name }} собирает множество метрик, по которым можно определить состояние системы либо конкретного компонента.
-
+* [{{ ydb-short-name }} Monitoring](ydb_monitoring.md) — основной обозреватель кластера. Показывает состояние узлов, групп хранения.
+* [Interconnect overview](interconnect_overview.md) — состояние соединений узлов кластера друг с другом.
+* [Логи](logs.md) — каждый компонент {{ ydb-short-name }} пишет сообщения в логи разного уровня. По ним можно детектировать критические проблемы или разобраться в причинах неполадок.
+* [Графики](charts.md) — {{ ydb-short-name }} собирает множество метрик, по которым можно определить состояние системы либо конкретного компонента.
diff --git a/ydb/docs/ru/core/troubleshooting/_includes/index.md b/ydb/docs/ru/core/troubleshooting/_includes/index.md
deleted file mode 100644
index 886220d6f6c..00000000000
--- a/ydb/docs/ru/core/troubleshooting/_includes/index.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Диагностика
-
-В данном разделе собраны статьи по инструментам диагностики баз данных YDB.
-
-- [Системные таблицы](../system_views_db.md)
-- [Метрики](../monitoring.md)
-- [Дашборды Grafana](../grafana_dashboards.md)
-
diff --git a/ydb/docs/ru/core/troubleshooting/_includes/system_views/intro_cluster.md b/ydb/docs/ru/core/troubleshooting/_includes/system_views/intro_cluster.md
index 9c74549a040..6c9d4a4cdeb 100644
--- a/ydb/docs/ru/core/troubleshooting/_includes/system_views/intro_cluster.md
+++ b/ydb/docs/ru/core/troubleshooting/_includes/system_views/intro_cluster.md
@@ -1,8 +1,5 @@
-# Системные таблицы кластера
-
 Для возможности внутренней интроспекции состояния кластера пользователю предоставляется возможность осуществлять запросы в специальные служебные таблицы (system views). Эти таблицы доступны из корневой директории кластера и используют системный префикс пути `.sys`.
 
 Пользователи облачных баз данных обычно не имеют доступа к системным таблицам кластера, так как за его поддержку и своевременную диагностику отвечает команда облака.
 
 В описаниях доступных полей далее по тексту колонка **Ключ** содержит индекс поля первичного ключа соответствующей таблицы.
-
diff --git a/ydb/docs/ru/core/troubleshooting/grafana_dashboards.md b/ydb/docs/ru/core/troubleshooting/grafana_dashboards.md
deleted file mode 100644
index 87569dff98b..00000000000
--- a/ydb/docs/ru/core/troubleshooting/grafana_dashboards.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-editable: false
----
-
-# Дашборды Grafana
-
-{% include notitle [ydb_grafana_dashboards.md](_includes/grafana_dashboards.md) %}
diff --git a/ydb/docs/ru/core/troubleshooting/index.md b/ydb/docs/ru/core/troubleshooting/index.md
index eb2590567da..81a913a87e1 100644
--- a/ydb/docs/ru/core/troubleshooting/index.md
+++ b/ydb/docs/ru/core/troubleshooting/index.md
@@ -1 +1,7 @@
-{% include [_includes/index.md](_includes/index.md) %}
\ No newline at end of file
+# Диагностика
+
+В данном разделе собраны статьи по инструментам диагностики баз данных YDB.
+
+- [Системные таблицы](system_views_db.md)
+- [Метрики](monitoring.md)
+- [Дашборды Grafana](../administration/grafana-dashboards.md)
diff --git a/ydb/docs/ru/core/troubleshooting/system_views_cluster.md b/ydb/docs/ru/core/troubleshooting/system_views_cluster.md
index 697876861c6..d9700500622 100644
--- a/ydb/docs/ru/core/troubleshooting/system_views_cluster.md
+++ b/ydb/docs/ru/core/troubleshooting/system_views_cluster.md
@@ -1,3 +1,5 @@
+# Системные таблицы кластера
+
 {% include [intro.md](_includes/system_views/intro_cluster.md) %}
 
 {% include [distributed_storage.md](_includes/system_views/distributed_storage.md) %}
diff --git a/ydb/docs/ru/core/troubleshooting/toc_i.yaml b/ydb/docs/ru/core/troubleshooting/toc_i.yaml
index 6d4279132d1..1557851b33b 100644
--- a/ydb/docs/ru/core/troubleshooting/toc_i.yaml
+++ b/ydb/docs/ru/core/troubleshooting/toc_i.yaml
@@ -3,8 +3,6 @@ items:
   href: system_views_db.md
 - name: Мониторинг
   href: monitoring.md
-- name: Дашборды Grafana
-  href: grafana_dashboards.md
 - name: System views (deprecated)
   href: system_views.md
   hidden: true