Application Real-Time Monitoring Service:ARMS Java SDK (non recommandé)

Utilisation

Pour les versions 4.x et ultérieures de l'agent, nous vous recommandons d'utiliser le SDK OpenTelemetry Java pour l'instrumentation personnalisée et l'obtention du contexte de trace :

• Instrumenter manuellement des applications avec le SDK OpenTelemetry Java

• Propager le contexte dans les scénarios asynchrones intra-processus à l'aide du SDK OpenTelemetry Java

• Propager le contexte entre processus à l'aide du SDK OpenTelemetry Java

Nous déconseillons l'utilisation du SDK ARMS pour l'instrumentation personnalisée ou l'obtention du contexte de trace, sauf si vous ne pouvez pas mettre à niveau l'agent vers la version 4.x.

Prérequis

• Activez la surveillance des applications pour votre application dans la console ARMS et démarrez l'agent dans votre application Java. Pour plus d'informations, consultez Installer manuellement un agent.

• Votre application inclut la dépendance arms-sdk-1.7.3.jar.

  <dependency>
      <groupId>com.alibaba.arms.apm</groupId>
      <artifactId>arms-sdk</artifactId>
      <version>1.7.3</version>
  </dependency>

  Remarque

  Si vous ne parvenez pas à obtenir la dépendance depuis le fichier pom.xml, téléchargez arms-sdk-1.7.3.jar.

Obtenir l'ID de trace et l'ID RPC

Utilisez le code suivant pour obtenir l'ID de trace et l'ID RPC.

Span span = Tracer.builder().getSpan();   // This does not create a new span.
String traceId = span.getTraceId();
String rpcId = span.getRpcId();

Propager les données baggage personnalisées

Pour propager des données baggage personnalisées, ajoutez le code nécessaire pour définir et récupérer les éléments comme suit :

1. Ajoutez des données baggage personnalisées dans votre code d'application.

   Map<String, String> baggage = new HashMap<String, String>();
   baggage.put("key-01", "value-01");
   baggage.put("key-02", "value-02");
   baggage.put("key-03", "value-03");
   Span span = Tracer.builder().getSpan();
   span.withBaggage(baggage);

2. Récupérez les données baggage personnalisées depuis votre code d'application.

   Span span = Tracer.builder().getSpan();
   Map<String, String> baggage = span.baggageItems();

3. Pour les versions 4.x et ultérieures de l'agent, les données baggage sont uniquement propagées. L'agent n'ajoute pas automatiquement ce contenu aux tags de chaque span. Si vous avez besoin de ces données dans les tags, vous devez manuellement définir un tag personnalisé pour un span.

Définir des tags personnalisés pour un span

Les tags s'appliquent uniquement au span spécifique sur lequel ils sont définis et ne sont pas propagés aux autres spans. Pour définir et récupérer des tags personnalisés, suivez les étapes ci-dessous :

1. Ajoutez des tags personnalisés à un span dans votre code d'application. Vous pouvez ajouter plusieurs tags.

   Span span = Tracer.builder().getSpan();
   // Add a tag to the Span.
   span.setTag("tag-key1", "tag-value1");
   span.setTag("tag-key2", "tag-value2");

2. Récupérez les tags personnalisés d'un span.

   Span span = Tracer.builder().getSpan();
   // Inspect the Span's tags.
   Map<String, String> tags = span.tags();

Interroger les traces par baggage et tags personnalisés

Utilisez les données baggage et les tags personnalisés définis sur un span pour interroger les traces.

• Les données Baggage sont propagées aux services en aval et sont généralement utilisées pour la propagation du contexte métier. Évitez de définir un nombre excessif d'éléments baggage.

• Un tag s'applique uniquement au span actuel. Vous pouvez définir plusieurs tags pour les données métier.

1. Connectez-vous à la console ARMS. Dans le volet de navigation de gauche, sélectionnez .

2. Sur la page , sélectionnez la région cible en haut. Ensuite, sélectionnez un , saisissez la valeur du tag personnalisé dans le champ et cliquez sur .

3. Dans la liste des traces, cliquez sur l'ID de trace de la trace cible.

4. Sur la page de détails Traces, placez le curseur sur la colonne pour afficher les tags du span actuel.

   Par exemple, les tags personnalisés tag-userid (avec la valeur 123456789) et tag-bu (avec la valeur taobao) sont ajoutés aux tags du span.

5. Pour les versions 4.x et ultérieures de l'agent, pour écrire le contenu des données baggage dans un span, récupérez d'abord tous les éléments baggage comme décrit dans Propager les données baggage personnalisées. Ensuite, écrivez-les dans le span en utilisant la méthode décrite dans Définir des tags personnalisés pour un span.