Configuration d’OpenTelemetry pour obtenir des informations sur les applications AEM

Découvrez comment connecter un environnement AEM as a Cloud Service à la plateforme d’observabilité compatible OpenTelemetry de votre choix.

Dans articles précédents vous avez découvert les concepts et les avantages de l’utilisation d’OpenTelemetry avec AEM as a Cloud Service. Dans ce tutoriel, nous utilisons l’exemple de projet AEM WKND comme exemple d’application et nous montrons comment exporter des données télémétriques en déployant des config/otel.yaml à l’aide d’un pipeline de configuration Cloud Manager.

Les grandes étapes sont les suivantes :

Prérequis

Avant de commencer, vérifiez que vous disposez des éléments suivants :

Étape 1 : obtenir votre point d’entrée d’observabilité et vos informations d’identification

Dans votre plateforme d’observabilité, localisez son point d’entrée d’ingestion OTLP/HTTPS et créez ou récupérez les informations d’identification d’ingestion appropriées. Consultez la documentation de votre plateforme pour obtenir des instructions.

Vous ne savez pas quelle plateforme utiliser ? Voir Choisir une plateforme d’observabilité.

Ce tutoriel utilise une plateforme d’observabilité auto-hébergée qui prend en charge OTLP via HTTPS et nécessite un jeton d’authentification de base.

Étape 2 : Stocker vos informations d’observabilité dans Cloud Manager

Stockez les informations d’identification d’ingestion en tant que Cloud Manager variable d’environnement secrète.

Le fichier config/otel.yaml fait référence à ce secret en tant que ${{secrets.OTEL_CUSTOMER_AUTH}}. Les informations d’identification ne doivent jamais apparaître dans le référentiel AEM ou dans les journaux de pipeline.

Étape 3 : Ajouter la configuration OpenTelemetry

Dans le référentiel de votre projet AEM, créez le fichier config/otel.yaml. La plateforme auto-hébergée de ce tutoriel utilise la configuration suivante :

kind: "Otel"
version: "v1"
metadata:
  envTypes:
    - "dev"
    - "stage"
    - "prod"
data:
  enabled: true
  type: "generic"
  endpoint: "https://my-self-hosted-observability.adobe.net"
  authHeaderName: "Authorization"
  authHeaderValue: "${{secrets.OTEL_CUSTOMER_AUTH}}"
  metrics: true
  logs: true

Les paramètres clés sont les suivants :

Effectue le suivi de l’exportation chaque fois que l’intégration est activée. Les mesures et les journaux sont facultatifs. Ils sont exportés uniquement lorsqu’ils sont définis sur true.

Par exemple, consultez l’exemple de configuration WKND suivant :

Étape 4 : déploiement de la configuration OpenTelemetry

Le pipeline valide la configuration avant d’appliquer les paramètres de destination.

Étape 5 : générer le trafic AEM

Une fois le pipeline terminé, générez une activité d’application :

Patientez quelques minutes pour que la télémétrie atteigne votre plateforme d’observabilité.

Etape 6 : Vérification de la télémétrie dans votre plateforme d’observabilité

Ouvrez votre plateforme d’observabilité et recherchez la télémétrie. Les étapes de localisation des traces, des mesures et des journaux varient selon la plateforme. Les captures d’écran suivantes proviennent des tableaux de bord de la plateforme d’observabilité basés sur Grafana.

Recherche du service AEM

Recherchez un nom de service AEM similaire à :

cm-p<program>-e<environment>-aem-publish-<environment-type>

Dans la plateforme auto-hébergée utilisée dans ce tutoriel, la télémétrie du service de publication se présente comme suit :

Inspecter les traces

Recherchez les plages de requêtes HTTP entrantes qui correspondent à vos requêtes de page WKND. Ouvrez une trace et vérifiez le nom, la durée et les plages de requêtes associées de la requête.

Inspecter les mesures

Comme les jeux de configuration metrics: true, recherchez les mesures JVM et HTTP telles que l’utilisation de la mémoire, la durée du nettoyage de la mémoire, le nombre de threads et la durée des requêtes HTTP.

Inspecter les journaux

Comme les jeux de configuration logs: true, vérifiez les journaux d’application AEM dans la destination. L’intégration exporte les journaux à un seuil de gravité pris en charge (WARN ou supérieur), de sorte que les visites de page ordinaires peuvent ne pas produire d’entrées de journal à ce niveau.

Résolution des problèmes

Si le pipeline de configuration échoue ou si la télémétrie n’apparaît pas dans votre plateforme d’observabilité, consultez les journaux du pipeline et vérifiez les points suivants :

Si le problème persiste, contactez l’assistance Adobe et fournissez l’identifiant du programme AEM, l’identifiant de l’environnement, l’identifiant d’exécution du pipeline de configuration, le message d’erreur exact et les détails du fournisseur d’observabilité. N’incluez jamais d’informations d’authentification ou de valeurs secrètes.

Pour obtenir des exemples de configuration et des informations de dépannage supplémentaires, consultez la documentation du produit OpenTelemetry.

Étapes suivantes

Vous avez configuré OpenTelemetry pour AEM as a Cloud Service et vérifié que la télémétrie de l’exemple d’application WKND est disponible dans votre plateforme d’observabilité.

Vous pouvez désormais utiliser cette télémétrie pour analyser les requêtes lentes ou en échec, surveiller les performances JVM et HTTP, et corréler les journaux d’application avec les traces afin de mieux comprendre le comportement des applications AEM.

Pour étendre la télémétrie à votre logique spécifique à l’application, consultez Instrumentation personnalisée avec OpenTelemetry.

Pour explorer d’autres options de configuration, les fournisseurs d’observabilité pris en charge et les exigences de mise en réseau, reportez-vous à la documentation du produit OpenTelemetry.

Ressources supplémentaires