From 0fdec96a73aa149af22bd7abb541ed2bed9db18b Mon Sep 17 00:00:00 2001 From: Mlvn Date: Sat, 21 Nov 2026 11:05:36 +0300 Subject: [PATCH] docs: add local observability demo runbook --- .env.example | 5 +++++ LOCAL-DEMO.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 LOCAL-DEMO.md diff --git a/.env.example b/.env.example index 2b32655..763713d 100644 --- a/.env.example +++ b/.env.example @@ -28,3 +28,8 @@ OTEL_SERVICE_NAME=messenger-api OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318 OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=lab + +# Local observability demo load (enabled with --profile demo) +MOCK_RATE=2 +MOCK_WORKERS=2 +VICTORIAMETRICS_PORT=8428 diff --git a/LOCAL-DEMO.md b/LOCAL-DEMO.md new file mode 100644 index 0000000..ec153d7 --- /dev/null +++ b/LOCAL-DEMO.md @@ -0,0 +1,41 @@ +# Локальная демонстрация observability + +Запуск: + +```sh +make bootstrap +cp .env.example .env +# для текущего стенда secrets уже создаются bootstrap +docker compose --profile demo up -d +``` + +Адреса: + +- Grafana: http://localhost:3006 +- VictoriaMetrics UI/API: http://localhost:8428 +- Loki API: http://localhost:3106 +- Tempo API: http://localhost:3206 +- Prometheus (локальные alert rules): http://localhost:9096 +- Messenger API/LB: http://localhost:8086 + +Mock-load создаёт синтетических пользователей, чат, сообщения, чтение истории и health-запросы. Настройка: + +```sh +MOCK_RATE=5 MOCK_WORKERS=4 docker compose --profile demo up -d mock-load +``` + +Проверить работу: + +```sh +docker compose logs -f mock-load +curl 'http://localhost:8428/api/v1/query?query=http_server_requests_total' +curl http://localhost:3106/ready +``` + +В Grafana откройте provisioned dashboard `Messenger: API and image pipeline`; datasource по умолчанию — VictoriaMetrics. Для логов используйте Explore → Loki, для traces — Explore → Tempo. + +Остановить только генератор нагрузки: + +```sh +docker compose --profile demo stop mock-load +```