Skip to main content
Skip to content

collectd から OpenTelemetry への移行

このガイドでは、GitHub Enterprise Server インスタンスを collectd から OpenTelemetry メトリック スタックへ移行する方法について説明します。

GitHub Enterprise Server は、collectd メトリクス スタックから OpenTelemetry に移行しています。 Collectd はバージョン 3.23 で廃止され、3.23 にアップグレードすると無効になります。

移行のタイムライン

Version新規インストールの既定値アップグレード時の動作Notes
3.18CollectdCollectdOpenTelemetry はオプトインです。
3.19 から 3.20 までOpenTelemetry既存のメトリック設定は保持されます。collectd を使用するインスタンスは、OpenTelemetry にオプトインできます。
3.21 から 3.22 までOpenTelemetry3.21 より前のバージョンからのアップグレードにより、OpenTelemetry が有効になり、collectd が無効になります。 3.21 以降からのアップグレードでは、既存のメトリック設定が保持されます。Collectd は引き続き再び有効にすることができます。
3.23 以降OpenTelemetryOpenTelemetry が有効で、collectd が無効になっています。Collectd は廃止され、再度有効にすることはできません。

移行の準備

移行する前に、次の準備を完了してください。

  • 運用環境で適用する前に、ステージング インスタンスで移行をテストします。
  • 外部ダッシュボードやアラートなど、collectd メトリックに依存する監視統合を特定します。
  • 移行期間中に両方のメトリック スタックを実行する予定の場合は、「 両方のメトリック スタックの実行」の注意事項を確認してください。

OpenTelemetry への移行

バージョン 3.18 から 3.22 を実行しているインスタンスでは、OpenTelemetry に手動で移行できます。 インスタンスで引き続き収集が使用されている場合は、監視のセットアップを事前に確認できるように、3.21 以降にアップグレードする前に移行することをお勧めします。

3.21 より前のバージョンから 3.21 または 3.22 にアップグレードすると、OpenTelemetry が自動的に有効になり、collectd が無効になりますが、アップグレード後に collectd を再度有効にすることができます。 3.23 以降にアップグレードすると、OpenTelemetry が有効になり、collectd が永続的に無効になります。

移行するには、OpenTelemetry メトリックを有効にし、collectd を無効にする必要があります。 どちらの設定も、[Management Console] またはコマンド ラインから利用できます。

[Management Console] の使用

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

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

  3. [ Site admin] サイドバーで、[[Management Console]] をクリックします。

  4. 監視設定で、[ OpenTelemetry を有効にする] を選択します。

  5. メトリック - Collectd で、Collectd メトリックを無効にする を選択します。

  6. [設定] サイドバーで [設定の保存] をクリックします。

    メモ

    [Management Console] で設定を保存すると、システム サービスが再起動され、ユーザーにわかるダウンタイムが発生する可能性があります。

  7. 設定の実行が完了するのを待ってください。

コマンド ラインの使用

  1. お使いの GitHub Enterprise Server インスタンスに SSH 接続します。 インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリ ノードに SSH 接続します。 クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。 詳しくは、「管理シェル (SSH) にアクセスする」をご覧ください。

    Shell
    ssh -p 122 admin@HOSTNAME
    
  2. OpenTelemetry メトリックを有効にし、collectd を無効にするには、次のコマンドを実行します。

    ghe-config observability.metrics.next-enabled true
    ghe-config observability.metrics.legacy-disabled true
    
  3. 構成を適用するには、次のコマンドを実行します。

    メモ

    構成の実行中に、お使いの GitHub Enterprise Server インスタンス 上のサービスが再起動する可能性があり、これによりユーザーに短時間のダウンタイムが発生する場合があります。

    Shell
    ghe-config-apply
    
  4. 設定の実行が完了するのを待ってください。

両方のメトリック スタックを実行

バージョン 3.18 から 3.22 では、collectd スタックと OpenTelemetry スタックを同時に実行することは可能ですが推奨されません。 この構成には、次の注意事項があります。

  • 一部のメトリック名は、collectd 形式との互換性を維持するために異なる場合があります。
  • 一部の OpenTelemetry メトリックにはラベルが含まれていません。
  • 両方のソリューションにメトリックを配信するため、リソース使用率が増加しました。

Collectd はバージョン 3.23 では廃止されているため、アップグレード後に両方のスタックを実行することはできません。

アップグレード後のチェック

構成の実行が完了したら、手動で移行した場合でも、アップグレードによってインスタンスが OpenTelemetry に切り替えられた場合でも:

collectd の履歴データの表示

パッチ 3.22.3、3.21.8、3.20.10、および 3.19.14 以降、監視 タブには履歴データを表示するための collectd ダッシュボードが含まれています。 これらのダッシュボードには、collectd スタックが無効にされた時点まで記録された collectd メトリックが表示されます。