为实例配置 collectd

关于 GitHub Enterprise Server 的 collectd

collectd 是在你的 GitHub Enterprise Server 实例上运行的服务，用于收集和提供系统性能相关指标。 collectd 收集的常见指标包括 CPU 利用率、内存和磁盘消耗、网络接口流量和错误以及系统的总体负载。还可将数据转发到其他 collectd 服务器。有关详细信息，请参阅 collectd wiki。

实例使用 collectd 的指标在管理控制台的监视器仪表板中显示图形。有关详细信息，请参阅“关于监视器仪表板”。

可以查看 collectd 在你的 GitHub Enterprise Server 实例上收集的指标列表。有关详细信息，请参阅“GitHub Enterprise Server 的 collectd 指标”。

Tip

在 GitHub Enterprise Server 3.16 中，添加了对以 Prometheus 格式导出 collectd 指标的支持。此更新不会更改设备中现有的指标堆栈，但由于支持 Prometheus 协议，因此更容易将指标引入可观测性平台。现在可使用一个额外选项，通过终结点以 Prometheus 格式公开所收集的指标。请参阅“导出和抓取 Prometheus 指标”。

设置外部 `collectd` 服务器

如果尚未设置外部 collectd 服务器，则需要在对你的 GitHub Enterprise Server 实例启用 collectd 转发之前进行设置。 collectd 服务器必须运行 collectd 5.x 或更高版本。

登录到 collectd 服务器。
创建或编辑 collectd 配置文件，以加载网络插件并使用正确的值填充服务器和端口指令。在大多数发行版中，该文件位于 /etc/collectd/collectd.conf

用于运行 collectd 服务器的示例 collectd.conf：

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

在 GitHub Enterprise 上启用 collectd 转发

默认情况下，在 GitHub Enterprise 上禁用 collectd 转发。请按照以下步骤启用和配置 collectd 转发：

在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击“”。
如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。
在“ 站点管理”边栏中，单击“管理控制台”。
在日志转发设置下方，选择“启用 collectd 转发”。
在“服务器地址”字段中，输入要将 GitHub Enterprise 设备统计信息转发到的 collectd 服务器的地址。
在“端口”字段中，输入用于连接到 collectd 服务器的端口。（默认为 25826）
在“加密设置”下拉菜单中，选择与 collectd 服务器通信的安全级别。（无、签名数据包或加密数据包。）1. 在“设置”边栏下，单击“保存设置”。

Note

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

使用 `ghe-export-graphs` 导出 collectd 数据

命令行工具 ghe-export-graphs 将导出 collectd 存储在 RRD 数据库中的数据。此命令会将数据转换为 XML 格式并导出到一个 tarball (.tgz) 中。

此文件的主要用途是为 GitHub Enterprise 支持团队提供关于 VM 性能的数据（无需下载整个支持包），不应包含在常规备份导出范围中，也没有对应的导入文件。如果你通过 GitHub Enterprise 支持联系我们，我们可能会要求你提供此数据，以便协助排除故障。

使用情况

ssh -p 122 admin@[hostname] -- 'ghe-export-graphs' && scp -P 122 admin@[hostname]:~/graphs.tar.gz .

故障排除

中央 collectd 服务器未收到数据

GitHub Enterprise 随附 collectd 版本 5.x。 collectd 5.x 不能后向兼容 4.x 发行版系列。中央 collectd 服务器的版本至少需要是 5.x 才能接受从你的 GitHub Enterprise Server 实例发送的数据。

要获取其他问题的帮助，请访问 GitHub Enterprise 支持。

本文内容