GitHub Support へのデータの提供

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

GitHub Support により、サニタイズされたログ ファイルの形式で追� のデータを提供するように求められる� �合があります。 提供を求められる� �合があるログ ファイルには 3 つの種類があります。

診断ファイルには GitHub Enterprise Server インスタンスの設定と環境についての情� �が含まれており、サポート バンドルには過去 2 日間の診断とログが含まれています。拡張サポート バンドルにも診断とログが含まれますが、それらは過去 7 日間のものです。

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

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

• 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

Diagnosticファイルの作成と共有

診断ファイルは GitHub Enterprise Server インスタンスの設定と環境の概要であり、以下のものが含まれます。

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

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

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

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

1. GitHub Enterprise Server の管理アカウントから、任意のページの右上隅の をクリックします。

   

2. [サイト管理者] ページにま� 表示されていない� �合は、左上隅の [サイト管理者] をクリックします。

   1. 左側のサイドバーで、 [Management Console] をクリックします。 1. 求められたなら、[Management Console]のパスワードを入力してく� さい。 4. [Management Console] の右上にある [サポート] をクリックします。

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

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

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

ghe-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: 収集されたログ
• mail-logs/mail.log: SMTP 電子メール配信ログ

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

Support Bundle には過去 2 日分のログが含まれます。 過去 7 日分のログを取得したい� �合には、拡張 Support Bundle をダウンロードできます。 詳細については、「拡張 Support Bundle の作成と提供」を参照してく� さい。

[Management Console]でのSupport Bundleの作成

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

1. GitHub Enterprise Server の管理アカウントから、任意のページの右上隅の をクリックします。

   

2. [サイト管理者] ページにま� 表示されていない� �合は、左上隅の [サイト管理者] をクリックします。

   1. 左側のサイドバーで、 [Management Console] をクリックします。 1. 求められたなら、[Management Console]のパスワードを入力してく� さい。 4. [Management Console] の右上にある [サポート] をクリックします。

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

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

SSHを使ったSupport Bundleの作成

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

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

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

   ghe-support-bundle コマンドの詳細については、「コマンドラインのユーティリティ」を参照してく� さい。
2. サポートエンジニアからサポートバンドルのアップロードリンクを与えられている� �合、このリンクを使います。 それ以外の� �合、 https://support.github.com/ にアクセスしたら、サポートを受ける資� �があるエンタープライズアカウントにサインインします (メッセージが表示された� �合)。 1. https://support.github.com/uploads を参照し、サポート バンドルをアップロードします。

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

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

2. GitHub.com の右上の自分のプロフィール写真をクリックし、 [自分のエンタープライズ] をクリックしてく� さい。

3. Enterpriseのリストで、表示したいEnterpriseをクリックしてく� さい。 1. エンタープライズ アカウントのサイドバーで、 [設定] をクリックします。

4. 左側のサイドバーで、 [エンタープライズ ライセンス] をクリックします。

5. [GitHub Enterprise ヘルプ] で、 [サポート バンドルのアップロード] をクリックします。

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

7. [GitHub Enterprise サポート のサポート バンドルをアップロードする] で、サポート バンドルを選択するには、 [ファイルの選択] をクリックするか、サポート バンドル ファイルを [ファイルの選択] にドラッグします。

8. [アップロード] をクリックします。

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

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

• への SSH アクセス権がある。
• から enterprise-bundles.github.com および esbtoolsproduction.blob.core.windows.net への TCP ポート 443 経由の送信 HTTPS 接続が許可されている。

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

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

拡張Support Bundleの作成と提供

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

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

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

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

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

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

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

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

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

• への SSH アクセス権がある。
• から enterprise-bundles.github.com および esbtoolsproduction.blob.core.windows.net への TCP ポート 443 経由の送信 HTTPS 接続が許可されている。

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

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

参考資料

• "GitHub サポートについて"
• "企業に関する正常性チェックの生成"