GitHub Enterprise Server включает экспортер метрик Prometheus для упрощения наблюдения и мониторинга. Эта функция позволяет удалять метрики непосредственно с устройства, устраняя необходимость пересылки collectd
метрик на внешний collectd
сервер для преобразования перед отправкой их в систему Prometheus. Поддерживая метрики, совместимые с Prometheus, экспортер обеспечивает простую интеграцию с внешними панелями мониторинга и системами оповещений.
Включение экспорта метрик Prometheus и очистки метрик
По умолчанию экспортер метрик Prometheus и слом отключены. Включение экспортера для collectd
метрик открывает конечную точку метрик (также известно как scrape endpoint
) по адресу http(s)://HOSTNAME:9103
. Убедитесь, что правила брандмауэра разрешают трафик через порт 9103.
Вы можете включить экспортер метрик Prometheus с помощью Консоль управления, интерфейса командной строки в устройстве или API.
Включение использования Консоль управления
-
В учетной записи администратора GitHub Enterprise Server, в правом верхнем углу любой страницы щелкните .
-
Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта.
-
На боковой панели " "Администратор сайта" щелкните Консоль управления.
-
В параметрах мониторинга выберите Включить prometheus.
-
В разделе "Доверенные IPv4/IPv6-адреса" или блоки CIDR в поле списка с разделительными запятыми введите разделенный запятыми список IP-адресов или блоков CIDR. Пример:
10.0.0.1, 192.168.1.0/8
. Если это поле остается пустым, запросы на удаление из любого исходного IP-адреса будут приняты. -
На боковой панели "Параметры" нажмите кнопку "Сохранить параметры".
Note
Сохранение параметров в Консоль управления перезапускает системные службы, что может привести к простоям, видимым пользователем.
-
Подождите завершения запуска конфигурации.
Включение с помощью интерфейса командной строки
Чтобы включить экспортер метрик Prometheus, SSH в устройство GitHub Enterprise Server и выполните следующие команды:
ghe-config app.prometheus.enabled true
# Specify a comma-separated list of trusted IPv4/IPv6 addresses or CIDR blocks.
ghe-config app.prometheus.trusted-ips "10.0.0.1, 192.168.1.0/8"
ghe-config-apply
Включение использования API
Вы можете включить экспортер метрик Prometheus с помощью API, отправив PUT
запрос на обновление параметров конфигурации.
curl -L -H "Content-Type: application/json" -X PUT -u "api_key:xxxxxxx" https://<hostname>/manage/v1/config/settings -d '{"prometheus": {"enabled": true, "trusted_ips": "10.0.0.1, 192.168.1.0/8"}}'
Проверка включения экспортера метрик Prometheus
Чтобы убедиться, что экспортер метрик Prometheus включен, используйте curl
для запроса /metrics
конечной точки через порт 9103. Дополнительные сведения об административных портах см. в разделе Сетевые порты.
curl localhost:9103/metrics
В случае успешного collectd_
выполнения ответ будет содержать метрики с префиксом.
Настройка внешнего сервера Prometheus
Чтобы отменить экспортированные метрики из GitHub Enterprise Server, добавьте конфигурацию слома prometheus.yaml
в файл на внешнем сервере Prometheus.
- job_name: "ghes-prom-agent"
scrape_interval: 10s
static_configs:
- targets: ["http(s)://HOSTNAME:9103/metrics"]
Поддержка экспортера метрик Prometheus с темным стеком
Если вы использовали экспортер метрик Prometheus, так как он был темным смещен в GitHub Enterprise Server 3.12, он будет продолжать работать после обновления до 3.16. В этой версии теперь можно указать доверенные IP-адреса для запросов на удаление.
Отправка отзывов
Вы можете поделиться своими отзывами о экспорте метрик Prometheus и функции очистки с помощью GitHub. Чтобы получить справку по вопросам или проблемам, посетите Поддержка GitHub Enterprise.