Skip to content
Exlogare
Exlogare / Документация

Начало работы

Регистрация, подключение GitLab, GitHub или Bitbucket и первый RCA в MR или PR за 5 минут.

Эта инструкция — путь от нуля до первого RCA-комментария в merge request или pull request менее чем за пять минут.

1. Создайте аккаунт

Откройте app.exlogare.net/login и введите рабочий email. Мы отправим магическую ссылку — по клику откроется мастер онбординга и автоматически создастся тенант. Пароль не нужен.

На тарифе Free сразу доступно до 20 анализов и до 10 подключённых проектов — этого достаточно, чтобы пройти полный путь и убедиться, что RCA соответствует вашим пайплайнам. Тариф и остаток анализов всегда видно в Settings → Billing.

2. Подключите CI (GitLab, GitHub или Bitbucket)

GitLab

В мастере доступны три режима подключения:

  1. OAuth Connect — один клик, авторизация через GitLab, автопоиск проектов, webhook регистрируется автоматически.
  2. Webhook-only — когда OAuth запрещён политикой. Либо вручную копируете URL и секрет в настройки проекта, либо передаёте короткоживущий Personal Access Token (PAT), и мастер сам зарегистрирует webhook.
  3. Hybrid (webhook + polling) — webhook для реалтайма + периодический опрос на случай, если хук не дошёл. Доступен на платных тарифах.

Для gitlab.com регистрировать OAuth-приложение не нужно — используется платформенное приложение Exlogare. Для self-hosted GitLab потребуется зарегистрировать OAuth-приложение.

GitHub Actions

  • В мастере выберите GitHub Actions и войдите через OAuth. Exlogare покажет репозитории, зарегистрирует webhook workflow_run на выбранных репо и анализирует падения так же, как для GitLab.
  • Для github.com оператор может задать платформенные OAuth-учётные данные, чтобы вам не создавать своё приложение. Для GitHub Enterprise оформляйте OAuth App в организации и введите Client ID и Client secret в пути self-hosted — см. настройка GitHub OAuth.
  • Режимы и квоты (webhook, OAuth polling, hybrid) как у GitLab, лимиты по провайдеру видны в Integrations и в возможностях плана.

Bitbucket Pipelines

Поддерживаются обе версии Bitbucket: Bitbucket Cloud (bitbucket.org) и Bitbucket Data Center / Server.

  • Bitbucket Cloud — выберите Bitbucket Pipelines → Cloud и авторизуйтесь через OAuth. Exlogare покажет workspaces и репозитории, зарегистрирует webhook repo:commit_status_updated на выбранных репозиториях и проанализирует упавшие пайплайны. Режимы (webhook, OAuth polling, hybrid) как у GitLab/GitHub.
  • Bitbucket Data Center / Server — выберите Bitbucket Pipelines → Self-hosted. OAuth для DC не предусмотрен: укажите базовый URL, project key и repo slug — мастер вернёт webhook URL и общий секрет. Либо вставляете их вручную в Repository settings → Webhooks, либо передаёте мастеру Personal Access Token, и мы зарегистрируем webhook сами. DC слушает событие repo:build_status_updated, которое генерирует ваш внешний CI (Jenkins / Bamboo / TeamCity) через Build Status REST API. DC < 7.4 не отправляет событие build_status — обновите DC до 7.4+ или используйте POST /api/analyze для ручной загрузки.

Для обеих версий мы используем тот же RCA-каскад, что и для GitLab/GitHub: PR comment → commit comment, в зависимости от того, что доступно для упавшего ран. См. настройка Bitbucket OAuth для регистрации client_id / client_secret в Cloud.

3. Сломайте пайплайн специально

Запушьте коммит в ветку, которая гарантированно упадёт. В течение 60 секунд в связанном merge request (GitLab) или pull request (GitHub) появится RCA-комментарий. Если его нет — смотрите Dashboard → Events: там видно, дошёл ли webhook и какой был ответ.

4. (Опционально) Создайте API-токен

Если нужно POST-ить билд-логи Jenkins или скриптовать обращение к Exlogare из CI — откройте Settings → API tokens в дашборде (требуется роль admin) и создайте токен со скоупами ingest и/или read. Секрет exl_… отображается один раз — скопируйте его в секрет-менеджер до закрытия диалога. API-токены доступны от тарифа Startup.

Нужна помощь?

В левом сайдбаре дашборда есть кнопка поддержки: откроется модалка, где можно создать тикет (тех. вопрос или обращение в sales для апгрейда до Enterprise). Мы отвечаем по будням.

Дальше

  • Режим webhook — URL, события, проверка доставки.
  • Режим OAuth — GitLab и GitHub, в том числе Enterprise.
  • API reference — программный доступ через API-токены.