Setting up external monitoring with collectd

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

この記事の内容

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. [ Site admin] サイドバーで、[[Management Console]] をクリックします。

  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. [設定] サイドバーで [設定の保存] をクリックします。

    メモ

    [Management Console] で設定を保存すると、システム サービスが再起動され、ユーザーにわかるダウンタイムが発生する可能性があります。

  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 サポート.