Veja informações sobre como configurar as origens de dados do OTEL (OpenTelemetry) (como bibliotecas de instrumentação e Coletor OpenTelemetry) para fazer upload de dados de monitoramento (métricas e rastreamentos) para o serviço Application Performance Monitoring.

const opentelemetry = require("@opentelemetry/sdk-node");
const {
 getNodeAutoInstrumentations,
} = require("@opentelemetry/auto-instrumentations-node");
const {
 OTLPTraceExporter,
} = require("@opentelemetry/exporter-trace-otlp-http");

  const sdk = new opentelemetry.NodeSDK({
traceExporter: new OTLPTraceExporter({
  url: "https://aaabbbb.example.us-phoenix-1.oci.oraclecloud.com/20200101/opentelemetry/private/v1/traces",
  headers: {"Authorization": "dataKey AAAAABBBBBCCCC"},
 }),

  instrumentations: [getNodeAutoInstrumentations()]
});

 sdk.start()
(base) [ssirajud@ssirajud node_with_opentelemetry]$

export OTEL_TRACES_EXPORTER=otlp
export OTEL_SERVICE_NAME=my-service
export OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_TRACES_HEADERS="authorization=dataKey 1111aaaabbbccc"
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://aaabbbb.example.us-phoenix-1.oci.oraclecloud.com/20200101/opentelemetry/private/v1/traces/
export OTEL_METRICS_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=https://aaabbbb.example.us-phoenix-1.oci.oraclecloud.com/20200101/opentelemetry/v1/metrics
export OTEL_EXPORTER_OTLP_METRICS_HEADERS="authorization=dataKey 1111aaaabbbccc"
export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf

receivers:
  otlp:
    protocols:
      http:

exporters:
  logging:
    verbosity: detailed
  otlphttp:
    endpoint: https://aaaaXXXX.apm-agt.us-ashburn-1.oci.oraclecloud.com/20200101/opentelemetry/private/v1/traces/
    headers:
      Authorization: "dataKey XXX"

processors:
  batch:

service:
  pipelines:
    metrics:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlphttp]
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlphttp]

Veja aqui as informações sobre as alterações que devem ser feitas no código de um aplicativo Java que utiliza o cliente Jaeger para rastreamento distribuído. Use-as para fazer upload de rastreamentos para o serviço Application Performance Monitoring.

Para usar o rastreador Jaeger para fazer upload de rastreamentos de um aplicativo Java para o serviço Application Performance Monitoring, configure o cliente Java Jaeger para compatibilidade com Zipkin (relatório no formato v2 Zipkin) e adicione o URL do coletor do serviço Application Performance Monitoring. Para isso, faça as seguintes alterações no código do seu serviço:

1. Junto com as dependências de cliente Jaeger necessárias, adicione as dependências a seguir ao arquivo pom.xml.

   <dependency>
       <groupId>io.zipkin.reporter2</groupId>
       <artifactId>zipkin-sender-urlconnection</artifactId>
       <version>2.15.0</version>
   </dependency>
   <dependency>
       <groupId>io.jaegertracing</groupId>
       <artifactId>jaeger-zipkin</artifactId>
       <version>1.3.2</version>
   </dependency>

2. Use o ZipkinV2Reporter para adaptar um relator Zipkin 2 à interface do relator Jaeger e converter intervalos Jaeger para o formato Zipkin v2 codificado em JSON. Certifique-se de ter especificado o URL do coletor do serviço Application Performance Monitoring para fazer upload de intervalos para o Application Performance Monitoring e o nome do seu serviço ou aplicativo.

   import io.jaegertracing.Configuration;
   import io.jaegertracing.zipkin.ZipkinV2Reporter;
   import zipkin2.reporter.AsyncReporter;
   import zipkin2.reporter.urlconnection.URLConnectionSender;
    
   /* .... */
    
   ZipkinV2Reporter reporter = new ZipkinV2Reporter(AsyncReporter.create(URLConnectionSender.create("<Application Performance Monitoring collector URL>")));
   JaegerTracer tracer = Configuration
       .fromEnv("<service-name>")
       .getTracerBuilder()
       .withReporter(reporter)
       .withSampler(new ConstSampler(true))
       .build();
    
   /* .... */

3. Registre B3TextMapCodec para usar a propagação B3, que é uma especificação para o cabeçalho b3. Esses cabeçalhos são usados para propagação do contexto de rastreamento entre os limites do serviço.

   import io.jaegertracing.Configuration;
   import io.jaegertracing.internal.propagation.B3TextMapCodec;
   import io.opentracing.propagation.Format;
    
   /* .... */
    
   B3TextMapCodec b3Codec = new B3TextMapCodec.Builder().build();       
   JaegerTracer tracer = Configuration
       .fromEnv("<service-name>")
       .getTracerBuilder()
       .registerInjector(Format.Builtin.HTTP_HEADERS, b3Codec)
       .registerExtractor(Format.Builtin.HTTP_HEADERS, b3Codec)
       .build();
    
   /* .... */

   Observe que se o rastreador Jaeger for criado usando a configuração de ambiente (Configuration.fromEnv()), definir a variável de ambiente JAEGER_PROPAGATION como b3c definirá o modo de propagação de contexto Zipkin (B3) sem alterações de código.

