Prometheus Gitee Exporter

Предоставляет основные метрики для ваших репозиториев из API Gitee в совместимую с Prometheus конечную точку.

(Большая часть вдохновения взята от github-exporter, спасибо команде [infinityworks] за предоставление нам таких замечательных примеров.)

Конфигурация

Этот экспортер настроен на получение входных данных из переменных среды:

Обязательные

• ORGS Если указано, экспортер будет перечислять все репозитории для этой организации. Ожидается формат «org1, org2».
• REPOS Если указано, отслеживаются указанные репозитории, ожидается формат «user/repo1, user/repo2». Может быть у разных пользователей/организаций Gitee.
• USERS Если указано, экспортер будет перечислять все репозитории этих пользователей. Ожидается формат «user1, user2».

Необходимо указать хотя бы один из этих трёх параметров.

Необязательные

• GITEE_TOKEN Если указан, позволяет пользователю предоставить токен аутентификации Gitee, который позволяет чаще запрашивать API. Необязательно, но рекомендуется.
• GITEE_TOKEN_FILE Если указан вместо GITEE_TOKEN, позволяет пользователю указать путь к файлу, содержащему токен аутентификации Gitee, что позволяет чаще запрашивать API. Необязательно, но рекомендуется.
• API_URL URL-адрес API Gitee, не нужно его менять. По умолчанию — https://gitee.com/api/v5.
• LISTEN_PORT Порт, на котором вы хотите запустить контейнер, по умолчанию в Dockerfile — 9190.
• METRICS_PATH путь URL-адреса метрик, который вы хотите использовать, по умолчанию — /metrics.
• LOG_LEVEL Уровень ведения журнала, с которым будет работать экспортер, по умолчанию — debug.

Установка и развёртывание

Запустите вручную из Docker Hub:

docker run -d --restart=always -p 9190:9190 -e REPOS="oscstudio/gitee-exporter, atompitestorg/testrepo" oscstudio/gitee-exporter

Создайте образ Docker:

docker build -t <имя образа> .
docker run -d --restart=always -p 9190:9190 -e REPOS="oscstudio/gitee-exporter, atompitestorg/testrepo" <имя образа>

Docker compose

gitee-exporter:
    tty: true
    stdin_open: true
    expose:
      - 9190
    ports:
      - 9190:9190
    image: oscstudio/gitee-exporter:latest
    environment:
      - REPOS=<Репозитории, которые вы хотите отслеживать>
      - GITEE_TOKEN=<Ваш токен API gitee>

Метрики

Метрики будут доступны по порту 9190 по умолчанию. Пример этих метрик можно найти в файле Markdown METRICS.md в корне этого репозитория.

Тесты

Существует набор тестов чёрного ящика, которые проверяют конечную точку метрик в каталоге test. Запустите следующим образом:

make test