GitHub Enterprise Supportはお客様の環境にアクセスできないので、追加情報が必要になります。

このガイドの内容は以下のとおりです。

Diagnosticファイルの作成と提供

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

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

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

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

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

  1. https://[hostname]/setup/diagnosticsにアクセスしてください。
  2. Download diagnostics をクリックしてください。

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の監査ログ
  • babeld-logs/babeld.log: Git proxyのログ
  • system-logs/haproxy.log: HAProxyのログ
  • elasticsearch-logs/github-enterprise.log: Elasticsearchのログ
  • configuration-logs/ghe-config.log: GitHub Enterpriseの設定ログ
  • collectd/logs/collectd.log: Collectdのログ
  • mail-logs/mail.log: SMTPのメール配信ログ
  • hookshot-logs/exceptions.log: Webhookの配信エラー

詳しい情報については監査ログを参照してください。

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

Tip:GitHub Enterprise Supportに連絡すると、チケットへのリンクを含む確認のメールが送られます。GitHub Enterprise SupportからSupport Bundleのアップロードを求められた際には、このチケットへのリンクをお使いください。

Management ConsoleでのSupport Bundleの作成

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

  1. 任意のページの右上から、次のアイコンをクリックしてください。 . Rocketship icon for accessing site admin settings

  2. 左のサイドバーからManagement Consoleをクリックしてください。 Management Console tab

  3. Management Consoleのパスワードを入力してください(求められた場合)。 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の作成

GitHub EnterpriseアプライアンスがSSHを利用でき、外部のインターネットにアクセスできる場合は、以下の手順でSupport Bundleを作成して提供できます。

Note: Geo-replication設定あるいは GitHub Enterpriseクラスタリングを使用しているなら、Support Bundleを取得する際にはghe-cluster-support-bundleコマンドを使ってください。詳しい情報については"Command-line utilities."を参照してください。

  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をアップロードしてください。

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

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

  • GitHub EnterpriseアプライアンスにSSHでアクセスできること。
  • GitHub Enterprise アプライアンスから外部のTCPポート443にHTTPS接続ができること。

  1. Support Bundleを当社のSupport Bundleサーバへアップロードします。
    ssh -p122 admin@hostname -- 'ghe-support-bundle -u'
    

拡張Support Bundleの作成と提供

通常のSupport Bundleには過去2日間のログが含まれますが、拡張 Support Bundleには過去7日分のログが含まれます。GitHub Enterprise Supportが調査している事象が2日前よりも以前に生じたものである場合、拡張Support Bundleの提供をお願いすることがあります。拡張Support BundleのダウンロードにはSSHでのアクセスが必要になります。Management Consoleからは拡張Support Bundleはダウンロードできません。

通常のSupport Bundleは、サイズが大きくなりすぎないように、ローテートと圧縮がされていないログだけが含まれています。GitHub Enterpriseにおけるログのローテーションは、様々なログにおいてそのサイズの想定に応じて様々な周期(日ごと、あるいは週ごと)で行われます。

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

GitHub EnterpriseアプライアンスにSSHでアクセスでき、外部のインターネットへアクセスできるのであれば、以下の手順で拡張Support Bundleを作成し、提供できます。

  1. -xフラグをghe-support-bundleコマンドに付けて、拡張Support BundleをSSH経由でダウンロードします。

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

  • GitHub EnterpriseアプライアンスにSSHでアクセスできること。
  • GitHub Enterprise アプライアンスから外部のTCPのポート443にHTTPS接続ができること。

  1. 拡張Support Bundleを当社のSupport Bundleサーバへアップロードします。
    ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x'