Setting up external monitoring with collectd

Configure external monitoring systems to collect and analyze collectd metrics from your GitHub Enterprise Server instance.

本文内容

Collectd metrics are gathered by default and are fully supported in this release. OpenTelemetry metrics are the future foundation for monitoring, available from GitHub Enterprise Server 3.18 onward.

注意

Collectd metrics are expected to be 弃用 and then 已停用 in a future release of GitHub Enterprise Server. We recommend that your long-term monitoring strategy includes a migration to OpenTelemetry metrics. See About OpenTelemetry metrics.

Set up an external collectd server

If you haven't already set up an external collectd server, you will need to do so before enabling collectd forwarding on 你的 GitHub Enterprise Server 实例. Your collectd server must be running collectd version 5.x or higher.

  1. Log into your collectd server.
  2. Create or edit the collectd configuration file to load the network plugin and populate the server and port directives with the proper values. On most distributions, this is located at /etc/collectd/collectd.conf

An example collectd.conf to run a collectd server:

LoadPlugin network
...
...
<Plugin network>
    Listen "0.0.0.0" "25826"
</Plugin>

Enabling collectd forwarding on GitHub Enterprise

By default, collectd forwarding is disabled on GitHub Enterprise. Follow the steps below to enable and configure collectd forwarding:

  1. 在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击“”。

  2. 如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。

  3. 在“ 站点管理”边栏中，单击“管理控制台”****。

  4. Below the log forwarding settings, select Enable collectd forwarding.

  5. In the Server address field, type the address of the collectd server to which you'd like to forward GitHub Enterprise appliance statistics.

  6. In the Port field, type the port used to connect to the collectd server. (Defaults to 25826)

  7. In the Cryptographic setup dropdown menu, select the security level of communications with the collectd server. (None, signed packets, or encrypted packets.)

  8. 在“设置”边栏下，单击“保存设置”。

    注意

    保存 管理控制台 中的设置会重启系统服务，这可能会导致用户可察觉的停机时间。

  9. 等待配置运行完毕。

Troubleshooting

Central collectd server receives no data

GitHub Enterprise ships with collectd version 5.x. collectd 5.x is not backwards compatible with the 4.x release series. Your central collectd server needs to be at least version 5.x to accept data sent from 你的 GitHub Enterprise Server 实例.

For help with further questions or issues, visit GitHub Enterprise 支持.