Enabling advanced dashboards of OpenTelemetry metrics

After enabling OpenTelemetry metrics collection on your GitHub Enterprise Server instance, you have access to additional dashboards with enhanced visualization and monitoring capabilities.

В этой статье

OpenTelemetry metrics are the future foundation for monitoring, available from GitHub Enterprise Server 3.18 onward. This new monitoring stack provides enhanced observability and management capabilities compared to the legacy collectd system.

Collectd metrics continue to be gathered by default and remain fully supported in this release.

Примечание.

OpenTelemetry metrics are in public preview and subject to change. We would love to hear your feedback on the preview. You can share it with your customer success team, or leave a comment in the community discussion post.

Additional dashboards

When OpenTelemetry metrics are enabled, you can turn on advanced Grafana dashboards with enhanced visualization and monitoring capabilities.

  • Elasticsearch - Detailed metrics for search performance, indexing operations, and cluster health
  • Nomad - In-depth monitoring of job scheduling, resource allocation, and service orchestration
  • HAProxy - Load balancer performance metrics, connection statistics, and request routing information
  • Node Exporter - System-level metrics including CPU, memory, disk, and network statistics for each node
  • Process Exporter - Detailed process-level metrics for monitoring individual service performance

These dashboards provide more granular insights into your GitHub Enterprise Server instance's performance and can help with advanced troubleshooting and capacity planning.

Prerequisites

  • OpenTelemetry metrics are enabled for your GitHub Enterprise Server instance
  • SSH access to your GitHub Enterprise Server instance

Enabling advanced dashboards

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

    Shell
    ssh -p 122 admin@HOSTNAME

  2. Run the following command to enable advanced dashboards:

    ghe-config observability.metrics.advanced-dashboards-enabled true

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

    Примечание.

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

    Shell
    ghe-config-apply

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

After running these commands, your external Grafana instance will have access to additional pre-configured dashboards.