GitHub サポートにデータを提供する

診断ファイルとサポートバンドルについて

環境内の GitHub Enterprise Server インスタンスに関する問題のトラブルシューティングを支援するために、 GitHub のサポートは 1 つ以上の種類のデータを要求する場合があります。

データ	ファイル形式	説明
診断ファイル	プレーンテキスト	インスタンスの設定と環境に関する情報が含まれます。
サポートバンドル	アーカイブ	既定では、過去 2 日間の診断ファイルとサニタイズされたログファイルが含まれています。
延長サポートバンドル	アーカイブ	過去 8 日間の診断ファイルとサニタイズされたログファイルが含まれています。

ログファイルのサニタイズについて

認証トークン、キー、およびシークレットは、サポートバンドルまたは診断ファイルに含まれる次のログディレクトリ内のログファイルから削除されます。

alambic-logs
babeld-logs
codeload-logs
enterprise-manage-logs
github-logs
hookshot-logs
lfs-server-logs
semiotic-logs
task-dispatcher-logs
pages-logs
registry-logs
render-logs
svn-bridge-logs

診断ファイルは、次を含む GitHub Enterprise Server インスタンスの設定と環境の概要です。

会社名、有効期限、ユーザライセンス数を含む顧客情報
バージョン番号及びSHA
VMアーキテクチャ
ホスト名、プライベートモード、SSLの設定
負荷及びプロセスのリスト
ネットワーク設定
認証方式と詳細
リポジトリ数、ユーザ数、その他のインストール関連データ

インスタンスの診断は、 [Management Console] からダウンロードするか、 ghe-diagnostics コマンドラインユーティリティを実行してダウンロードできます。

          [Management Console] から診断ファイルを作成する

現在 SSH アクセス権がない場合は、 [Management Console] から診断ファイルを作成できます。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅にあるをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ Site admin] サイドバーで、[[Management Console]] をクリックします。
複数の [Management Console] ユーザーアカウントを作成している場合は、 [ルートサイト管理者] または [[Management Console] ユーザー] を選びます。 [Management Console] のユーザーアカウントの詳細については、「管理コンソールへのアクセスの管理」を参照してください。
[Management Console]の資格情報を入力します。 Continue をクリックします。
上部のナビゲーションバーで [サポート] をクリックします。

       **[診断情報のダウンロード]** をクリックします。

SSHを使ったDiagnosticsファイルの作成

この方法は、 [Management Console]にサインインせずに使用できます。

          [ghe-diagnostics](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-diagnostics) コマンドライン ユーティリティを使用して、インスタンスの診断を取得します。

ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt

サポートリクエストをサブミットした後、弊社のチームとの Support Bundle の共有をお願いすることがあります。 Support Bundle は gzip 圧縮された tar アーカイブで、インスタンスの Diagnostics と以下のような重要なログが含まれます:

認証のエラーのトラブルシューティングやLDAP、CAS、SAMLの設定に役立つ認証関連のログ
```
        [Management Console] ログ
```

        `github-logs/exceptions.log`: サイトで発生した 500 件のエラーに関する情報

        `github-logs/audit.log`: GitHub Enterprise Server 監査ログ

        `babeld-logs/babeld.log`: Git プロキシ ログ

        `system-logs/haproxy.log`: HAProxy ログ

        `elasticsearch-logs/github-enterprise.log`: Elasticsearch ログ

        `configuration-logs/`: GitHub Enterprise Server構成ログ

        `collectd/logs/collectd.log`: 収集されたログ

        `mail-logs/mail.log`: SMTP 電子メール配信ログ

詳しくは、「企業の監査ログ」をご覧ください。

サポートバンドルには、デフォルトでは、過去 2 日間のログが含まれています。正確な期間を日数で指定できます。過去 8 日分のログを提供するには、延長サポートバンドルをダウンロードするとよいでしょう。詳細については、「拡張 Support Bundle の作成と提供」を参照してください。

ヒント

          GitHub のサポートに連絡すると、チケット参照リンクを含む確認メールが送信されます。

          GitHub のサポートサポート バンドルのアップロードを求められた場合は、チケット参照リンクを使用してサポート バンドルをアップロードできます。

          [Management Console]からサポートバンドルを作成する方法

Web ベースの [Management Console] にアクセスでき、送信インターネットにアクセスできる場合は、次の手順を使用してサポートバンドルを作成および共有できます。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅にあるをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ Site admin] サイドバーで、[[Management Console]] をクリックします。
複数の [Management Console] ユーザーアカウントを作成している場合は、 [ルートサイト管理者] または [[Management Console] ユーザー] を選びます。 [Management Console] のユーザーアカウントの詳細については、「管理コンソールへのアクセスの管理」を参照してください。
[Management Console]の資格情報を入力します。 Continue をクリックします。
上部のナビゲーションバーで [サポート] をクリックします。

       **[サポート バンドルのダウンロード]** をクリックします。

