GitHub Enterprise Server のサポート バンドルについて

GitHub Enterprise Server インスタンスで問題が発生した場合、サポート バンドルが、GitHub のサポート に、問題を迅速に解決するのに必要な診断データを提供します。

この記事で

サポート バンドルについて

サポート バンドルは、GitHub Enterprise Server インスタンスからの診断データの圧縮アーカイブです。 サポート バンドルを使用すると、GitHub のサポート で問題を処理したり、インスタンスの構成、正常性、およびアクティビティを要約した正常性チェック レポートを生成したりできます。

サポート バンドルを生成するタイミング

いくつかのシナリオでサポート バンドルを生成します。

サポート チケットの調査

GitHub のサポート は、パフォーマンスの問題、サービス障害、認証の問題、またはその他の運用上の課題を調査するときにサポート バンドルを要求されることがあります。 最初にサポート チケットを開き、バンドルを生成し、チケット番号を含めてケースに関連付けます。 詳細については、「コマンド ライン ユーティリティ」を参照してください。

ヘルスチェックの分析

サポート バンドルを生成して、正常性チェック レポートを作成できます。 正常性チェックでは、サポート バンドル データが分析され、インスタンスの正常性、セキュリティ、Git 操作、API の使用状況がレポートされます。 詳細については、「企業向けヘルスチェックを生成する」を参照してください。

サポート バンドルの内容

サポート バンドルには、インスタンスからのデータのいくつかのカテゴリが含まれています。 正確な内容は、GitHub Enterprise Server のバージョンと構成によって異なります。

システムとインスタンスの情報

サポート バンドルには、バージョン情報、システム構成、ライセンスの詳細、 ghe-diagnostics コマンドからの出力など、インスタンスの設定と環境に関する診断データが含まれます。 診断情報の完全な一覧については、 GitHub サポートにデータを提供する を参照してください。

ログ ファイル

サポート バンドルには、インスタンスのシステム サービス、アプリケーション、データベースからのログ ファイルが含まれます。 収集されるログ データの量は、バンドルの種類によって異なります。 使用可能なログ ファイルの詳細については、 AUTOTITLE を参照してください。

標準バンドルと拡張バンドル

サポート バンドルには 2 種類あります。 標準バンドルは小さく、生成が速くなりますが、拡張バンドルでは詳細なトラブルシューティングのためのより包括的なデータが提供されます。

標準バンドル拡張バンドル (-x フラグ)
          **ログの期間** | 2 日 | 8 日間 |

| ローテーションされたログ ファイル | 除外 | 含む | | コアダンプ | 除外 | 含む | | ディスク使用状況レポート | 除外 | 含む | | ホットパッチ ログ | 最新のみ | すべてのバージョン |

GitHub のサポート は、生成するバンドルの種類を推奨します。 不明な場合は、拡張バンドルを生成して、すべての診断データが使用可能であることを確認します。 --period フラグ (--period '4 days' など) を使用して、カスタム ログ期間を指定することもできます。

サービスの状態とメトリック

サポート バンドルには、現在のサービス正常性状態、プロセス情報、パフォーマンス メトリック、インスタンスで実行されている主要サービスの構成ファイルが含まれます。

高可用性情報

インスタンスで高可用性またはクラスタリングを使用する場合、サポート バンドルには次のものが含まれます。

  • レプリケーションの状態とラグの情報
  • クラスター ノードの構成
  • キャッシュ レプリカの詳細

データのプライバシーとセキュリティ

サポート バンドルは、機密情報を保護しながら問題を診断できるように設計されています。

  •         **サニタイズ**: パスワード、トークン、秘密キーなどの機密データは、収集前に削除または難読化されます。

  •         **リポジトリの内容なし**: サポート バンドルには、ソース コード、コミット データ、ファイルの内容など、Git リポジトリの内容は含まれません。

  •         **ユーザー データ**: サポート バンドルには、システム ログに表示される以外のユーザー プロファイル情報は含まれません。

  •         **ライセンス情報**: バンドルには組織名とライセンス参照が含まれているため、 GitHub のサポート はインスタンスを識別できます。

