GitHub Support へのデータの提供

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

環境内の GitHub Enterprise Server インスタンスに関する問題のトラブルシューティングに役立るために、GitHub Support から 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]でのDiagnosticsファイルの作成

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

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

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

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

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/ghe-config.log: GitHub Enterprise Server 構成ログ
collectd/logs/collectd.log: 収集されたログ
mail-logs/mail.log: SMTP 電子メール配信ログ

詳しくは、「企業の監査ログについて」を参照してください。

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

ヒント: GitHub Support に連絡すると、チケットの参照リンクを含む確認メールが送られてきます。 GitHub Support が Support Bundle のアップロードをお願いした場合、Support Bundle のアップロードにこのチケット参照リンクを利用できます。

[Management Console]でのSupport Bundleの作成

Web べースの [Management Console] と外部のインターネットにアクセスできる環境があれば、以下の手順で Support Bundle を作成して共有できます。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ サイト管理者] サイドバーで [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 コマンドについて詳しくは、「コマンドラインユーティリティ」をご覧ください。
サポートエンジニアからサポートバンドルのアップロードリンクを与えられている場合、このリンクを使います。それ以外の場合、 https://support.github.com/ にアクセスしたら、サポートを受ける資格があるエンタープライズアカウントにサインインします (メッセージが表示された場合)。
https://support.github.com/uploads を参照し、サポートバンドルをアップロードします。

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

GitHub Enterprise Cloud に移動します。
GitHub の右上の自分のプロフィール写真をクリックし、[自分の Enterprise] をクリックします。
Enterpriseのリストで、表示したいEnterpriseをクリックしてください。
ページの左側にある Enterprise アカウントのサイドバーで、 [設定] をクリックします。
[設定] で、** ライセンス ** をクリックします。
[GitHub Enterprise ヘルプ] で、 [サポートバンドルのアップロード] をクリックします。
[Enterprise アカウントの選択] で、ドロップダウンメニューを使用して、サポートバンドルに関連付けられているアカウントを選びます。
[GitHub Enterprise サポートのサポートバンドルをアップロードする] で、サポートバンドルを選択するには、 [ファイルの選択] をクリックするか、サポートバンドルファイルを [ファイルの選択] にドラッグします。
[アップロード] をクリックします。

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

以下の状況であれば、Support Bundleを当社のサーバに直接アップロードできます。

お使いの GitHub Enterprise Server インスタンスに SSH でアクセスできます。
お使いの GitHub Enterprise Server インスタンスから enterprise-bundles.github.com および esbtoolsproduction.blob.core.windows.net への TCP ポート 443 経由のアウトバウンド HTTPS 接続が許可されています。

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

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

バンドルが大きくなりすぎるのを避けるために、バンドルにはローテーションや圧縮されていないログだけが含まれます。 GitHub Enterprise Server でのログのローテーションは、それぞれのログがどの程度の大きさになるかの予想に応じて、ログごとに様々な頻度 (日次あるいは週次) で行われます。

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

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

ghe-support-bundle コマンドに -x フラグを追加して、SSH 経由で拡張サポートバンドルをダウンロードします。
```
ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz
```
サポートエンジニアからサポートバンドルのアップロードリンクを与えられている場合、このリンクを使います。それ以外の場合、 https://support.github.com/ にアクセスしたら、サポートを受ける資格があるエンタープライズアカウントにサインインします (メッセージが表示された場合)。
https://support.github.com/uploads を参照し、サポートバンドルをアップロードします。

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