サポートエンジニアからサポートバンドルのアップロードリンクを与えられている場合、このリンクを使います。それ以外の場合、 https://support.github.com/ にアクセスしたら、サポートを受ける資格があるエンタープライズアカウントにサインインします (メッセージが表示された場合)。
https://support.github.com/uploads を参照し、サポートバンドルをアップロードします。

SSHを使ったSupport Bundleの作成

          お使いの GitHub Enterprise Server インスタンスへの SSH アクセス権があり、送信インターネット アクセスがある場合は、次の手順を使用してサポート バンドルを作成および共有できます。

メモ

お使いの GitHub Enterprise Server インスタンスが geo レプリケーション構成内にあるかインスタンスがクラスターの場合、サポートバンドルを取得するには ghe-cluster-support-bundle コマンドを使う必要があります。詳しくは、「コマンドラインユーティリティ」をご覧ください。

SSH経由でSupport Bundleをダウンロードします。

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz

       `ghe-support-bundle` コマンドの詳細については、「[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-support-bundle)」を参照してください。

サポートエンジニアからサポートバンドルのアップロードリンクを与えられている場合、このリンクを使います。それ以外の場合、 https://support.github.com/ にアクセスしたら、サポートを受ける資格があるエンタープライズアカウントにサインインします (メッセージが表示された場合)。
https://support.github.com/uploads を参照し、サポートバンドルをアップロードします。

Enterprise アカウントを使用して Support Bundle をアップロードする

GitHub Enterprise Cloud に移動します。
GitHub の右上隅にあるプロフィール画像をクリックします。
環境に応じて、[ エンタープライズ] をクリックするか、[ エンタープライズ ] をクリックして、表示するエンタープライズをクリックします。
ページの左側にある Enterprise アカウントサイドバーで、[ Settings] をクリックします。
[ Settings] で、[License] をクリックします。
[GitHub Enterprise ヘルプ] で、[ サポートバンドルのアップロード] をクリックします。
[Enterprise アカウントの選択] で、ドロップダウンメニューを使用して、サポートバンドルに関連付けられているアカウントを選びます。
[ GitHub Enterprise サポートのサポートバンドルをアップロードする] で、サポートバンドルを選択するには、[ ファイルの選択] をクリックするか、サポートバンドルファイルを [ファイルの選択] にドラッグします。

       **アップロード**をクリックします。

SSHを使ったSupport Bundleの直接アップロード

以下の状況であれば、Support Bundleを当社のサーバに直接アップロードできます。 * お使いの GitHub Enterprise Server インスタンスへの SSH アクセス権があります。

TCP ポート 443 経由の送信 HTTPS 接続は、お使いの GitHub Enterprise Server インスタンスから enterprise-bundles.github.com および esbtoolsproduction.blob.core.windows.net に許可されます。

バンドルを当社のSupport Bundleサーバにアップロードします。
```
ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u'
```

サポートバンドルには、デフォルトでは、過去 2 日間のログが含まれていますが、''拡張'' サポートバンドルには過去 8 日間のログが含まれています。 GitHub のサポート調査中のイベントが 2 日以上前に発生した場合は、延長サポートバンドルの共有をお願いする場合があります。拡張バンドルをダウンロードするには SSH アクセスが必要です。 [Management Console]から拡張バンドルをダウンロードすることはできません。

バンドルが大きくなりすぎるのを避けるために、バンドルにはローテーションや圧縮されていないログだけが含まれます。 GitHub Enterprise Serverのログローテーションは、ログの大きさに応じて、さまざまなログファイルに対してさまざまな頻度 (毎日または毎週) に発生します。

SSHを使った拡張Support Bundleの作成

          お使いの GitHub Enterprise Server インスタンスへの SSH アクセス権があり、送信インターネット アクセスがある場合は、次の手順を使用して拡張サポート バンドルを作成して共有できます。

1. -x コマンドに ghe-support-bundle フラグを追加して、SSH 経由で拡張サポートバンドルをダウンロードします。

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz

サポートエンジニアからサポートバンドルのアップロードリンクを与えられている場合、このリンクを使います。それ以外の場合、 https://support.github.com/ にアクセスしたら、サポートを受ける資格があるエンタープライズアカウントにサインインします (メッセージが表示された場合)。
https://support.github.com/uploads を参照し、サポートバンドルをアップロードします。

SSHを使って拡張サポートバンドルを直接アップロード

TCP ポート 443 経由の送信 HTTPS 接続は、お使いの GitHub Enterprise Server インスタンスから enterprise-bundles.github.com および esbtoolsproduction.blob.core.windows.net に許可されます。

バンドルを当社のSupport Bundleサーバにアップロードします。
```
ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'
```

参考資料

        [AUTOTITLE](/support/learning-about-github-support/about-github-support)

        [AUTOTITLE](/enterprise-server@latest/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise)

この機能を使用できるユーザーについて

この記事で