diff --git a/README.md b/README.md index 1c772dc..a7b7677 100644 --- a/README.md +++ b/README.md @@ -2043,6 +2043,20 @@ curl -X POST http://localhost:8080/api/trigger/company/employees/create \ ## Интеграция с системами мониторинга Prometheus и Grafana +**Введение** + +СУБД `futriiX` изначально проектировалась как распределённая система, которой удобно управлять из командной строки и через REST API. Однако для повседневной эксплуатации, наблюдения за состоянием кластера и быстрой реакции на инциденты удобнее иметь **веб-интерфейс**. Встроенный WebUI в ядро не входит — вместо этого `futriiX` интегрируется со стандартными инструментами мониторинга **Prometheus** и **Grafana**, которые вместе дают пользователю полноценный веб-интерфейс для наблюдения и управления данными: дашборды, графики, таблицы, алерты и произвольные выборки из REST API прямо в браузере. + +Такая интеграция даёт три ключевых преимущества: + +- **Единая точка наблюдения.** Все метрики кластера, хранилища, HTTP-трафика, репликации и SAGA-транзакций собираются в одном месте — в Grafana. +- **Промышленный стандарт.** Prometheus и Grafana — де-факто стандарт observability; их используют практически во всех production-окружениях, поэтому интеграция не требует экзотических зависимостей. +- **Кроссплатформенность.** Экспортёр метрик реализован на чистой стандартной библиотеке Go и работает одинаково на Linux и OpenIndiana (illumos) — там, где `futriiX` и запускается. + +Далее описано, как включить экспорт метрик, подключить Prometheus и Grafana, и какие именно метрики и endpoint'ы доступны. + +### Что это даёт + `futriiX` умеет отдавать метрики в формате **Prometheus text exposition**. Это значит, что вы можете: - Подключить **Prometheus** как time-series базу и настроить pull-скрейпинг `/metrics`. @@ -2154,6 +2168,10 @@ curl -s http://localhost:9090/api/v1/targets | jq . ### Подключение Grafana +**Grafana** — это платформа визуализации и наблюдаемости, которая превращает собранные Prometheus метрики в живые дашборды, графики и таблицы. Именно Grafana даёт конечному пользователю `futriiX` **веб-интерфейс**: не нужно ничего программировать и разворачивать собственный UI — достаточно подключить Grafana к Prometheus, и все метрики кластера, хранилища и HTTP-трафика становятся доступны в браузере. Дополнительно, через плагин **Infinity** (или встроенный JSON API datasource), Grafana умеет обращаться напрямую к REST API `futriiX` — это открывает доступ к «сырым» данным (список БД, статус кластера, документы) в виде таблиц и панелей. + +Порядок подключения: + 1. Откройте Grafana (`http://grafana-host:3000`), войдите под администратором. 2. **Configuration → Data Sources → Add data source** → выберите **Prometheus**. 3. **URL** = `http://prometheus-host:9090`, **Scrape interval** = `15s`, нажмите **Save & Test**. @@ -2259,6 +2277,7 @@ enabled = false +

(К началу)