Di seguito sono riportate informazioni sulla configurazione delle origini dati OpenTelemetry (OTEL) (come le librerie di strumentazione e il Collector OpenTelemetry) per caricare i dati di monitoraggio (metriche e trace) in 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]

Di seguito sono riportate informazioni sulle modifiche da apportare al codice di un'applicazione Java che utilizza il client Jaeger per il trace distribuito e utilizzarlo per caricare i trace in Application Performance Monitoring.

Per utilizzare il Tracer Jaeger per caricare i trace da un'applicazione Java in Application Performance Monitoring, è necessario configurare il client Java Jaeger per la compatibilità Zipkin (report in formato v2 Zipkin) e aggiungere l'URL del Collector di Application Performance Monitoring. A tale scopo, è necessario apportare le seguenti modifiche al codice del servizio:

1. Insieme alle dipendenze del client Jaeger richieste, aggiungere le seguenti dipendenze al file 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. Utilizzare ZipkinV2Reporter per adattare un reporter Zipkin 2 all'interfaccia di Jaeger Reporter e convertire gli intervalli Jaeger nel formato Zipkin v2 con codifica JSON. Assicurarsi di aver specificato l'URL del Collector di Application Performance Monitoring per caricare gli intervalli in Application Performance Monitoring e il nome del servizio o dell'applicazione.

   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. Registrare B3TextMapCodec per utilizzare la propagazione B3, che è una specifica per l'intestazione b3. Queste intestazioni vengono utilizzate per la propagazione del contesto di trace oltre i confini del servizio.

   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();
    
   /* .... */

   Tenere presente che se il tracciatore Jaeger viene creato utilizzando la configurazione dell'ambiente (Configuration.fromEnv()), l'impostazione della variabile di ambiente JAEGER_PROPAGATION su b3c imposta la modalità di propagazione del contesto Zipkin (B3) senza modifiche al codice.

Di seguito sono riportate informazioni sulle modifiche da apportare al codice di un'applicazione Node.js che utilizza il client Zipkin per il trace distribuito e utilizzarlo per caricare i trace in Application Performance Monitoring.

A tale scopo, apportare le seguenti modifiche al codice di inizializzazione del tracciante Zipkin:

1. Assicurarsi di aver apportato le modifiche necessarie agli intervalli di report nel formato v2 Zipkin con codifica JSON.

   Per informazioni sul formato v2 Zipkin, vedere Zipkin 2.

2. Aggiungere l'URL del Collector di Application Performance Monitoring per caricare gli intervalli in Application Performance Monitoring e il nome del servizio o dell'applicazione.
3. Disabilitare la funzione Zipkin "span join", se abilitata. La specifica OpenTracing non consente la condivisione dell'ID intervallo tra intervalli diversi all'interno dello stesso trace e questa funzione deve essere disabilitata.

Node.js Esempio

Di seguito è riportato un esempio del codice di inizializzazione del tracciante Zipkin e le modifiche dettagliate nella procedura sono disponibili in 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
});

L'URL del Collector di Application Performance Monitoring è obbligatorio quando si configurano i trace open source per comunicare con il servizio Application Performance Monitoring. Questo argomento fornisce dettagli sul formato dell'URL del Collector APM.

L'URL del Collector di Application Performance Monitoring ha il formato seguente:

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

Ottenere il valore <dataUploadEndpoint> dalla pagina dei dettagli del dominio 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

Configurare la propagazione del contesto per propagare le informazioni del contesto di trace nel formato appropriato e aggiungerle a una o più intestazioni di richiesta HTTP. Il contesto di traccia consente la correlazione degli intervalli provenienti da microservizi diversi, ma appartenenti alla stessa transazione (traccia) e identificati da un ID traccia comune.

Agente/tracer APM

L'agente/tracer APM Java può essere configurato per funzionare con altri traccianti OpenTracing (come Jaeger e Zipkin) al fine di formare un trace completo.

Quando si verifica una chiamata HTTP, APM Java Agent/Tracer tenterà di aggiungere intestazioni HTTP alla chiamata che potranno essere lette dall'altra parte per facilitare la connessione degli intervalli.

Per modificare questo formato, utilizzare la proprietà com.oracle.apm.agent.tracer.propagation.type del file AgentConfig.properties situato nella directory oracle-apm-agent\config.

È possibile utilizzare i seguenti tipi di propagazione impostando la proprietà sul nome:

Impostare il tipo di propagazione appropriato per consentire ai vari traccianti di lavorare insieme per formare una traccia completa.

OpenTelemetry, Zipkin e Jaeger