Документация

Gotcha — self-hosted-платформа наблюдаемости в одном Go-бинарнике: ошибки, аптайм, трейсы, метрики и профили на вашем сервере, без внешних сервисов и без передачи данных третьим лицам. Документация покрывает весь путь — от первого docker compose up до тонкой настройки продакшена, резервного копирования и обновлений.

С чего начать:

Установка — системные требования, docker compose, первый запуск;
Первые шаги — организация, проект, первое событие и первый монитор;
SDK и интеграции — подключение Sentry-совместимых SDK и OpenTelemetry (OTLP).

Если вы переезжаете с Sentry, отдельный разбор есть в блоге: как перейти с Sentry на self-hosted Gotcha. Полное оглавление — ниже, по разделам.

Начало

Первые шаги — Gotcha — платформа наблюдаемости: ошибки, производительность, метрики, аптайм и оповещения в одном месте. Она говорит на протоколе приёма Sentry, поэтому под…
Термины — Короткий словарь понятий Gotcha — от организаций и проектов до профилей и квот. Там, где у термина есть отдельная страница с подробностями, дана ссылка.
Окно времени — У каждой страницы с графиком — Производительность и страница эндпойнта, Web Vitals, Метрики, Профили, график задержек монитора и график частоты проблемы — об…

Установка и эксплуатация

Установка — Эта инструкция рассчитана на то, что вы никогда раньше не разворачивали Docker-приложения и не администрировали Linux-сервер. Все команды даны в готовом для…
Конфигурация — Gotcha полностью настраивается переменными окружения с префиксом GOTCHA_. Ни одного конфиг-файла, ни одной настройки через веб-интерфейс для системных параме…
Резервное копирование и восстановление — Gotcha хранит данные в двух разных базах, и обе одинаково важны — резервную копию нужно снимать из обеих сразу, иначе после восстановления они разойдутся (на…
Обновление — Обновление применяет миграции схемы баз данных — это необратимо (обратных миграций «на всякий случай» никто не запускает автоматически). Прежде чем обновлять…
Мониторинг самого gotcha — gotcha следит за вашими сервисами. Эта страница — о том, как следить за самим gotcha: что он рассказывает о своём здоровье и куда смотреть, если вы подозрева…
Кардинальность: почему часть имён сгруппирована — Если на странице производительности или метрик вы увидели предупреждение о лимите различных значений, а в списке появилось <cardinality-limit> — эта страница…

Разделы

Проблемы — Проблемы создаются автоматически из событий, которые присылает SDK вашего приложения — Gotcha принимает их по протоколу приёма Sentry (envelope/store), так ч…
Производительность — Раздел «Производительность» показывает не отдельные ошибки, а то, как быстро работает приложение: транзакции (обработанные запросы или фоновые операции), из…
Метрики — Раздел «Метрики» хранит числовые временные ряды, которые ваше приложение отправляет по протоколу OTLP (OpenTelemetry Protocol). Это отдельный канал приёма —…
Оповещения по метрикам — Правило оповещения по метрике следит за агрегатом метрики (avg/max/p95 и т. п.) на скользящем окне времени и открывает инцидент, когда значение пробивает зад…
Профилирование — Gotcha принимает профили двумя разными путями.
Аптайм — Раздел «Аптайм» следит за доступностью внешних адресов и сервисов через периодические проверки — мониторы. Открывается по значку с активностью в левой рельсе…
Публичные статус-страницы — Публичная статус-страница — витрина состояния выбранных мониторов проекта: отдельная страница без входа в систему, на которую можно давать ссылку пользовател…
Окна обслуживания — Окно обслуживания — заранее объявленный интервал плановых работ проекта. Пока оно активно, инциденты, открывшиеся у мониторов этого проекта, помечаются как «…
Пробы (удалённые регионы) — Проба — это отдельный процесс gotcha, запущенный в режиме --mode=probe, который выполняет проверки мониторов из своей точки сети (другой город, дата-центр, о…
Оповещения — Раздел «Оповещения» связывает правила с каналами доставки, чтобы команда узнавала о новых проблемах, регрессиях и всплесках без постоянного мониторинга дашбо…

Администрирование

Организации, проекты и команды — Роль назначается на уровне организации и действует на все её проекты:
SSO и вход через провайдеров — Помимо пароля, Gotcha умеет входить через внешних провайдеров: универсальный OIDC (любой совместимый IdP — Keycloak, Authentik, Auth0 и т.п.), Яндекс ID и VK…
Приватность и 152-ФЗ — Gotcha — self-hosted-платформа: вы разворачиваете её на своей инфраструктуре и сами распоряжаетесь всеми данными. Это значит, что в терминах Федерального зак…

Интеграции

SDK и интеграции — Gotcha не имеет собственного протокола отправки данных — она принимает события и транзакции по протоколу приёма Sentry, а метрики и профили — по OTLP и pprof…