Integração do OpenTelemetry com o Instana para aplicativos do PHP

Você pode ativar a instrumentação automática definindo variáveis de ambiente, o que permite que o ` OpenTelemetry ` rastreie automaticamente as bibliotecas ` PHP ` compatíveis.

Para referência, consulte este aplicativo de demonstração em WordPressPHP, que apresenta a instrumentação sem código em OpenTelemetryPHP e a integração em OpenTelemetry com Instana.

Você pode ativar a instrumentação automática definindo as seguintes variáveis de ambiente mínimas:

Exemplo

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

Com essas configurações definidas, você pode iniciar um aplicativo PHP e os rastros OpenTelemetry gerados por ele ficarão visíveis na interface do usuário Instana.

Você também pode configurar aplicativos do PHP para enviar rastreamentos do OpenTelemetry diretamente para o agente ou backend do Instana usando pontos de extremidade do OTLP.

Você precisa integrar manualmente o SDK do OpenTelemetry às suas aplicações nos seguintes casos:

• Você não está utilizando a instrumentação da biblioteca PHP compatível com OTel ou Instana.
• Você deseja ampliar as funcionalidades da biblioteca Tracer do PHP.
• Você precisa de um controle mais preciso sobre a instrumentação de suas aplicações.

Para configurar a instrumentação manual, siga estas etapas:

1. Instale o pacote " OpenTelemetry " API e os pacotes SDK.

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

2. Adicione a instrumentação manual OpenTelemetry desejada ao seu código PHP, seguindo a documentação sobre instrumentação manual disponível em OpenTelemetry PHP.

3. Escolha um propagador de contexto de rastreament OpenTelemetry e para aplicações distribuídas. Instana suporta cabeçalhos de rastreamento W3C e cabeçalhos nativos Instana para a propagação do rastreamento.

   • Usando um propagador de tipo ` Instana `

     OTEL_PROPAGATORS=instana
     

   • Usando tracecontext o propagador

     OTEL_PROPAGATORS=tracecontext
     

   O uso de propagadores permite que Instana junte intervalos de OpenTelemetry e outros intervalos de Instana em um único rastreamento da sua aplicação.

   Para obter mais informações sobre exemplos de instrumentação para rastreamento distribuído, consulte Ativando a propagação de contexto para rastreamento distribuído.

O exemplo simples a seguir demonstra a instrumentação manual com um span pai e um span filho:

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

O propagador ` OpenTelemetry ` para ` Instana ` fornece propagação de cabeçalhos ` HTTP ` e propagação de bagagem para uso com o aplicativo ` PHP `. Este propagador converte os cabeçalhos de correlação de rastreamento (X-INSTANA-T/X-INSTANA-S/X-INSTANA-L) Instana em cabeçalhos OpenTelemetrySpanContext e OpenTelemetrySpanContext em Instana.

Você pode encontrar aqui um exemplo simples de aplicativo distribuído do tipo “ PHP ”, que demonstra a instrumentação manual utilizando o propagador de contexto Instana.