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. 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 地址。 有关详细信息，请参阅“访问管理 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. 若要应用配置，请运行以下命令。

    注意

    在配置运行过程中，你的 GitHub Enterprise Server 实例 上的服务可能会重启，这可能会导致用户短暂停机。

    Shell
    ghe-config-apply

  4. 等待配置运行完毕。

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