PHP アプリケーション向けに OpenTelemetry と Instana を統合する

環境変数を設定することで自動インスツルメンテーションを有効にでき、これにより OpenTelemetry がサポートされている PHP ライブラリを自動的にトレースできるようになります。

参考までに、 こちらのデモアプリケーションをご覧ください： WordPress PHP。このアプリケーションでは、 OpenTelemetry PHP のノーコード・インストルメンテーション機能と、 OpenTelemetry と Instana の連携機能を紹介しています。

以下の最低限の環境変数を設定することで、自動インスツルメンテーションを有効にできます：

例

OTEL_PHP_AUTOLOAD_ENABLED=true
OTEL_SERVICE_NAME=wordpress_otel_instrumentation
OTEL_TRACES_EXPORTER=otlp
OTEL_EXPORTER_OTLP_PROTOCOL=grpc
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
OTEL_PROPAGATORS=instana,tracecontext

これらの設定が完了すると、 PHP アプリケーションを起動でき、そこから生成される OpenTelemetry のトレースが Instana のUIに表示されます。

また、 PHP アプリケーションを設定し、 OTLP エンドポイントを使用して、 OpenTelemetry のトレースを Instana エージェントまたはバックエンドに直接送信することも可能です。

以下の場合は、 OpenTelemetry SDK を使用してアプリケーションに手動で計測機能を組み込む必要があります：

• OTel または Instana でサポートされている PHP ライブラリのインストルメンテーションを使用していません。
• PHP のTracerライブラリの機能を拡張したいと考えています。
• アプリケーションへの計測機能の導入について、よりきめ細かな制御が必要です。

手動による計測設定を行うには、以下の手順を実行してください：

1. OpenTelemetry、 API、およびSDKパッケージをインストールします。

   composer require open-telemetry/sdk
   composer require open-telemetry/api
   

2. OpenTelemetry PHP 手動計測に関するドキュメントに従って、必要な手動 OpenTelemetry 計測を PHP コードに追加してください。

3. 分散アプリケーションには、 OpenTelemetry トレースコンテキストプロパゲーターを選択してください。 Instana トレースの伝播において、 W3C のトレースヘッダーおよび Instana のネイティブヘッダーをサポートしています。

   • Instana プロパゲーターの使用

     OTEL_PROPAGATORS=instana
     

   • プロパゲーター tracecontext の使用

     OTEL_PROPAGATORS=tracecontext
     

   プロパゲーターを使用することで、 Instana は、 OpenTelemetry のスパンやその他の Instana のスパンを、アプリケーションの単一のトレースに統合することができます。

   分散トレーシングの計測例に関する詳細については、 「分散トレーシングでのコンテキスト伝播の有効化」 を参照してください。

次の簡単な例は、親スパンと子スパンを用いた手動によるインストルメンテーションを示しています：

use OpenTelemetry\SDK\Registry;
use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
use OpenTelemetry\SDK\Trace\TracerProvider;
use OpenTelemetry\API\Trace\SpanKind;

$tracerProvider = new TracerProvider(
   new SimpleSpanProcessor(
      Registry::spanExporterFactory("otlp")->create()
      )
    );
$tracer = $tracerProvider->getTracer('test');
$rootSpan = $tracer->spanBuilder('rootSpan')->startSpan();
$scope = $rootSpan->activate();

// Do some work
sleep(1);
// Create a child span (automatically becomes a child of the active span)
$childSpan = $tracer->spanBuilder('child-operation')
    ->startSpan();
$childScope = $childSpan->activate();
$childSpan->end();
$childScope->detach();

// Do more work
sleep(1);

// Add string attribute
$rootSpan->setAttribute('string.attribute', 'value');
$scope->detach();
$rootSpan->end();
$tracerProvider->shutdown();

「 OpenTelemetry 」 の「 Instana 」用プロパゲーターは、「 HTTP 」ヘッダーのプロパゲーションとバゲッジのプロパゲーションを提供し、「 PHP 」アプリケーションで使用されます。 このプロパゲーターは、 Instana のトレース相関ヘッダーを (X-INSTANA-T/X-INSTANA-S/X-INSTANA-L)OpenTelemetry に変換し、 OpenTelemetrySpanContextSpanContext を Instana ヘッダーに変換します。

ここでは、 Instana コンテキストプロパゲータを使用した手動による計測を実演する、シンプルな分散型 PHP アプリケーションのサンプルをご覧いただけます。