Next.js の分散トレーシング-jsチュートリアル-php.cn

Distributed Tracing in Next.js

最新のアプリケーションの分散化が進むにつれて、特にマイクロサービスやサーバーレスアーキテクチャの台頭により、これらのシステムの監視とデバッグはより複雑になっています。分散トレースは、開発者がさまざまなサービスを移動するリクエストを追跡するのに役立ち、パフォーマンスのボトルネック、エラー、遅延の問題を明確に把握できます。強力な React フレームワークである Next.js を使用する場合、分散トレーシングを実装すると、アプリの可観測性が向上し、より優れたパフォーマンス診断が可能になります。

この記事では、分散トレーシングの概念、それが Next.js にどのように適用されるか、そしてそれを実装するために実行できる手順について詳しく説明します。

分散トレーシングとは何ですか?

分散トレースは、特にリクエストが複数のサービスまたはコンポーネントにまたがる場合に、分散システムを通じてリクエストを追跡するために使用される方法です。従来のロギングやアプリケーションパフォーマンスモニタリング (APM) とは異なり、分散トレーシングは境界を越えてリクエストのフローをつなぎ合わせるため、遅延やエラーが発生した場所を簡単に特定できます。

分散トレーシングの主要な概念:

トレース: トレースは、分散システム内を移動するリクエストの過程を表します。複数のスパンで構成されています。
スパン: 各スパンは、API 呼び出し、データベースクエリ、コンポーネントのレンダリングなど、ジャーニー内の単一の操作を表します。スパンには、タグやイベントとともに、操作の開始時間と終了時間に関するメタデータが含まれます。
コンテキストの伝播: 分散トレースは、サービス境界を越えたトレースコンテキストの伝播に依存しており、システムのさまざまな部分が同じトレースに寄与できるようにします。

Next.js で分散トレーシングを使用する理由

Next.js はフルスタックフレームワークであり、外部サービスと対話できる API ルートとともに、サーバー側とクライアント側のレンダリングを組み合わせることができます。複数のコンポーネントとサービスを含む大規模なアプリケーションを構築する場合、パフォーマンスのボトルネックを特定し、システムの健全性を確保することが重要です。

分散トレースは Next.js 開発者に役立ちます:

API ルートのパフォーマンスを監視します: サーバー側ルートのパフォーマンスを理解し、遅いデータベースクエリや外部 API 呼び出しを特定し、ボトルネックを最適化します。
ユーザーエクスペリエンスの向上: サーバー側レンダリング (SSR)、静的サイト生成 (SSG)、クライアント側レンダリングのいずれを使用しても、さまざまな Next.js ページのレンダリングにかかる時間を監視します。
サービス間でのデバッグエラー: Next.js アプリが複数のマイクロサービスまたはサードパーティサービスと通信している場合、トレースはそれらのサービス間でのデータフローを追跡するのに役立ち、エラーや遅延の問題の原因を特定するのに役立ちます。

Next.js で分散トレーシングを実装する方法

Next.js で分散トレースを実装するには、分散トレースを収集するための基盤を提供する OpenTelemetry などのオープンソースライブラリや、より高度なトレース機能を提供する Datadog、New Relic などの独自のソリューションを利用できます。

ステップ 1: OpenTelemetry をセットアップする

OpenTelemetry は、トレースデータを収集およびエクスポートするためのツールを提供するオープンソース標準です。幅広いベンダーやクラウドプラットフォームでサポートされています。

OpenTelemetry パッケージをインストールします: まず、必要な OpenTelemetry パッケージをインストールします。 Node.js と HTTP フレームワークのコアパッケージと特定のパッケージが必要です。

   npm install @opentelemetry/api @opentelemetry/sdk-node @opentelemetry/instrumentation-http @opentelemetry/exporter-jaeger

ログイン後にコピー

このセットアップには以下が含まれます:

@opentelemetry/api: コアトレース API。
@opentelemetry/sdk-node: トレースをキャプチャする Node.js SDK。
@opentelemetry/instrumentation-http: HTTP 呼び出しのインストルメンテーション。
@opentelemetry/exporter-jaeger: オープンソースの分散トレーシングシステムであるJaeger へのエクスポーターの例。

