GitHub Support へのデータ提供

Diagnosticファイルの作成と共有

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

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

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

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

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

1. From an administrative account on GitHub Enterprise Server, click in the upper-right corner of any page.
   
2. 左のサイドバーでManagement Consoleをクリックしてください。
   
3. 求められたなら、Management Consoleのパスワードを入力してください。
   
4. Management Consoleの右上でSupport（サポート）をクリックしてください。
   
5. Download diagnostics info（Diagnostic情報のダウンロード）をクリックしてください。

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

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

ghe-diagnostics コマンドラインユーティリティを使ってインスタンスの Diagnostics を取得してください。

$ ssh -p122 admin@hostname -- 'ghe-diagnostics' > diagnostics.txt

Support Bundleの作成と共有

サポートリクエストをサブミットした後、弊社のチームとの 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 の作成と共有」を参照してください。

Management ConsoleでのSupport Bundleの作成

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

1. From an administrative account on GitHub Enterprise Server, click in the upper-right corner of any page.
   
2. 左のサイドバーでManagement Consoleをクリックしてください。
   
3. 求められたなら、Management Consoleのパスワードを入力してください。
   
4. Management Consoleの右上でSupport（サポート）をクリックしてください。
   
5. [Download support bundle] (Support Bundle のダウンロード) をクリックします。
6. https://enterprise.github.com/support にアクセスし、サインインを求められた場合はサインインしてください。
7. https://enterprise.github.com/support/bundles/new にアクセスして Support Bundle をアップロードします。

SSHを使ったSupport Bundleの作成

You can use these steps to create and share a support bundle if you have SSH access to your GitHub Enterprise Server instance and have outbound internet access.

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

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

   ghe-support-bundle コマンドに関する詳しい情報については、「コマンドラインユーティリティ」を参照してください。
2. https://enterprise.github.com/support にアクセスし、サインインを求められた場合はサインインしてください。
3. https://enterprise.github.com/support/bundles/new にアクセスして Support Bundle をアップロードします。

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

1. GitHub.comに移動します。

2. In the top-right corner of GitHub.com, click your profile photo, then click Your enterprises.

   

3. In the list of enterprises, click the enterprise you want to view.

   

4. Enterpriseアカウントのサイドバーで、 Settings（設定）をクリックしてください。

   

5. 左のサイドバーで、 Enterprise licensing（Enterpriseライセンス）をクリックしてください。

   

6. [GitHub Enterprise Help] の下にある [Upload a support bundle] をクリックします。

   

7. [Select an enterprise account] で、ドロップダウンメニューから Support Bundle に関連付けられているアカウントを選択します。

   

8. [Upload a support bundle for GitHub Enterprise Support] で Support Bundle を選択するには、[Choose file] をクリックするか、Support Bundle ファイルを [Choose file] にドラッグします。

   

9. [Upload] をクリックします。

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

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

• You have SSH access to your GitHub Enterprise Server instance.
• Outbound HTTPS connections over TCP port 443 are allowed from your GitHub Enterprise Server instance.

1. バンドルを当社のSupport Bundleサーバにアップロードします。

   $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u'

拡張Support Bundleの作成と提供

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

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

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

You can use these steps to create and share an extended support bundle if you have SSH access to your GitHub Enterprise Server instance and you have outbound internet access.

1. ghe-support-bundleコマンドに-xフラグを追加して、SSH経由で拡張Support Bundleをダウンロードしてください。

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

2. https://enterprise.github.com/support にアクセスし、サインインを求められた場合はサインインしてください。
3. https://enterprise.github.com/support/bundles/new にアクセスして Support Bundle をアップロードします。

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

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

• You have SSH access to your GitHub Enterprise Server instance.
• Outbound HTTPS connections over TCP port 443 are allowed from your GitHub Enterprise Server instance.

1. バンドルを当社のSupport Bundleサーバにアップロードします。

   $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x'

参考リンク

• GitHub Enterprise Support について
• GitHub Enterprise ServerのGitHub Premium Supportについて