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.

In diesem Artikel

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.

Hinweis

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. Melde dich über SSH bei Ihre GitHub Enterprise Server-Instance an. Wenn deine Instanz mehrere Knoten umfasst, wenn z. B. Hochverfügbarkeit oder Georeplikation konfiguriert ist, wird SSH im primären Knoten konfiguriert. Wenn du einen Cluster verwendest, kannst du SSH in einen beliebigen Knoten einfügen. Ersetzen Sie HOSTNAME durch den Hostnamen Ihrer Instanz bzw. durch den Hostnamen oder die IP-Adresse eines Knotens. Weitere Informationen finden Sie unter Auf die Verwaltungsshell (SSH) zugreifen.

    Shell
    ssh -p 122 admin@HOSTNAME

  2. Run the following command to enable advanced dashboards:

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

  3. Führe den folgenden Befehl aus, um die Konfiguration anzuwenden.

    Hinweis

    Während einer Konfigurationsausführung können die Dienste auf Ihre GitHub Enterprise Server-Instance neu gestartet werden, was zu kurzen Ausfallzeiten für Benutzer führen kann.

    Shell
    ghe-config-apply

  4. Warten Sie auf den Abschluss der Konfigurationsausführung.

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