GitHub Enterprise Server の collectd について
collectd
は、システムのパフォーマンスに関するメトリックを収集して提供するために お使いの GitHub Enterprise Server インスタンス で実行されるサービスです。 collectd
が収集する一般的なメトリックには、CPU 使用率、メモリとディスクの使用量、ネットワーク インターフェイスのトラフィックとエラー、システム全体の負荷が含まれます。 データを別の collectd
サーバーに転送することもできます。 詳細については、「collectd Wiki」をご覧ください。
インスタンスは、collectd
からのメトリックを使用して、[Management Console] のモニター ダッシュボードにグラフを表示します。 詳しくは、「モニター ダッシュボードについて」をご覧ください。
お使いの GitHub Enterprise Server インスタンス で collectd
が収集するメトリックの一覧を確認できます。 詳しくは、「GitHub Enterprise サーバーの collectd メトリック」をご覧ください。
Tip
GitHub Enterprise Server 3.16 では、collectd
メトリックを Prometheus 形式でエクスポートできるようになりました。 この更新プログラムにより、アプライアンスの既存のメトリック スタックは変更されませんが、Prometheus プロトコルをサポートしているので、監視プラットフォームにメトリックを簡単に取り込むことができます。 追加のオプションを使うと、エンドポイントを使って収集されたメトリックを Prometheus 形式で公開できます。 「Prometheus メトリックのエクスポートとスクレイピング」を参照してください。
外部 collectd
サーバーを設定する
外部 collectd
サーバーをまだ設定していない場合、お使いの GitHub Enterprise Server インスタンス で collectd
転送を有効にする前に設定する必要があります。 collectd
サーバーでバージョン 5.x 以降を実行しているcollectd
必要があります。
collectd
サーバーにログインします。collectd
を作成、または編集することで、ネットワークプラグインをロードし、適切な値をサーバとポートのディレクティブに追加します。 ほとんどのディストリビューションでこれは/etc/collectd/collectd.conf
にあります。
collectd
サーバーを実行する collectd.conf 例:
LoadPlugin network
...
...
<Plugin network>
Listen "0.0.0.0" "25826"
</Plugin>
GitHub Enterpriseで collectd 転送の有効化
既定では、collectd
転送は GitHub Enterprise で無効になっています。 次の手順に従って、collectd
転送を有効にして設定します。
-
GitHub Enterprise Server の管理アカウントから、任意のページの右上隅にある をクリックします。
-
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
-
[ サイト管理者] サイドバーで [Management Console] をクリックします。
-
ログの転送設定の下にある [collectd 転送を有効にする] を選択します。
-
[サーバー アドレス] フィールドには GitHub Enterprise のアプライアンスの統計を転送したい
collectd
サーバーのアドレスを入力します。 -
[ポート] フィールドに、
collectd
サーバーへの接続に使用するポートを入力します。 (デフォルトは 25826) -
[暗号化のセットアップ] ドロップダウン メニューで、
collectd
サーバーとの通信のセキュリティ レベルを選択します。 (なし、署名付きパケット、パケットの暗号化) 1. [設定] サイドバーで [設定の保存] をクリックします。Note
[Management Console] で設定を保存すると、システム サービスが再起動され、ユーザーにわかるダウンタイムが発生する可能性があります。
-
設定の実行が完了するのを待ってください。
収集されたデータを ghe-export-graphs
でエクスポートする
コマンドライン ツール ghe-export-graphs
では、collectd
によって RRD データベースに格納されるデータがエクスポートされます。 このコマンドは、データを XML にして、1 つの TAR 書庫 (.tgz
) にエクスポートします。
その主な用途は、Support Bundleを一括ダウンロードする必要なく、GitHub Enterprise サポートのチームに仮想マシンのパフォーマンスに関するデータ提供することです。 定期的なバックアップエクスポートに含めてはなりません。また、その逆のインポートもありません。 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 リリース シリーズとの下位互換性がありません。 お使いの GitHub Enterprise Server インスタンス から送られるデータを受信するには、中心の collectd
サーバーは 5.x 以上のバージョンでなければなりません。
他に質問や問題がある場合、GitHub Enterprise サポート にアクセスしてください。