Application Real-Time Monitoring Service:Ajouter une instrumentation personnalisée avec OpenTelemetry pour 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>

Concepts clés

Cette section décrit uniquement les termes courants. Pour plus d'informations sur les autres termes, consultez les spécifications OpenTelemetry.

• span : opération spécifique dans une requête, telle qu'un point d'entrée d'appel distant ou un appel de méthode interne.

• SpanContext : contexte d'une trace, incluant des informations telles que l'ID de trace et l'ID de span.

• attribute : champ supplémentaire sur un span qui enregistre des informations clés.

• Baggage : paires clé-valeur propagées tout au long de la trace.

Utiliser le SDK OpenTelemetry pour Java

Le SDK OpenTelemetry vous permet d'effectuer les opérations suivantes :

• Ajouter une instrumentation pour générer des spans.

• Ajouter des attributs aux spans.

• Propager le Baggage dans le contexte de trace.

• Obtenir le contexte de trace actuel et afficher des informations telles que l'ID de trace et l'ID de span.

L'exemple de code suivant montre comment utiliser le SDK OpenTelemetry pour réaliser ces opérations.

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

Parcours de l'exemple :

1. Dans la méthode init de OpenTelemetryController, une tâche planifiée démarre. Un span est créé au début de chaque exécution et se termine à la fin de celle-ci.

2. Dans la méthode parent de OpenTelemetryController, plusieurs méthodes du SDK OpenTelemetry sont appelées.

   1. À chaque appel de la méthode, un span nommé parent est créé et se termine à la fin de la méthode.

   2. Le SDK Baggage est utilisé pour ajouter deux éléments Baggage : user.id et user.name. Ces éléments sont propagés vers les applications en aval.

   3. Deux attributs sont ajoutés au span créé à l'étape 2.a.

3. La méthode child de OpenTelemetryController effectue les opérations suivantes :

   1. À chaque appel de la méthode, un span nommé child est créé et se termine à la fin de la méthode. Ce span est un enfant de celui créé à l'étape 2.a.

   2. L'ID de trace est récupéré depuis le contexte de trace et affiché.

   3. Le Baggage ajouté à l'étape 2.b est récupéré et sa valeur est affichée.

Différences entre les versions de l'agent ARMS

La prise en charge des opérations du code précédent varie selon les versions de l'agent ARMS.

Résultats de l'instrumentation