Veja aqui as informações sobre as alterações que devem ser feitas no código de um aplicativo Node.js que utiliza o cliente Zipkin para rastreamento distribuído. Use-as para fazer upload de rastreamentos para o serviço Application Performance Monitoring.

Para isso, faça as seguintes alterações no código de inicialização do rastreador Zipkin:

1. Certifique-se de ter feito as alterações necessárias nos intervalos de relatórios no formato Zipkin v2 codificado em JSON.

   Para obter informações sobre o formato Zipkin v2, consulte Zipkin 2.

2. Adicione o URL do coletor do serviço Application Performance Monitoring para fazer upload de intervalos para o Application Performance Monitoring e o nome do seu serviço ou aplicativo.
3. Desative o recurso "junção de intervalos" do Zipkin, se ele estiver ativado. A especificação OpenTracing não permite o compartilhamento de ID do Intervalo entre diferentes intervalos dentro do mesmo rastreamento e esse recurso deve ser desativado.

Node.js Exemplo

Veja a seguir um exemplo do código de inicialização do rastreador Zipkin e as alterações detalhadas no procedimento estão em bold:

const {
  Tracer,
  BatchRecorder,
  jsonEncoder: {JSON_V2}
} = require('zipkin');
 
const CLSContext = require('zipkin-context-cls');
const {HttpLogger} = require('zipkin-transport-http');
 
// Setup the tracer
const tracer = new Tracer({
  ctxImpl: new CLSContext('zipkin'), // implicit in-process context
  recorder: new BatchRecorder({
    logger: new HttpLogger({
      endpoint: '<Application Performance Monitoring collector URL>', //Span collection endpoint URL setting
      jsonEncoder: JSON_V2 //Span format and encoding setting
    })
  }), // batched http recorder
  localServiceName: '<service-name>', // name of the application/service
  supportsJoin: false //Span join disable setting
});

O URL do coletor do serviço Application Performance Monitoring é necessário ao configurar rastreadores de código-fonte aberto para se comunicar com o serviço Application Performance Monitoring. Este tópico fornece detalhes sobre o formato do URL do Coletor do APM.

O URL do coletor do serviço Application Performance Monitoring tem o seguinte formato:

<dataUploadEndpoint>/<API version>/observations/<observationType>?dataFormat=<dataFormat>&dataFormatVersion=<dataFormatVersion>&dataKey=<dataKey>

Obtenha o valor <dataUploadEndpoint> na página de detalhes do domínio do APM.

https://aaaabbbb.example.us-ashburn-1.oci.oraclecloud.com/20200101/observations/public-span?dataFormat=zipkin&dataFormatVersion=2&dataKey=11115Q7IGN

spring.zipkin.baseUrl =  https://aaaabbbb.example.us-ashburn-1.oci.oraclecloud.com
spring.zipkin.apiPath = /20200101/observations/public-span?dataFormat=zipkin&dataFormatVersion=2&dataKey=11115Q7IGN

https://aaaabbbb.example.us-phoenix-1.oci.oraclecloud.com/20200101/observations/private-span?dataFormat=otlp-span&dataFormatVersion=1&dataKey=11112222UZ5

Configure a propagação de contexto para que as informações de contexto de rastreamento sejam propagadas no formato apropriado e adicione-as a um ou mais cabeçalhos de solicitação HTTP. O contexto de rastreamento permite a correlação de intervalos provenientes de diferentes microservices, mas que pertencem à mesma transação (rastreamento) e são identificados por um ID de Rastreamento comum.

Agente/Rastreador do APM

O Agente/Rastreador Java do APM pode ser configurado para funcionar com outros rastreadores OpenTracing (como Jaeger e Zipkin) para formar um rastreamento completo.

Quando ocorrer uma chamada HTTP, o Agente/Rastreador Java do APM tentará adicionar cabeçalhos HTTP à chamada que poderá ser lida na outra extremidade para ajudar a conectar os intervalos.

Você pode alterar esse formato usando a propriedade com.oracle.apm.agent.tracer.propagation.type do arquivo AgentConfig.properties localizado no diretório oracle-apm-agent\config.

Você pode utilizar os seguintes tipos de propagação definindo a propriedade com o nome:

Defina o tipo de propagação apropriado para que seus diversos rastreadores possam trabalhar juntos para formar um rastreamento completo.

OpenTelemetry, Zipkin e Jaeger