Настройка OpenTelemetry для экземпляра

Узнайте, как настроить сбор метрик OpenTelemetry на экземпляре GitHub Enterprise Server для улучшенного мониторинга и наблюдения.

В этой статье

Метрики OpenTelemetry — это будущая основа для мониторинга, доступная начиная с GitHub Enterprise Server 3.18 и выше. Этот новый стек мониторинга обеспечивает расширенные возможности наблюдения и управления по сравнению с устаревшей системой сбора данных.

Собранные метрики по-прежнему собираются по умолчанию и полностью поддерживаются в этом выпуске.

Примечание.

Метрики OpenTelemetry находятся в Публичный предварительный просмотр и могут быть изменены. Мы будем рады услышать ваши отзывы о предварительном просмотре. Вы можете поделиться им со своей командой по работе с клиентами или оставить комментарий в сообщении в обсуждении сообщества.

Предпосылки

  • GitHub Enterprise Server 3.18 или более поздней версии
  • Административный доступ к Консоль управления
  • SSH-доступ к устройству GitHub Enterprise Server

Включение метрик OpenTelemetry

Метрики OpenTelemetry отключены по умолчанию. Вы можете включить их с помощью Консоль управления или командной строки.

Использование Консоль управления

  1. В учетной записи администратора GitHub Enterprise Server, в правом верхнем углу любой страницы щелкните .

  2. Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта.

  3. На боковой панели " "Администратор сайта" щелкните Консоль управления.

  4. В параметрах мониторинга выберите Включить OpenTelemetry.

  5. На боковой панели "Параметры" нажмите кнопку "Сохранить параметры".

    Примечание.

    Сохранение параметров в Консоль управления перезапускает системные службы, что может привести к простоям, видимым пользователем.

  6. Подождите завершения запуска конфигурации.

Использование командной строки

  1. SSH в ваш экземпляр GitHub Enterprise Server. Если экземпляр состоит из нескольких узлов, например, если настроен высокий уровень доступности или георепликация, передача осуществляется по SSH в основной узел. При использовании кластера можно использовать для передачи по SSH в любой узел. Замените HOSTNAME именем узла для экземпляра, именем узла или IP-адресом узла. Дополнительные сведения см. в разделе Доступ к административной оболочке (SSH).

    Shell
    ssh -p 122 admin@HOSTNAME

  2. Выполните следующую команду, чтобы включить метрики OpenTelemetry.

    ghe-config observability.metrics.next-enabled true

  3. Чтобы применить конфигурацию, выполните следующую команду.

    Примечание.

    Во время выполнения конфигурации службы на ваш экземпляр GitHub Enterprise Server могут перезапуститься, что может привести к краткому простою для пользователей.

    Shell
    ghe-config-apply

  4. Подождите завершения запуска конфигурации.

Вопросы, связанные с производительностью

При настройке метрик OpenTelemetry учитывайте следующие факторы производительности:

  • Частота сбора: более частый сбор увеличивает нагрузку на систему
  • Хранение данных: более длительные сроки хранения требуют большего объема хранилища
  • Пользовательские экспортеры: Дополнительные экспортеры могут увеличить использование процессора и памяти
  • Пропускная способность сети: доставка внешних метрик влияет на использование сети

Настройка сбора метрик

После включения метрик OpenTelemetry вы можете настроить различные аспекты процесса сбора метрик.

Настройка интервалов сбора данных

По умолчанию интервал сбора метрик составляет 30 секунд. Вы можете настроить это в зависимости от ваших потребностей в мониторинге.

Внимание

Установка более коротких интервалов повышает точность метрик, но также увеличивает требования к хранилищу и нагрузку на систему. Прежде чем настраивать этот параметр, учитывайте системные ресурсы и требования к мониторингу.

Использование Консоль управления для установки интервалов

  1. В учетной записи администратора GitHub Enterprise Server, в правом верхнем углу любой страницы щелкните .

  2. Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта.

  3. На боковой панели " "Администратор сайта" щелкните Консоль управления.

  4. В настройках мониторинга в разделе Интервал парсинга метрик введите нужный интервал в секундах (например, 60).

  5. На боковой панели "Параметры" нажмите кнопку "Сохранить параметры".

    Примечание.

    Сохранение параметров в Консоль управления перезапускает системные службы, что может привести к простоям, видимым пользователем.

  6. Подождите завершения запуска конфигурации.

Использование командной строки для установки интервалов

SSH в устройство GitHub Enterprise Server и выполните следующие команды:

# Set scrape interval to 60 seconds
ghe-config observability.metrics.interval 60
ghe-config-apply

Настройка хранения данных

По умолчанию данные метрик хранятся в течение 30 дней. Вы можете изменить эту настройку с помощью Консоль управления или командной строки.

Использование Консоль управления для настройки хранения

  1. В учетной записи администратора GitHub Enterprise Server, в правом верхнем углу любой страницы щелкните .

  2. Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта.

  3. На боковой панели " "Администратор сайта" щелкните Консоль управления.

  4. В настройках мониторинга в разделе Удержание метрик введите желаемый срок хранения в днях (например, 15).

  5. На боковой панели "Параметры" нажмите кнопку "Сохранить параметры".

    Примечание.

    Сохранение параметров в Консоль управления перезапускает системные службы, что может привести к простоям, видимым пользователем.

  6. Подождите завершения запуска конфигурации.

Использование командной строки для настройки хранения

SSH в устройство GitHub Enterprise Server и выполните следующие команды:

# Set retention to 15 days
ghe-config observability.metrics.retention 15
ghe-config-apply

Настройка уровня детализации для внутренней телеметрии

Сборщик OpenTelemetry создает собственные внутренние данные телеметрии для мониторинга работоспособности и производительности самого сборщика. Вы можете настроить детализацию этой внутренней телеметрии с помощью командной строки.

Доступны следующие уровни телеметрии:

  • none: Отключает внутреннюю телеметрию
  • basic: предоставляет важные данные телеметрии (по умолчанию)
  • normal: Предоставляет стандартные данные телеметрии
  • detailed: предоставляет подробные данные телеметрии для отладки

SSH в устройство GitHub Enterprise Server и выполните следующие команды:

# Set internal telemetry level to normal
ghe-config observability.metrics.internal-otel-telemetry-level normal
ghe-config-apply

Примечание.

Более высокие уровни телеметрии предоставляют более подробную информацию о внутренних операциях сборщика, но также увеличивают использование ресурсов. Этот basic уровень рекомендуется использовать в производственных средах, если вам не требуется устранение неполадок со сборщиком.

Устранение проблем с конфигурацией

Если у вас возникли проблемы с конфигурацией OpenTelemetry, следующие сведения могут помочь вам выявить и устранить распространенные проблемы.

Распространенные проблемы с конфигурацией

  • Сбои при запуске службы: проверка системных журналов на наличие сообщений об ошибках
  • Ограничения ресурсов: мониторинг системных ресурсов при настройке интервалов сбора данных

Просмотр локальных журналов

SSH в узел, который требуется отладить, и выполните следующие команды:

Просмотр журналов сборщика OpenTelemetry:

sudo journalctl -u otelcol-contrib -f

Посмотреть логи VictoriaMetrics:

sudo journalctl -u victoriametrics -f

Дальнейшие шаги