Application Real-Time Monitoring Service:Adicionar instrumentação personalizada com OpenTelemetry para Java

<dependencies>
    <dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-api</artifactId>
    </dependency>
    <dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-sdk-trace</artifactId>
    </dependency>
    <dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-sdk</artifactId>
    </dependency>
</dependencies>
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>io.opentelemetry</groupId>
      <artifactId>opentelemetry-bom</artifactId>
      <version>1.23.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Conceitos principais

Esta seção descreve apenas termos comuns. Para mais informações sobre outros termos, consulte a Especificação do OpenTelemetry.

• span: uma operação específica em uma requisição, como um ponto de entrada de chamada remota ou uma chamada de método interno.

• SpanContext: o contexto de um rastreamento, incluindo informações como o id do rastreamento e o id do span.

• atributo: um campo adicional em um span que registra informações-chave.

• Baggage: pares chave-valor propagados por todo o rastreamento.

Usar o sdk do OpenTelemetry para Java

Use o sdk do OpenTelemetry para realizar as seguintes operações:

• Adicionar instrumentação para gerar spans.

• Adicionar atributos aos spans.

• Propagar Baggage no contexto de rastreamento.

• Obter o contexto de rastreamento atual e imprimir informações como o id do rastreamento e o id do span.

O código de exemplo a seguir mostra como usar o sdk do OpenTelemetry para executar essas operações.

@RestController
@RequestMapping("/ot")
public class OpenTelemetryController {
    private Tracer tracer;
    private ScheduledExecutorService ses = Executors.newSingleThreadScheduledExecutor();
    @PostConstruct
    public void init() {
	    OpenTelemetrySdk.builder()
			.setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))
			.buildAndRegisterGlobal();
		tracer = GlobalOpenTelemetry.get().getTracer("manual-sdk", "1.0.0");
        ses.scheduleAtFixedRate(new Runnable() {
            @Override
            public void run() {
                Span span = tracer.spanBuilder("schedule")
                        .setAttribute("schedule.time", System.currentTimeMillis())
                        .startSpan();
                try (Scope scope = span.makeCurrent()) {
                    System.out.println("scheduled!");
                    Thread.sleep(500L);
                    span.setAttribute("schedule.success", true);
                    System.out.println(Span.current().getSpanContext().getTraceId()); // Get the trace ID
                } catch (Throwable t) {
                    span.setStatus(StatusCode.ERROR, t.getMessage());
                } finally {
                    span.end();
                }
            }
        }, 10, 30, TimeUnit.SECONDS);
    }
    @ResponseBody
    @RequestMapping("/parent")
    public String parent() {
        Span span = tracer.spanBuilder("parent").setSpanKind(SpanKind.SERVER).startSpan();
        try (Scope scope = span.makeCurrent()) {
            // Use Baggage to propagate custom business tags.
            Baggage baggage =  Baggage.current().toBuilder()
                    .put("user.id", "1")
                    .put("user.name", "name")
                    .build();
            try (Scope baggageScope = baggage.storeInContext(Context.current()).makeCurrent()) {
                child();
            }
            span.setAttribute("http.method", "GET");
            span.setAttribute("http.uri", "/parent");
        } finally {
            span.end();
        }
        return "parent";
    }
    private void child() {
        Span span = tracer.spanBuilder("child").startSpan();
        try (Scope scope = span.makeCurrent()) {
            System.out.println("current traceId = " + Span.current().getSpanContext().getTraceId());
            System.out.println("userId in baggage = " + Baggage.current().getEntryValue("user.id"));
            Thread.sleep(1000);
        } catch (Throwable e) {
            span.setStatus(StatusCode.ERROR, e.getMessage());
        } finally {
            span.end();
        }
    }
}

Exemplo detalhado:

1. No método init da classe OpenTelemetryController, uma tarefa agendada é iniciada. Um span é criado no início de cada execução e finalizado ao término.

2. No método parent da classe OpenTelemetryController, vários métodos do sdk do OpenTelemetry são chamados.

   1. Sempre que o método é chamado, um span chamado parent é criado e finalizado quando o método termina.

   2. O sdk de Baggage adiciona dois itens de Baggage: user.id e user.name. Esses itens se propagam para aplicações downstream.

   3. Dois atributos são adicionados ao span criado na etapa 2.a.

3. O método child da classe OpenTelemetryController executa as seguintes operações:

   1. Sempre que o método é chamado, um span chamado child é criado e finalizado quando o método termina. Este span é filho daquele criado na etapa 2.a.

   2. O id do rastreamento é recuperado do contexto de rastreamento e impresso.

   3. O Baggage adicionado na etapa 2.b é recuperado e seu valor é impresso.

Diferenças entre versões do agente ARMS

O suporte às operações no código anterior varia conforme a versão do agente ARMS.

Resultados da instrumentação