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.

Dans cet article

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.

Remarque

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 into your GitHub Enterprise Server instance. If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. Replace HOSTNAME with the hostname for your instance, or the hostname or IP address of a node. For more information, see Accessing the administrative shell (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. To apply the configuration, run the following command.

    Remarque

    During a configuration run, services on your GitHub Enterprise Server instance may restart, which can cause brief downtime for users.

    Shell
    ghe-config-apply

  4. Wait for the configuration run to complete.

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