Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。

GitHub Support へのデータの提供

GitHub Support は顧客の環境にはアクセスできないので、追加情報の提供をお願いする場合があります。

この機能を使用できるユーザー

Site administrators and enterprise owners can provide data to 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

Diagnosticファイルの作成と共有

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

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

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

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

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

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

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

  3. 求められたなら、[Management Console]のパスワードを入力してください。 1. 上部のナビゲーション バーで [サポート] をクリックします。

    [Management Console] のヘッダーのスクリーンショット。 [サポート] というラベルが付いたタブがオレンジ色の枠線で強調表示されています。

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

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 日分のログが含まれています。 正確な期間を時間単位または日単位で指定できます。 過去 8 日分のログを提供するには、延長サポート バンドルをダウンロードするとよいでしょう。 詳細については、「拡張 Support Bundle の作成と提供」を参照してください。

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

[Management Console]でのSupport Bundleの作成

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

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

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

  3. 求められたなら、[Management Console]のパスワードを入力してください。 1. 上部のナビゲーション バーで [サポート] をクリックします。

    [Management Console] のヘッダーのスクリーンショット。 [サポート] というラベルが付いたタブがオレンジ色の枠線で強調表示されています。

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

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

SSHを使ったSupport Bundleの作成

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

注: お使いの GitHub Enterprise Server インスタンス が geo レプリケーション構成内にあるかインスタンスがクラスターの場合、サポートバンドルを取得するには ghe-cluster-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 の右上の自分のプロフィール写真をクリックし、 [自分のエンタープライズ] をクリックしてください。 GitHub Enterprise Server のプロファイル写真のドロップダウン メニューの [自分の Enterprise]

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

  4. 左側のサイドバーで、 [エンタープライズ ライセンス] をクリックします。 エンタープライズ アカウント設定サイドバーの [エンタープライズ ライセンス] リンクを示すスクリーンショット。

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

  6. [Select an enterprise account] で、ドロップダウンメニューから Support Bundle に関連付けられているアカウントを選択します。 サポート バンドルのエンタープライズ アカウントを選択するためのドロップダウン メニューを示すスクリーンショット。

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

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

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

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

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

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

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

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

  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を当社のサーバに直接アップロードできます。

  • お使いの GitHub Enterprise Server インスタンス に SSH でアクセスできます。
  • お使いの GitHub Enterprise Server インスタンス から enterprise-bundles.github.com および esbtoolsproduction.blob.core.windows.net への TCP ポート 443 経由のアウトバウンド HTTPS 接続が許可されています。
  1. バンドルを当社のSupport Bundleサーバにアップロードします。
    $ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'

参考資料