GitHub のサポート にサポート バンドルを提供すると、GitHub はサポート 要求に対応するためにのみデータを使用します。 GitHub がデータを処理する方法の詳細については、 GitHub プライバシーに関する声明を参照してください。

バンドルのサイズと生成時間をサポートする

サポート バンドルのサイズと生成時間は、次の内容によって異なります。

  • インスタンスのサイズとアクティビティ レベル
  • リポジトリの数とサイズ
  • 最後のログローテーションからの時間の長さ
  • インスタンスがクラスタリングを使用しているか高可用性を使用しているか

一般的なサポート バンドルの範囲は、数百 MB から数 GB です。 非常に大きいインスタンスや負荷の高いインスタンスの場合、バンドルの生成には数分から 1 時間以上かかる場合があります。

大規模なサポート バンドルは、生成中のインスタンスのパフォーマンスに影響する可能性があります。 次の点を考慮してください。

  •         **システム負荷**: サポート バンドルを生成するには、CPU、メモリ、ディスク I/O リソースが使用されます。

  •         **タイミング**: 可能であれば、ピーク外の時間帯にサポート バンドルを生成します。

  •         **メンテナンス モード**: インスタンスに重大なパフォーマンスの問題がある場合は、サポート バンドルを生成する前にメンテナンス モードを有効にして正常に完了することを検討してください。 詳細については、「[AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)」を参照してください。

パフォーマンスへの影響の軽減

          `ghe-support-bundle` コマンドは、CPU と I/O の優先順位が最も低い時点で自動的に実行されるため、運用環境のワークロードが優先されます。 生成中のリソース使用量をさらに減らすために、次のフラグを使用できます。

* --no-async (-n): コレクションを並列ではなく順番に実行し、リソースの競合を減らします。 * --num-jobs 1 (-l 1): 並列処理を 1 つのコレクション スレッドに制限します。 既定値は、使用可能な CPU 数の 3 分の 1 です。

たとえば、パフォーマンスへの影響を最小限に抑えて拡張バンドルを生成してアップロードするには、次のようにします。

ghe-support-bundle -x -u --no-async --num-jobs 1

他の診断ツールとの関係

サポート バンドルは、他の監視および診断機能と共に機能します。

診断ファイル

          `ghe-diagnostics` コマンドは、完全なサポート バンドルからの情報のサブセットを含む小さな診断ファイルを生成します。 診断ファイルは、迅速な正常性チェックや、完全なサポート バンドルを生成できない場合に役立ちます。 診断出力は、すべてのサポート バンドルにも含まれます。

ダッシュボードの監視

[Management Console] の [監視] ページには、インスタンスに関するリアルタイムメトリックと履歴メトリックが表示されます。 詳細については、「モニター ダッシュボードについて」を参照してください。

サポート バンドルの生成と共有

[Management Console] またはコマンド ラインを使用して、サポート バンドルを生成および共有できます。 詳しい手順については、「GitHub サポートにデータを提供する」を参照してください。

クラスタリングに関する考慮事項

GitHub Enterprise Server のクラスタリングを使う場合、次のものを生成することができます。

  •         **ノードごとのバンドル**: 個々のクラスター ノードのバンドルをサポートします。

  •         **クラスター バンドル**: `ghe-cluster-support-bundle`を使用するすべてのクラスター ノードから結合されたバンドル。

GitHub のサポート は、調査中の問題に基づいて生成するバンドルの種類をアドバイスします。

サポート バンドルの生成に失敗しました

バンドルの生成に失敗した最も一般的な原因は、 /data/user/tmpの空きディスク領域が不足している点です。 サポート バンドルは圧縮前にこのディレクトリに組み込まれているため、圧縮されていないデータを保持するのに十分なスペースが必要です。 バンドルを生成する前に、使用可能な領域を確認します。

df -h /data/user/tmp

生成が失敗した場合、または非常に長い時間がかかる場合は、 /data/user/tmp の領域を解放して、もう一度やり直してください。 問題が解決しない場合は、GitHub のサポート にお問い合わせください。 別の方法として、 ghe-diagnostics コマンドを使用して、より小さな診断ファイルを生成することもできます。

詳細については、次を参照してください。

  •         [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs)

  •         [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-support-bundle)

  •         [AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support)