Intégration d' OpenTelemetry. avec Instana. pour les applications PHP

Vous pouvez activer l'instrumentation automatique en définissant des variables d'environnement, ce qui permet à OpenTelemetry de tracer automatiquement les bibliothèques PHP prises en charge.

À titre de référence, consultez cette application de démonstration disponible à l'adresse WordPress PHP, qui présente l'instrumentation sans code de OpenTelemetry PHP et l'intégration de OpenTelemetry avec Instana.

Vous pouvez activer l'instrumentation automatique en définissant les variables d'environnement minimales suivantes :

Exemple

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

Une fois ces configurations mises en place, vous pouvez lancer une application PHP; les traces OpenTelemetry générées par celle-ci seront alors visibles dans l'interface utilisateur de Instana.

Vous pouvez également configurer les applications PHP pour qu'elles envoient les traces d' OpenTelemetry s directement à l'agent Instana ou au backend en utilisant les points de terminaison OTLP.

Vous devez intégrer manuellement le SDK d' OpenTelemetry s à vos applications dans les cas suivants :

• Vous n'utilisez pas l'instrumentation de la bibliothèque PHP prise en charge par OTel ou Instana.
• Vous souhaitez étendre les fonctionnalités de la bibliothèque Tracer d' PHP.
• Vous avez besoin d'un contrôle plus précis sur l'instrumentation de vos applications.

Pour configurer l'instrumentation manuelle, procédez comme suit :

1. Installez l' OpenTelemetry, API et les paquets SDK.

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

2. Ajoutez l'instrumentation manuelle OpenTelemetry de votre choix à votre code PHP en suivant les instructions fournies dans la documentation sur l'instrumentation manuelle disponible à l'adresse OpenTelemetryPHP.

3. Choisissez le propagateur de contexte de traçage d' OpenTelemetry s pour les applications distribuées. Instana prend en charge les en-têtes de trace W3C et les en-têtes natifs Instana pour la propagation des traces.

   • Utilisation d'un propagateur « Instana »

     OTEL_PROPAGATORS=instana
     

   • Utilisation tracecontext du propagateur

     OTEL_PROPAGATORS=tracecontext
     

   L'utilisation de propagateurs permet à Instana de regrouper les segments OpenTelemetry et les segments Instana en une seule trace de votre application.

   Pour plus d'informations sur les exemples d'instrumentation pour le traçage distribué, consultez la section « Activation de la propagation du contexte pour le traçage distribué ».

L'exemple simple suivant illustre l'instrumentation manuelle à l'aide d'un span parent et d'un span enfant :

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();

Le propagateur « OpenTelemetry » pour « Instana » permet la propagation des en-têtes et des données de bagages d' HTTP, à utiliser avec l'application « PHP ». Ce propagateur convertit les en-têtes de corrélation de trace Instana(X-INSTANA-T/X-INSTANA-S/X-INSTANA-L) en en-têtes OpenTelemetrySpanContext et OpenTelemetrySpanContext en en-têtes Instana.

Vous trouverez ici un exemple simple d'application d' PHP s distribuées illustrant l'instrumentation manuelle à l'aide du propagateur de contexte Instana.