From d463570a3df08927cb3d086f1734aa26d5ed3cdc Mon Sep 17 00:00:00 2001 From: Anton Bobkov Date: Sat, 28 Dec 2024 16:32:53 +0300 Subject: [PATCH 1/5] Added information on the Prometheus configuration file --- ydb/docs/en/core/devops/manual/monitoring.md | 66 ++++++++++++++++---- ydb/docs/ru/core/devops/manual/monitoring.md | 64 ++++++++++++++++--- 2 files changed, 109 insertions(+), 21 deletions(-) diff --git a/ydb/docs/en/core/devops/manual/monitoring.md b/ydb/docs/en/core/devops/manual/monitoring.md index 013242c5e67f..6cb96791a86f 100644 --- a/ydb/docs/en/core/devops/manual/monitoring.md +++ b/ydb/docs/en/core/devops/manual/monitoring.md @@ -1,34 +1,40 @@ -# Setting up monitoring for a local {{ ydb-short-name }} cluster +# Setting up monitoring for a {{ ydb-short-name }} cluster -This page provides instructions on how to set up monitoring for a local {{ ydb-short-name }} cluster that is deployed using [Quick start](../../quickstart.md). +This page provides instructions on how to set up monitoring for a {{ ydb-short-name }} cluster. {{ ydb-short-name }} has multiple system health sensors. Instant sensor values are available in the web interface: ```http -http://localhost:31002/counters/ +http://:/counters/ ``` -Linked sensors are grouped into a subgroup (such as `counters auth`). To only view sensor values for a particular subgroup, follow a URL like: +- ``: {{ ydb-short-name }} server address. + + For a local {{ ydb-short-name }} cluster that is deployed using [Quick start](../../quickstart.md) use the `localhost` address. + +- ``: {{ ydb-short-name }} port. Default value: 8765. + +Linked sensors are grouped into subgroups (such as `counters auth`). To only view sensor values for a particular subgroup, follow a URL like: ```http -http://localhost:31002/counters/counters=/ +http://:/counters/counters=/ ``` -* ``: Sensor subgroup name. +- ``: sensor subgroup name. > For example, data about the utilization of server hardware resources is available at the URL: > > ```http -> http://localhost:31002/counters/counters=utils +> http://:/counters/counters=utils > ``` You can collect metric values using [Prometheus](https://prometheus.io/), a popular open-source tool. {{ ydb-short-name }} sensor values in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/) are available at a URL in the following format: ```http -http://localhost:31002/counters/counters=/prometheus +http://:/counters/counters=/prometheus ``` -* ``: Sensor subgroup name. +- ``: sensor subgroup name. To visualize data, use any system that supports Prometheus, such as [Zabbix](https://www.zabbix.com/), [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/), or [Grafana](https://grafana.com/): @@ -36,12 +42,50 @@ To visualize data, use any system that supports Prometheus, such as [Zabbix](htt ## Setting up monitoring with Prometheus and Grafana {#prometheus-grafana} -To set up monitoring for a local single-node {{ ydb-short-name }} cluster using [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/): +To set up monitoring for a {{ ydb-short-name }} cluster using [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/): 1. [Install and run](https://prometheus.io/docs/prometheus/latest/getting_started/#downloading-and-running-prometheus) Prometheus via a [configuration file](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml). + + Edit the configuration file before running Prometheus: + + 1. In the `targets` section specify addresses of all servers of the {{ ydb-short-name }} cluster and ports for each nodes (static and dynamic) that runs on the server. + + For example, for the {{ ydb-short-name }} cluster that contains three servers, each server running one static and two dynamic nodes, specify nine addresses for all sensor subgroups, except for the disk subgroups (for disk sensor subgroups, specify only static node addresses): + + ```json + static_configs: + - targets: + - ydb-s1.example.com:8765 + - ydb-s1.example.com:8766 + - ydb-s1.example.com:8767 + - ydb-s2.example.com:8765 + - ydb-s2.example.com:8766 + - ydb-s2.example.com:8767 + - ydb-s3.example.com:8765 + - ydb-s3.example.com:8766 + - ydb-s3.example.com:8767 + ``` + + For a local single-node {{ ydb-short-name }} cluster, specify one address in the `targets` section: + + ```json + - targets: ["localhost:8765"] + ``` + + 1. If necessary, specify the TLS certificate in the `tls_config` section: + + ```json + tls_config: + ca_file: '' + ``` + + Skip this step for a local single-node {{ ydb-short-name }} cluster. + 1. [Install and start](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) the Grafana. + 1. [Create](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source) a data source of the `prometheus` type in Grafana and attach it to a running Prometheus instance. -1. Upload [{{ ydb-short-name }} dashboards](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/) to Grafana. + +1. Upload [{{ ydb-short-name }} dashboards](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/helm/ydb-prometheus/dashboards) to Grafana. To upload dashboards, use the Grafana UI [Import](https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-dashboard) tool or run a [script](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_upload_dashboards.sh). Please note that the script uses [basic authentication](https://grafana.com/docs/grafana/latest/http_api/create-api-tokens-for-org/#authentication) in Grafana. For other cases, modify the script. diff --git a/ydb/docs/ru/core/devops/manual/monitoring.md b/ydb/docs/ru/core/devops/manual/monitoring.md index f7edde427445..d198de20e985 100644 --- a/ydb/docs/ru/core/devops/manual/monitoring.md +++ b/ydb/docs/ru/core/devops/manual/monitoring.md @@ -1,34 +1,42 @@ -# Настройка мониторинга локального кластера {{ ydb-short-name }} +# Настройка мониторинга кластера {{ ydb-short-name }} -На этой странице рассказано, как настроить мониторинг локального однонодового кластера YDB, запущенного с помощью инструкции по [Быстрому началу работы](../../quickstart.md). +На этой странице рассказано, как настроить мониторинг кластера {{ ydb-short-name }}. {{ ydb-short-name }} предоставляет множество сенсоров состояния системы. Мгновенные значения сенсоров можно посмотреть в веб-интерфейсе: ```text -http://localhost:31002/counters/ +http://:/counters/ ``` +где: + +- `` – адрес сервера {{ ydb-short-name }}. + + Для локального однонодового кластера YDB, запущенного с помощью инструкции по [Быстрому началу работы](../../quickstart.md), используйте адрес `localhost`. + +- `` – порт {{ ydb-short-name }}. Значение по умолчанию: 8765. + Связанные сенсоры объединены в подгруппы (например `counters auth`). Чтобы посмотреть значения сенсоров только определенной подгруппы, перейдите по URL следующего вида: ```text -http://localhost:31002/counters/counters=/ +http://:/counters/counters=/ ``` -* `` — имя подгруппы сенсоров. +- `` — имя подгруппы сенсоров. Например, данные об утилизации аппаратных ресурсов сервера доступны по следующему URL: ```text -http://localhost:31002/counters/counters=utils +http://:/counters/counters=utils ``` Для сбора значений метрик вы можете использовать популярный инструмент с открытым исходным кодом [Prometheus](https://prometheus.io/). Значения сенсоров {{ ydb-short-name }} в [формате Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) доступны по URL следующего вида: ```text -http://localhost:31002/counters/counters=/prometheus +http://:/counters/counters=/prometheus ``` -* `` — имя подгруппы сенсоров. +- `` — имя подгруппы сенсоров. Визуализировать данные можно с помощью любой системы, которая поддерживает формат Prometheus, например [Zabbix](https://www.zabbix.com/ru/), [Amazon CloudWatch](https://aws.amazon.com/ru/cloudwatch/) или [Grafana](https://grafana.com/): @@ -36,12 +44,48 @@ http://localhost:31002/counters/counters=/prometheus ## Настройка мониторинга с помощью Prometheus и Grafana {#prometheus-grafana} -Чтобы настроить мониторинг локального однонодового кластера {{ ydb-short-name }} с помощью [Prometheus](https://prometheus.io/) и [Grafana](https://grafana.com/): +Чтобы настроить мониторинг кластера {{ 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). + + Перед использованием, файл конфигурации Prometheus необходимо отредактировать: + + 1. В секции `targets` укажите адреса всех серверов кластера {{ ydb-short-name }} и порты каждого из узлов (статического и динамического), работающих на сервере. + + Например, для кластера из трёх серверов, где на каждом сервере работает один статический и два динамических узла, необходимо прописать девять адресов для всех подгрупп сенсоров, кроме дисковых (для дисковых подгрупп сенсоров необходимо указать только адреса статических узлов): + + ```json + static_configs: + - targets: + - ydb-s1.example.com:8765 + - ydb-s1.example.com:8766 + - ydb-s1.example.com:8767 + - ydb-s2.example.com:8765 + - ydb-s2.example.com:8766 + - ydb-s2.example.com:8767 + - ydb-s3.example.com:8765 + - ydb-s3.example.com:8766 + - ydb-s3.example.com:8767 + ``` + + Для локального однонодового кластера YDB, в секции `targets` прописывается один адрес: + + ```json + - targets: ["localhost:8765"] + ``` + + 1. При необходимости, укажите TLS сертификат в секции `tls_config`: + + ```json + tls_config: + ca_file: '' + ``` + + Пропустите этот шаг для локального однонодового кластера {{ ydb-short-name }}. + 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. +1. Загрузите [дашборды {{ ydb-short-name }}](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/helm/ydb-prometheus/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. Для других случаев модифицируйте скрипт. From e17aff827d30f629856660cc7ad86545aa450596 Mon Sep 17 00:00:00 2001 From: anton-bobkov Date: Fri, 10 Jan 2025 14:27:33 +0300 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Ivan Blinkov --- ydb/docs/en/core/devops/manual/monitoring.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/ydb/docs/en/core/devops/manual/monitoring.md b/ydb/docs/en/core/devops/manual/monitoring.md index 6cb96791a86f..b0336c55cfb0 100644 --- a/ydb/docs/en/core/devops/manual/monitoring.md +++ b/ydb/docs/en/core/devops/manual/monitoring.md @@ -28,7 +28,7 @@ http://:/counters/counters=/ > http://:/counters/counters=utils > ``` -You can collect metric values using [Prometheus](https://prometheus.io/), a popular open-source tool. {{ ydb-short-name }} sensor values in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/) are available at a URL in the following format: +You can collect metric values using [Prometheus](https://prometheus.io/), a popular open-source observability tool, or any other system compatible with its format. {{ ydb-short-name }} sensor values in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/) are available at a URL in the following format: ```http http://:/counters/counters=/prometheus @@ -36,7 +36,7 @@ http://:/counters/counters=/prometheu - ``: sensor subgroup name. -To visualize data, use any system that supports Prometheus, such as [Zabbix](https://www.zabbix.com/), [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/), or [Grafana](https://grafana.com/): +To visualize data, use any system that supports Prometheus, such as [Grafana](https://grafana.com/), [[Zabbix](https://www.zabbix.com/), or [AWS CloudWatch](https://aws.amazon.com/cloudwatch/): ![grafana-actors](../../_assets/grafana-actors.png) @@ -50,7 +50,7 @@ To set up monitoring for a {{ ydb-short-name }} cluster using [Prometheus](https 1. In the `targets` section specify addresses of all servers of the {{ ydb-short-name }} cluster and ports for each nodes (static and dynamic) that runs on the server. - For example, for the {{ ydb-short-name }} cluster that contains three servers, each server running one static and two dynamic nodes, specify nine addresses for all sensor subgroups, except for the disk subgroups (for disk sensor subgroups, specify only static node addresses): + For example, for the {{ ydb-short-name }} cluster that contains three servers, each server running one storage node on port 8765 and two database nodes on ports 8766 and 8767, specify nine addresses for all sensor subgroups except for the disk subgroups (for disk sensor subgroups, specify only storage node addresses): ```json static_configs: @@ -79,11 +79,10 @@ To set up monitoring for a {{ ydb-short-name }} cluster using [Prometheus](https ca_file: '' ``` - Skip this step for a local single-node {{ ydb-short-name }} cluster. -1. [Install and start](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) the Grafana. +1. [Install and start](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) Grafana. -1. [Create](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source) a data source of the `prometheus` type in Grafana and attach it to a running Prometheus instance. +1. [Create](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source) a data source of the `prometheus` type in Grafana, and attach it to the running Prometheus instance. 1. Upload [{{ ydb-short-name }} dashboards](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/helm/ydb-prometheus/dashboards) to Grafana. From 5accb60017c0561247bfd3ecd4e5d2a70eb5a98e Mon Sep 17 00:00:00 2001 From: Anton Bobkov Date: Fri, 10 Jan 2025 21:03:28 +0300 Subject: [PATCH 3/5] Edits based on comments --- ydb/docs/en/core/devops/manual/monitoring.md | 23 ++++++++++---------- ydb/docs/ru/core/devops/manual/monitoring.md | 21 ++++++++++-------- 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/ydb/docs/en/core/devops/manual/monitoring.md b/ydb/docs/en/core/devops/manual/monitoring.md index b0336c55cfb0..5797afced0f7 100644 --- a/ydb/docs/en/core/devops/manual/monitoring.md +++ b/ydb/docs/en/core/devops/manual/monitoring.md @@ -22,11 +22,11 @@ http://:/counters/counters=/ - ``: sensor subgroup name. -> For example, data about the utilization of server hardware resources is available at the URL: -> -> ```http -> http://:/counters/counters=utils -> ``` +For example, data about the utilization of server hardware resources is available at the URL: + +```http +http://:/counters/counters=utils +``` You can collect metric values using [Prometheus](https://prometheus.io/), a popular open-source observability tool, or any other system compatible with its format. {{ ydb-short-name }} sensor values in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/) are available at a URL in the following format: @@ -36,7 +36,7 @@ http://:/counters/counters=/prometheu - ``: sensor subgroup name. -To visualize data, use any system that supports Prometheus, such as [Grafana](https://grafana.com/), [[Zabbix](https://www.zabbix.com/), or [AWS CloudWatch](https://aws.amazon.com/cloudwatch/): +To visualize data, use any system that supports Prometheus, such as [Grafana](https://grafana.com/), [Zabbix](https://www.zabbix.com/), or [AWS CloudWatch](https://aws.amazon.com/cloudwatch/): ![grafana-actors](../../_assets/grafana-actors.png) @@ -44,11 +44,11 @@ To visualize data, use any system that supports Prometheus, such as [Grafana](ht To set up monitoring for a {{ ydb-short-name }} cluster using [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/): -1. [Install and run](https://prometheus.io/docs/prometheus/latest/getting_started/#downloading-and-running-prometheus) Prometheus via a [configuration file](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml). +1. [Install](https://prometheus.io/docs/prometheus/latest/getting_started) Prometheus. - Edit the configuration file before running Prometheus: +1. Edit the Prometheus [configuration file](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml): - 1. In the `targets` section specify addresses of all servers of the {{ ydb-short-name }} cluster and ports for each nodes (static and dynamic) that runs on the server. + 1. In the `targets` section specify addresses of all servers of the {{ ydb-short-name }} cluster and ports for each storage and database node that runs on the server. For example, for the {{ ydb-short-name }} cluster that contains three servers, each server running one storage node on port 8765 and two database nodes on ports 8766 and 8767, specify nine addresses for all sensor subgroups except for the disk subgroups (for disk sensor subgroups, specify only storage node addresses): @@ -72,13 +72,14 @@ To set up monitoring for a {{ ydb-short-name }} cluster using [Prometheus](https - targets: ["localhost:8765"] ``` - 1. If necessary, specify the TLS certificate in the `tls_config` section: + 1. If necessary, in the `tls_config` section, specify the [CA-issued certificate](./initial-deployment.md#tls-certificates) used to sign the other TLS certificates of the {{ ydb-short-name }} cluster: ```json tls_config: - ca_file: '' + ca_file: '' ``` +1. [Run](https://prometheus.io/docs/prometheus/latest/getting_started/#starting-prometheus) Prometheus using the edited configuration file. 1. [Install and start](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) Grafana. diff --git a/ydb/docs/ru/core/devops/manual/monitoring.md b/ydb/docs/ru/core/devops/manual/monitoring.md index d198de20e985..d88038168175 100644 --- a/ydb/docs/ru/core/devops/manual/monitoring.md +++ b/ydb/docs/ru/core/devops/manual/monitoring.md @@ -30,7 +30,7 @@ http://:/counters/counters=/ http://:/counters/counters=utils ``` -Для сбора значений метрик вы можете использовать популярный инструмент с открытым исходным кодом [Prometheus](https://prometheus.io/). Значения сенсоров {{ ydb-short-name }} в [формате Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) доступны по URL следующего вида: +Для сбора значений метрик вы можете использовать популярный инструмент с открытым исходным кодом [Prometheus](https://prometheus.io/) или любую другую систему с поддержкой этого формата. Значения сенсоров {{ ydb-short-name }} в [формате Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) доступны по URL следующего вида: ```text http://:/counters/counters=/prometheus @@ -38,7 +38,7 @@ http://:/counters/counters=/prometheu - `` — имя подгруппы сенсоров. -Визуализировать данные можно с помощью любой системы, которая поддерживает формат Prometheus, например [Zabbix](https://www.zabbix.com/ru/), [Amazon CloudWatch](https://aws.amazon.com/ru/cloudwatch/) или [Grafana](https://grafana.com/): +Визуализировать данные можно с помощью любой системы, которая поддерживает формат Prometheus, например [Grafana](https://grafana.com/), [Zabbix](https://www.zabbix.com/ru/) или [Amazon CloudWatch](https://aws.amazon.com/ru/cloudwatch/): ![grafana-actors](../../_assets/grafana-actors.png) @@ -46,13 +46,13 @@ http://:/counters/counters=/prometheu Чтобы настроить мониторинг кластера {{ 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://prometheus.io/docs/prometheus/latest/getting_started) Prometheus. - Перед использованием, файл конфигурации Prometheus необходимо отредактировать: +1. Отредактируйте [файл конфигурации](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml) Prometheus: - 1. В секции `targets` укажите адреса всех серверов кластера {{ ydb-short-name }} и порты каждого из узлов (статического и динамического), работающих на сервере. + 1. В секции `targets` укажите адреса всех серверов кластера {{ ydb-short-name }} и порты каждого из узлов хранения и узлов базы данных, работающих на сервере. - Например, для кластера из трёх серверов, где на каждом сервере работает один статический и два динамических узла, необходимо прописать девять адресов для всех подгрупп сенсоров, кроме дисковых (для дисковых подгрупп сенсоров необходимо указать только адреса статических узлов): + Например, для кластера из трёх серверов, где на каждом сервере работает один узел хранения на порте 8765 и два узла базы данных на портах 8766 и 8767, необходимо прописать девять адресов для всех подгрупп сенсоров, кроме дисковых (для дисковых подгрупп сенсоров необходимо указать только адреса узлов хранения): ```json static_configs: @@ -74,17 +74,20 @@ http://:/counters/counters=/prometheu - targets: ["localhost:8765"] ``` - 1. При необходимости, укажите TLS сертификат в секции `tls_config`: + 1. При необходимости, в секции `tls_config` укажите [сертификат центра регистрации](./initial-deployment.md#tls-certificates) (Certification Authority, CA), которым подписаны остальные сертификаты TLS кластера {{ ydb-short-name }}: ```json + scheme: https tls_config: - ca_file: '' + ca_file: '' ``` - Пропустите этот шаг для локального однонодового кластера {{ ydb-short-name }}. +1. [Запустите](https://prometheus.io/docs/prometheus/latest/getting_started/#starting-prometheus) Prometheus, используя отредактированный файл конфигурации. 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/helm/ydb-prometheus/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. Для других случаев модифицируйте скрипт. From a1c59dbca7f1508ea2d0fc5e0a1d5a329b07f994 Mon Sep 17 00:00:00 2001 From: Ivan Blinkov Date: Fri, 31 Jan 2025 15:16:37 +0700 Subject: [PATCH 4/5] Update ydb/docs/ru/core/devops/manual/monitoring.md --- ydb/docs/ru/core/devops/manual/monitoring.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ydb/docs/ru/core/devops/manual/monitoring.md b/ydb/docs/ru/core/devops/manual/monitoring.md index d88038168175..ccc30f6bfc5f 100644 --- a/ydb/docs/ru/core/devops/manual/monitoring.md +++ b/ydb/docs/ru/core/devops/manual/monitoring.md @@ -12,7 +12,7 @@ http://:/counters/ - `` – адрес сервера {{ ydb-short-name }}. - Для локального однонодового кластера YDB, запущенного с помощью инструкции по [Быстрому началу работы](../../quickstart.md), используйте адрес `localhost`. + Для локального однонодового кластера {{ ydb-short-name }}, запущенного с помощью инструкции по [Быстрому началу работы](../../quickstart.md), используйте адрес `localhost`. - `` – порт {{ ydb-short-name }}. Значение по умолчанию: 8765. From 4267b9a92f7759f870fc71a30d887aec0c3842e3 Mon Sep 17 00:00:00 2001 From: Anton Bobkov Date: Mon, 3 Feb 2025 18:14:57 +0300 Subject: [PATCH 5/5] Changed 'sensors' to 'metrics' --- ydb/docs/en/core/devops/manual/monitoring.md | 12 ++++++------ ydb/docs/ru/core/devops/manual/monitoring.md | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/ydb/docs/en/core/devops/manual/monitoring.md b/ydb/docs/en/core/devops/manual/monitoring.md index 5797afced0f7..786888a85aa8 100644 --- a/ydb/docs/en/core/devops/manual/monitoring.md +++ b/ydb/docs/en/core/devops/manual/monitoring.md @@ -2,7 +2,7 @@ This page provides instructions on how to set up monitoring for a {{ ydb-short-name }} cluster. -{{ ydb-short-name }} has multiple system health sensors. Instant sensor values are available in the web interface: +{{ ydb-short-name }} has multiple system health metrics. Instant metrics are available in the web interface: ```http http://:/counters/ @@ -14,13 +14,13 @@ http://:/counters/ - ``: {{ ydb-short-name }} port. Default value: 8765. -Linked sensors are grouped into subgroups (such as `counters auth`). To only view sensor values for a particular subgroup, follow a URL like: +Linked metrics are grouped into subgroups (such as `counters auth`). To only view metrics for a particular subgroup, follow a URL like: ```http http://:/counters/counters=/ ``` -- ``: sensor subgroup name. +- ``: metrics subgroup name. For example, data about the utilization of server hardware resources is available at the URL: @@ -28,13 +28,13 @@ For example, data about the utilization of server hardware resources is availabl http://:/counters/counters=utils ``` -You can collect metric values using [Prometheus](https://prometheus.io/), a popular open-source observability tool, or any other system compatible with its format. {{ ydb-short-name }} sensor values in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/) are available at a URL in the following format: +You can collect metrics using [Prometheus](https://prometheus.io/), a popular open-source observability tool, or any other system compatible with its format. {{ ydb-short-name }} metrics in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/) are available at a URL in the following format: ```http http://:/counters/counters=/prometheus ``` -- ``: sensor subgroup name. +- ``: metrics subgroup name. To visualize data, use any system that supports Prometheus, such as [Grafana](https://grafana.com/), [Zabbix](https://www.zabbix.com/), or [AWS CloudWatch](https://aws.amazon.com/cloudwatch/): @@ -50,7 +50,7 @@ To set up monitoring for a {{ ydb-short-name }} cluster using [Prometheus](https 1. In the `targets` section specify addresses of all servers of the {{ ydb-short-name }} cluster and ports for each storage and database node that runs on the server. - For example, for the {{ ydb-short-name }} cluster that contains three servers, each server running one storage node on port 8765 and two database nodes on ports 8766 and 8767, specify nine addresses for all sensor subgroups except for the disk subgroups (for disk sensor subgroups, specify only storage node addresses): + For example, for the {{ ydb-short-name }} cluster that contains three servers, each server running one storage node on port 8765 and two database nodes on ports 8766 and 8767, specify nine addresses for all metrics subgroups except for the disk subgroups (for disk metrics subgroups, specify only storage node addresses): ```json static_configs: diff --git a/ydb/docs/ru/core/devops/manual/monitoring.md b/ydb/docs/ru/core/devops/manual/monitoring.md index ccc30f6bfc5f..e2f314055584 100644 --- a/ydb/docs/ru/core/devops/manual/monitoring.md +++ b/ydb/docs/ru/core/devops/manual/monitoring.md @@ -2,7 +2,7 @@ На этой странице рассказано, как настроить мониторинг кластера {{ ydb-short-name }}. -{{ ydb-short-name }} предоставляет множество сенсоров состояния системы. Мгновенные значения сенсоров можно посмотреть в веб-интерфейсе: +{{ ydb-short-name }} предоставляет множество метрик состояния системы. Мгновенные значения метрик можно посмотреть в веб-интерфейсе: ```text http://:/counters/ @@ -16,13 +16,13 @@ http://:/counters/ - `` – порт {{ ydb-short-name }}. Значение по умолчанию: 8765. -Связанные сенсоры объединены в подгруппы (например `counters auth`). Чтобы посмотреть значения сенсоров только определенной подгруппы, перейдите по URL следующего вида: +Связанные метрики объединены в подгруппы (например `counters auth`). Чтобы посмотреть значения метрик только определенной подгруппы, перейдите по URL следующего вида: ```text http://:/counters/counters=/ ``` -- `` — имя подгруппы сенсоров. +- `` — имя подгруппы метрик. Например, данные об утилизации аппаратных ресурсов сервера доступны по следующему URL: @@ -30,13 +30,13 @@ http://:/counters/counters=/ http://:/counters/counters=utils ``` -Для сбора значений метрик вы можете использовать популярный инструмент с открытым исходным кодом [Prometheus](https://prometheus.io/) или любую другую систему с поддержкой этого формата. Значения сенсоров {{ ydb-short-name }} в [формате Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) доступны по URL следующего вида: +Для сбора значений метрик вы можете использовать популярный инструмент с открытым исходным кодом [Prometheus](https://prometheus.io/) или любую другую систему с поддержкой этого формата. Значения метрик {{ ydb-short-name }} в [формате Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) доступны по URL следующего вида: ```text http://:/counters/counters=/prometheus ``` -- `` — имя подгруппы сенсоров. +- `` — имя подгруппы метрик. Визуализировать данные можно с помощью любой системы, которая поддерживает формат Prometheus, например [Grafana](https://grafana.com/), [Zabbix](https://www.zabbix.com/ru/) или [Amazon CloudWatch](https://aws.amazon.com/ru/cloudwatch/): @@ -52,7 +52,7 @@ http://:/counters/counters=/prometheu 1. В секции `targets` укажите адреса всех серверов кластера {{ ydb-short-name }} и порты каждого из узлов хранения и узлов базы данных, работающих на сервере. - Например, для кластера из трёх серверов, где на каждом сервере работает один узел хранения на порте 8765 и два узла базы данных на портах 8766 и 8767, необходимо прописать девять адресов для всех подгрупп сенсоров, кроме дисковых (для дисковых подгрупп сенсоров необходимо указать только адреса узлов хранения): + Например, для кластера из трёх серверов, где на каждом сервере работает один узел хранения на порте 8765 и два узла базы данных на портах 8766 и 8767, необходимо прописать девять адресов для всех подгрупп метрик, кроме дисковых (для дисковых подгрупп метрик необходимо указать только адреса узлов хранения): ```json static_configs: