GitHub Support へのデータ提供

Diagnostics は GitHub Enterprise Server インスタンスの設定と環境の概要であり、以下の内容が含まれます:

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

インスタンスのDiagnosticsはManagement Consoleから、あるいはghe-diagnosticsコマンドラインユーティリティを実行することでダウンロードできます。

Management ConsoleでのDiagnosticsファイルの作成

SSHキーがすぐに利用できない場合、この方法が使えます。

GitHub Enterprise Serverの管理アカウントから、任意のページの右上にあるをクリックしてください。
左のサイドバーでManagement Consoleをクリックしてください。
求められたなら、Management Consoleのパスワードを入力してください。
Management Consoleの右上でSupport（サポート）をクリックしてください。
Download diagnostics info（Diagnostic情報のダウンロード）をクリックしてください。

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

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

ghe-diagnostics コマンドラインユーティリティを使ってインスタンスの 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：Collectdのログ
mail-logs/mail.log：SMTPのメール配送ログ
hookshot-logs/exceptions.log：webhookのデリバリエラー

詳細は「監査ログ」を参照してください。

Support Bundle には過去 2 日分のログが含まれます。過去 7 日分のログを取得したい場合には、拡張 Support Bundle をダウンロードできます。詳細は「拡張 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の右上でSupport（サポート）をクリックしてください。
[Download support bundle] (Support Bundle のダウンロード) をクリックします。
https://enterprise.github.com/support にアクセスし、サインインを求められた場合はサインインしてください。
https://enterprise.github.com/support/bundles/new にアクセスして Support Bundle をアップロードします。

SSHを使ったSupport Bundleの作成

GitHub Enterprise Serverのインスタンスへの SSH アクセスがあり、アウトバウンドインターネットアクセスがある場合は、これらのステップで拡張 Support Bundle を作成および共有できます。

ノート：Geo-replication設定もしくはGitHub Enterpriseクラスタリングを利用しているなら、Support Bundleを取得するにはghe-cluster-support-bundleコマンドを使わなければなりません。詳しい情報については「コマンドラインユーティリティ」を参照してください。

SSH経由でSupport Bundleをダウンロードします。
```
$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz
```
ghe-support-bundle コマンドに関する詳しい情報については、「コマンドラインユーティリティ」を参照してください。
https://enterprise.github.com/support にアクセスし、サインインを求められた場合はサインインしてください。
https://enterprise.github.com/support/bundles/new にアクセスして Support Bundle をアップロードします。

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

GitHub.comに移動します。
GitHub.comの右上で、自分のプロフィール写真をクリックし、続いてYour enterprises（自分のEnterprise）をクリックしてください。
Enterpriseのリストで、表示したいEnterpriseをクリックしてください。
Enterpriseアカウントのサイドバーで、 Settings（設定）をクリックしてください。
左のサイドバーで、 Enterprise licensing（Enterpriseライセンス）をクリックしてください。
[GitHub Enterprise Help] にある [Upload a support bundle] をクリックします。
[Select an enterprise account] で、ドロップダウンメニューから Support Bundle に関連付けられているアカウントを選択します。
[Upload a support bundle for GitHub Enterprise Support] で Support Bundle を選択するには、[Choose file] をクリックするか、Support Bundle ファイルを [Choose file] にドラッグします。
[Upload] をクリックします。

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

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

GitHub Enterprise Serverのインスタンスへの SSH アクセス権がある。
TCP ポート 443 を介したアウトバウンド HTTPS 接続が、GitHub Enterprise Serverのインスタンスから許可されている。

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

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

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

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