GitHub Enterprise Server переходит из стека собранных метрик в OpenTelemetry. Собранные данные удаляются в версии 3.23, а обновление до версии 3.23 отключает его.
Временная шкала миграции
| Версия | По умолчанию для новых установок | Поведение при обновлении | Notes |
|---|---|---|---|
| 3,18 | Collectd | Collectd | OpenTelemetry является согласием. |
| 3.19 до 3.20 | OpenTelemetry | Существующие параметры метрик сохраняются. | Экземпляры, использующие собранные данные, могут принять участие в OpenTelemetry. |
| 3.21 до 3.22 | OpenTelemetry | Обновления от версий, предшествующих версии 3.21, позволяют включить OpenTelemetry и отключить собранные данные. Обновления с версии 3.21 или более поздней версии сохраняют существующие параметры метрик. | Собранные данные по-прежнему можно повторно включить. |
| 3.23 и более поздние версии | OpenTelemetry | Функция OpenTelemetry включена и собирается отключена. | Собранные данные удаляются и не могут быть повторно включены. |
Подготовка к миграции
Перед миграцией выполните следующие действия.
- Протестируйте миграцию на промежуточном экземпляре перед применением его в рабочей среде.
- Определите интеграции мониторинга, зависящие от собранных метрик, таких как внешние панели мониторинга и оповещения.
- Если вы планируете запускать оба стека метрик в течение переходного периода, просмотрите предупреждения в стеке обеих метрик.
Переход на OpenTelemetry
Вы можете вручную перейти в OpenTelemetry в экземплярах под управлением версий 3.18 до 3.22. Если экземпляр по-прежнему использует собранные данные, рекомендуется выполнить миграцию перед обновлением до версии 3.21 или более поздней версии, чтобы заранее проверить настройку мониторинга.
Обновление с версии до версии 3.21 до версии 3.21 или 3.22 автоматически включает OpenTelemetry и отключает собранные данные, но после обновления можно повторно включить сбор. Обновление до версии 3.23 или более поздней версии включает OpenTelemetry и отключает сбор постоянно.
Для миграции требуется включение метрик OpenTelemetry и отключение собранных данных. Оба параметра доступны через Консоль управления или командную строку.
Использование Консоль управления
-
В учетной записи администратора GitHub Enterprise Server, в правом верхнем углу любой страницы щелкните .
-
Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта.
-
На боковой панели " "Администратор сайта" щелкните Консоль управления.
-
В параметрах мониторинга выберите Включить OpenTelemetry.
-
В разделе "Метрики — Собранные" выберите "Отключить собранные метрики".
-
На боковой панели "Параметры" нажмите кнопку "Сохранить параметры".
Примечание.
Сохранение параметров в Консоль управления перезапускает системные службы, что может привести к простоям, видимым пользователем.
-
Подождите завершения запуска конфигурации.
Использование командной строки
-
SSH в ваш экземпляр GitHub Enterprise Server. Если экземпляр состоит из нескольких узлов, например, если настроен высокий уровень доступности или георепликация, передача осуществляется по SSH в основной узел. При использовании кластера можно использовать для передачи по SSH в любой узел. Замените HOSTNAME именем узла для экземпляра, именем узла или IP-адресом узла. Дополнительные сведения см. в разделе Доступ к административной оболочке (SSH).
Shell ssh -p 122 admin@HOSTNAME
ssh -p 122 admin@HOSTNAME -
Чтобы включить метрики OpenTelemetry и отключить собранные, выполните следующие команды.
ghe-config observability.metrics.next-enabled true ghe-config observability.metrics.legacy-disabled true -
Чтобы применить конфигурацию, выполните следующую команду.
Примечание.
Во время выполнения конфигурации службы на ваш экземпляр GitHub Enterprise Server могут перезапуститься, что может привести к краткому простою для пользователей.
Shell ghe-config-apply
ghe-config-apply -
Подождите завершения запуска конфигурации.
Выполнение обоих стеков метрик
В версии 3.18 до 3.22 выполнение собранных и открытых стеков OpenTelemetry одновременно возможно, но не рекомендуется. Эта конфигурация содержит следующие предостережения:
- Некоторые имена метрик могут отличаться, чтобы оставаться совместимыми с собранным форматом.
- Некоторые метрики OpenTelemetry не включают метки.
- Увеличение использования ресурсов для доставки метрик обоим решениям.
Собранный пакет не используется в версии 3.23, поэтому выполнение обоих стеков невозможно после обновления.
Проверки после обновления
После завершения выполнения конфигурации выполняется миграция вручную или обновление переключили экземпляр на OpenTelemetry:
- Убедитесь, что метрики видны и собираются на вкладке "Мониторинг " на вкладке Консоль управления"Мониторинг".
- Обновите интеграции мониторинга, зависящие от собранных метрик. Сведения о подключении внешних средств см. в разделе Настройка внешнего мониторинга с помощью OpenTelemetry.
- Сведения об анализе метрик см. в разделе Использование Grafana для анализа метрик OpenTelemetry.
Просмотр исторических собранных данных
Так как исправления 3.22.3, 3.21.8, 3.20.10 и 3.19.14 вкладка "Мониторинг " включает собранные панели мониторинга для просмотра исторических данных. Эти панели мониторинга отображают собранные метрики, записанные до момента отключения собранного стека.