Skip to main content
ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

GitHub Support へのデータ提供

Since GitHub Support doesn't have access to your environment, we sometimes require some additional information from you.

About diagnostic files and support bundles

GitHub Support may ask you to provide additional data in the form of sanitized log files. There are three types of log file you may be asked to provide.

Diagnostic files contain information about a GitHub Enterprise Server instance's settings and environment, support bundles contain diagnostics and logs from the past two days, and extended support bundles also contain diagnostics and logs but from the past seven days.

About log file sanitization

Authentication tokens, keys, and secrets are removed from log files in the following log directories contained within a support bundle or diagnostics file:

  • 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ファイルの作成と共有

Diagnostic files are an overview of a GitHub Enterprise Server instance's settings and environment that contains:

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

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

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

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

  1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

    Screenshot of the rocket ship icon for accessing site admin settings

  2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

    Screenshot of "Site admin" link

  3. 左のサイドバーでManagement Consoleをクリックしてください。 左のサイドバーのManagement Consoleタブ

  4. 求められたなら、Management Consoleのパスワードを入力してください。 Management Consoleのロック解除画面

  5. Management Consoleの右上でSupport(サポート)をクリックしてください。 サポートエリアへのアクセスボタン

  6. 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のメール配送ログ

For more information, see "About the audit log for your enterprise."

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 を作成して共有できます。

  1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

    Screenshot of the rocket ship icon for accessing site admin settings

  2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

    Screenshot of "Site admin" link

  3. 左のサイドバーでManagement Consoleをクリックしてください。 左のサイドバーのManagement Consoleタブ

  4. 求められたなら、Management Consoleのパスワードを入力してください。 Management Consoleのロック解除画面

  5. Management Consoleの右上でSupport(サポート)をクリックしてください。 サポートエリアへのアクセスボタン

  6. [Download support bundle] (Support Bundle のダウンロード) をクリックします。

  7. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support.

  8. https://support.github.com/uploads にアクセスして Support Bundle をアップロードします。

SSHを使ったSupport Bundleの作成

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

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

  1. SSH経由でSupport Bundleをダウンロードします。
    $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz
    ghe-support-bundle コマンドに関する詳しい情報については、「コマンドラインユーティリティ」を参照してください。
  2. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support.
  3. https://support.github.com/uploads にアクセスして Support Bundle をアップロードします。

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

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

  2. GitHub.comの右上で、自分のプロフィール写真をクリックし、続いてYour enterprises(自分のEnterprise)をクリックしてください。 GitHub Enterprise Serverのプロフィール写真のドロップダウンメニュー内の"Your enterprises"

  3. Enterpriseのリストで、表示したいEnterpriseをクリックしてください。 Enterpriseのリスト中のEnterpriseの名前

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

  5. 左のサイドバーで、 Enterprise licensing(Enterpriseライセンス)をクリックしてください。 Screenshot showing "Enterprise licensing" link in the enterprise account settings sidebar.

  6. [GitHub Enterprise Help] にある [Upload a support bundle] をクリックします。 Screenshot showing "Upload a support bundle link".

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

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

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

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

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

  • GitHub Enterprise Serverインスタンス への SSH アクセス権がある。
  • Outbound HTTPS connections over TCP port 443 are allowed from GitHub Enterprise Serverインスタンス to enterprise-bundles.github.com and esbtoolsproduction.blob.core.windows.net.
  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アクセスが必要です。拡張Support BundleをManagement Consoleからダウンロードすることはできません。

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

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

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

  1. ghe-support-bundleコマンドに-xフラグを追加して、SSH経由で拡張Support Bundleをダウンロードしてください。
    $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz
  2. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support.
  3. https://support.github.com/uploads にアクセスして Support Bundle をアップロードします。

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

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

  • GitHub Enterprise Serverインスタンス への SSH アクセス権がある。
  • Outbound HTTPS connections over TCP port 443 are allowed from GitHub Enterprise Serverインスタンス to enterprise-bundles.github.com and esbtoolsproduction.blob.core.windows.net.
  1. バンドルを当社のSupport Bundleサーバにアップロードします。
    $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x'

参考リンク