トレース設定ファイルを作成します: Next.js プロジェクトで、tracing.js というファイルを作成して、OpenTelemetry を構成および初期化します。

   const { NodeTracerProvider } = require('@opentelemetry/sdk-node');
   const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
   const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
   const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');

   const provider = new NodeTracerProvider();

   // Configure exporter
   const exporter = new JaegerExporter({
     endpoint: 'http://localhost:14268/api/traces', // Jaeger endpoint
   });

   provider.addSpanProcessor(new SimpleSpanProcessor(exporter));

   // Register the provider globally
   provider.register();

   // Initialize HTTP instrumentation
   new HttpInstrumentation().setTracerProvider(provider);

ログイン後にコピー

API ルートをインストルメント化します: OpenTelemetry の API を使用して、Next.js API ルートにスパンを手動で作成できます。

   import { trace } from '@opentelemetry/api';

   export default async function handler(req, res) {
     const tracer = trace.getTracer('default');
     const span = tracer.startSpan('api-route-handler');

     try {
       // Simulate some async work
       await new Promise((resolve) => setTimeout(resolve, 100));
       res.status(200).json({ message: 'Hello from the API' });
     } catch (error) {
       span.recordException(error);
       res.status(500).json({ error: 'Internal Server Error' });
     } finally {
       span.end();
     }
   }

ログイン後にコピー

これにより、API ルートの実行を追跡するスパンが作成されます。エラーがある場合、スパンはその例外をキャプチャします。

クライアント側トレースをキャプチャする (オプション): クライアント側のトレース (ページのレンダリングまたはデータのロードにかかる時間を測定するなど) の場合、ブラウザーで同様の OpenTelemetry 構成をセットアップできます。また、トレースデータをバックエンドに送信するようにエクスポーターを構成することもできます。

ステップ 2: トレースベンダーを使用する

あるいは、Datadog、New Relic、AWS X-Ray などのサードパーティツールを使用することもできます。これらのツールは、より包括的なトレース機能を提供し、他のパフォーマンス監視ツールと統合します。

たとえば、Datadog を Next.js アプリケーションに統合するには:

Datadog パッケージをインストールします:

   npm install @opentelemetry/api @opentelemetry/sdk-node @opentelemetry/instrumentation-http @opentelemetry/exporter-jaeger

ログイン後にコピー

トレースを初期化します: dd-tracing.js ファイルを作成し、アプリケーションの Datadog トレースを構成します。

   const { NodeTracerProvider } = require('@opentelemetry/sdk-node');
   const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
   const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
   const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');

   const provider = new NodeTracerProvider();

   // Configure exporter
   const exporter = new JaegerExporter({
     endpoint: 'http://localhost:14268/api/traces', // Jaeger endpoint
   });

   provider.addSpanProcessor(new SimpleSpanProcessor(exporter));

   // Register the provider globally
   provider.register();

   // Initialize HTTP instrumentation
   new HttpInstrumentation().setTracerProvider(provider);

ログイン後にコピー

監視と分析: Datadog にトレースを送信した後、ダッシュボードを使用してリクエストパスを視覚化し、ボトルネックを特定し、システムを監視します。

ステップ 3: トレースを分析する

トレースシステムがセットアップされたら、Jaeger、Datadog、または任意のトレースバックエンドなどのツールを使用してトレースを表示および分析できます。これらのツールは各トレースのウォーターフォールビューを表示し、アプリケーション内でリクエストがどのように流れ、どこでパフォーマンスの問題が発生するかを理解するのに役立ちます。

結論

分散トレースは、最新のアプリケーション、特にクライアント側とサーバー側の両方のロジックを処理する Next.js のようなフレームワークで構築されたアプリケーションに不可欠な可視性を提供します。分散トレースを実装すると、アプリのパフォーマンスについて深い洞察が得られ、ボトルネックを効率的に診断して修正できるようになります。 OpenTelemetry などのオープンソースソリューションを選択する場合でも、Datadog などの商用ツールを選択する場合でも、分散トレーシングは Next.js アプリケーションが最適化され、信頼性が高く、スケーラブルであることを確認するのに役立ちます。

以上がNext.js の分散トレーシングの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。