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 공개 미리 보기 and subject to change.

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합니다. 인스턴스가 여러 노드로 구성된 경우(예: 고가용성 또는 지역 복제가 구성된 경우) 주 노드에 대한 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. 구성을 적용하려면 다음 명령을 실행합니다.

    참고 항목

    구성을 실행하는 동안 의 서비스가 다시 시작될 수 있으므로 짧은 가동 중지 시간이 발생할 수 있습니다.

    Shell
    ghe-config-apply

  4. 구성 실행이 완료될 때까지 기다립니다.

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