diff options
author | Aleksandr Dmitriev <alexd.65536@gmail.com> | 2022-06-15 10:09:33 +0300 |
---|---|---|
committer | Aleksandr Dmitriev <alexd.65536@gmail.com> | 2022-06-15 10:09:33 +0300 |
commit | ce720b87d9fb858d086a05ae73ae739a77dc894f (patch) | |
tree | 09e9f87730e638248870be291a0a859d102ed7b7 | |
parent | 0812defb9cb317d4d70b99f2c4d0a88876dddbfe (diff) | |
download | ydb-ce720b87d9fb858d086a05ae73ae739a77dc894f.tar.gz |
local grafana integration docs KIKIMR-15032
ref:a0e0189682204861ebf623f51e80a3798ebdb355
-rw-r--r-- | ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_local.md | 11 | ||||
-rw-r--r-- | ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md | 11 |
2 files changed, 22 insertions, 0 deletions
diff --git a/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_local.md b/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_local.md index 473a09bdb83..7da871050bd 100644 --- a/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_local.md +++ b/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_local.md @@ -72,6 +72,17 @@ ydb -e grpc://localhost:2136 -d /Root/test scheme ls To work with the DB structure and data, you can also use the web interface embedded in the `ydbd` process. It is available at `http://localhost:8765`. For more information about the embedded web interface, see [Embedded UI](../../../maintenance/embedded_monitoring/ydb_monitoring.md). + +## Monitoring database using Grafana and Prometheus {#dashboards} + +The local YDB server may be integrated with [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/), popular open source tools for metrics gathering and visualization. To setup standard [dashboards](../../../troubleshooting/grafana_dashboards.html), follow these instructions: + +1. [Install and run](https://prometheus.io/docs/prometheus/latest/getting_started/#downloading-and-running-prometheus) Prometheus with this [configuration file](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_ydb_prometheus.yml). +1. [Install and run](https://grafana.com/docs/grafana/latest/getting-started/getting-started/) Grafana. +1. [Create](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source) datasource of type "prometheus" in Grafana and connect it to your Prometheus instance. +1. Upload [dashboards](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/) to Grafana. You may upload dashboards manually via Grafana UI [Import](https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-dashboard) function or use simple [script](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/grafana_dashboards/local_upload_dashboards.sh). Please note that the script uses [basic authentification](https://grafana.com/docs/grafana/latest/http_api/create-api-tokens-for-org/#authentication) in Grafana. For other cases, adjust the script accordingly. + + ## Advanced options {#advanced} Instructions on how to deploy multi-node clusters and configure them are given in [Deploy YDB on-premises](../../../deploy/manual/deploy-ydb-on-premises.md) in the "Cluster management" section. 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 60b43441b04..c1ce258ed88 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,6 +72,17 @@ 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 |