Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となります: 2022-09-28. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

GitHub Support へのデータの提供

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] をクリックします。 左側のサイドバーの [[Management Console]] タブ 1. 求められたなら、[Management Console]のパスワードを入力してください。 [Management Console] ロック解除画面 4. [Management Console] の右上にある [サポート] をクリックします。 [Support](サポート) 領域にアクセスするボタン

  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 の作成と提供」を参照してください。

ヒント: 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] をクリックします。 左側のサイドバーの [[Management Console]] タブ 1. 求められたなら、[Management Console]のパスワードを入力してください。 [Management Console] ロック解除画面 4. [Management Console] の右上にある [サポート] をクリックします。 [Support](サポート) 領域にアクセスするボタン

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

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

SSHを使ったSupport Bundleの作成

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

注: geo レプリケーション構成または GitHub Enterprise クラスタリングを使用している場合は、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. エンタープライズ アカウントのサイドバーで、 [設定] をクリックします。 エンタープライズ アカウントのサイドバー内の [設定] タブ

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

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

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

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

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

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

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

  • your GitHub Enterprise Server instance への SSH アクセス権がある。
  • your GitHub Enterprise Server instance から 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の作成

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

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

参考資料