Comment intégrer Dynatrace et Jira pour une meilleure observabilité

Want to learn more?

Pour de plus amples informations sur l'utilisation des sprints dans Jira, consultez le tutoriel sur les sprints.

Vous avez des questions ? Posez-les à la communauté Atlassian.

Présentation

Ce tutoriel dépend de plusieurs composants qui interagissent les uns avec les autres. Vous y découvrirez comment :

1. configurer Jira Automation pour créer un commentaire de carte de problème Dynatrace avec l'URL du ticket Jira ;

2. configurer Dynatrace pour transmettre les problèmes à Jira ;

3. déclencher un problème dans l'exemple d'app, et vérifier comment Dynatrace détecte le problème et crée automatiquement un ticket Jira ;

4. configurer les requêtes sur les tickets Jira sur la page Releases (Versions) de Dynatrace ;

5. nettoyer votre environnement.

Ce diagramme montre les composants de ce tutoriel et les interactions de base entre eux.

1. Surveillance d'une app grâce à Dynatrace : pour ce tutoriel, Dynatrace collectera des métriques à partir d'un agent Dynatrace installé sur l'hôte qui exécute l'exemple d'app. Toutes les données sont centralisées dans le locataire Dynatrace central, qui fournit également l'interface web pour l'administration et la détection des problèmes basée sur l'IA.

2. Notification des problèmes avec contexte détaillé : le moteur d'IA de Dynatrace, Davis, utilise des métriques haute fidélité, des traces, des journaux et des données utilisateur réelles mappées sur un modèle d'entité unifié. Il utilise l'IA déterministe de Davis pour révéler les causes profondes précises des problèmes. Davis ne se contente pas de localiser la cause profonde précise, mais il fournit instantanément un contexte précieux. Vous saurez si un problème est le résultat d'un goulot d'étranglement des ressources ou d'un changement de déploiement, et même qui en est responsable. Vous pouvez revoir les problèmes pour bien comprendre pourquoi ils se sont produits et comment les résoudre.

3. Création automatique d'un ticket Jira : l'intégration de Dynatrace et de Jira crée automatiquement des tickets pour tous les nouveaux problèmes détectés automatiquement dans vos environnements Dynatrace.

4. Mise à jour automatique de Dynatrace par Jira Automation : dans Jira, l'automatisation est une fonctionnalité « sans code » qui permet de créer facilement des règles en quelques clics. Une demande web adressée à l'API Dynatrace utilise l'ID de problème Dynatrace pour mettre à jour les commentaires de la carte de problème Dynatrace.

5. Résolution du problème et fermeture du ticket Jira

2. Dans Dynatrace, utilisez le menu de gauche et cliquez sur l'option Transactions and services (Transactions et services) pour afficher les services en cours d'exécution. Vous devriez voir plusieurs services en cours d'exécution, y compris les services frontend et order.

3. Cliquez sur le service frontend. Sur la page du service, cliquez sur le bouton View dynamic requests (Afficher les demandes dynamiques).

Des demandes devraient être adressées au service, comme indiqué ci-dessous.

2. Dans le sous-menu des paramètres, développez le sous-menu Integration (Intégration), puis sélectionnez l'option Dynatrace API (API Dynatrace).

3. Sur la page Dynatrace API (API Dynatrace), cliquez sur le bouton Generate Token (Générer un jeton).

4. Indiquez un nom de jeton, par exemple : Tutoriel Jira.

5. Développez la section API v1 et activez le périmètre Access problem feed, metrics, and topology (Accéder au flux, aux métriques et à la topologie du problème). N'activez aucun autre périmètre.

6. Cliquez sur le bouton Generate (Générer).

7. IMPORTANT : vous devez enregistrer le jeton généré dans un endroit sûr. Vous aurez besoin de cette valeur plus tard dans le tutoriel et vous ne pourrez plus la revoir. Utilisez le bouton Copy (Copier) pour être sûr d'obtenir la chaîne complète.

8. Une fois le jeton enregistré en lieu sûr, cliquez sur le bouton Close (Fermer).

3. IMPORTANT : n'oubliez pas de noter la clé de projet Jira. Vous aurez besoin de cette valeur dans la configuration de Dynatrace. Dans l'exemple ci-dessus, la clé est « DT ».

4. En haut à droite, cliquez sur le bouton Create rule (Créer une règle).

5. Sur la page New trigger (Nouveau déclencheur), choisissez le déclencheur intitulé Issue commented (Ticket commenté), puis Save (Enregistrer) sur la page suivante.

6. Dans la règle de page Add component (Ajouter un composant), cliquez sur l'option New action (Nouvelle action).

7. Sur la page New action (Nouvelle action), choisissez l'option de notification Send Web Request (Envoyer une demande web).

8. Saisissez les informations détaillées ci-dessous. Voici un exemple du résultat final :

• Webhook URL (URL de webhook) : il s'agit de l'URL du point de terminaison de l'API Dynatrace. Vous devez remplacer [YOUR-ENVIRONMENT-ID] dans cette chaîne par votre environnement. Reportez-vous à l'URL de votre environnement Dynatrace pour obtenir cette valeur.
  
  https://[YOUR-ENVIRONMENT-ID]/api/v1/problem/details/{{issue.description.match(".*pid=(.*)")}}/comments
  
  REMARQUE TECHNIQUE : l'expression de valeur intelligente Jira Match extrait l'ID de problème (PID) Dynatrace à partir de l'URL du problème qui se trouve dans la description du problème. Un site web comme regex101 peut vous aider à créer ces expressions.

• Headers (En-têtes) : contient la valeur du jeton d'API Dynatrace que vous avez créée précédemment. Pour le nom de l'en-tête, utilisez la valeur Authorization (Autorisation). Pour la valeur de l'en-tête, utilisez cette chaîne et remplacez-la par la valeur du jeton : Api-Token [YOUR-DYNATRACE-API-TOKEN]. REMARQUE : vous devez inclure le jeton Api-Token avec un espace avant la chaîne du jeton.

• HTTP Method (Méthode HTTP) : choisissez l'option POST.

• Webhook Body (Corps du webhook) : dans la liste déroulante, choisissez Custom data (Données personnalisées) et collez le corps JSON complet.

  { "message": "Opened Jira Issue: [{{issue.key}}]({{issue.url}})", "context": "Jira" }
  
  *** Pro Tip: Learn more about Smart Values here: https://support.atlassian.com/jira-software-cloud/docs/smart-values-general/

9. Cliquez sur le bouton Save (Enregistrer).

10. Sur la page suivante, saisissez un nom tel que « Envoyer un commentaire à Dynatrace lors de la création d'un ticket », puis cliquez sur le bouton Turn it on (L'activer).

11. Après avoir enregistré, en haut à droite, cliquez sur le lien Return to list (Retour à la liste). La nouvelle règle devrait être activée.

1. Dans le menu de gauche de Dynatrace, cliquez sur l'option Settings (Paramètres).

2. Dans le sous-menu des paramètres, développez le sous-menu Integrations (Integrations), puis sélectionnez l'option Problem notifications (Notifications de problème).

3. Sélectionnez Set up notifications (Configurer les notifications).

4. Sélectionnez Jira dans les types de notification disponibles.

5. Configurez la notification :

• Display name (Nom affiché) : saisissez une valeur, par exemple, « Tutoriel Jira »

• Jira endpoint URI (URI du point de terminaison Jira) : mettez à jour cette valeur pour qu'elle reflète votre compte Jira

  https://[YOUR-JIRA-ACCOUNT].atlassian.net/rest/api/2/

• Username (Nom d'utilisateur) : ID utilisateur que vous avez utilisé pour créer le jeton d'API Atlassian

• API token (Jeton d'API) : la chaîne du jeton d'API Atlassian

• Project key (Clé du projet) : la clé (et non le nom) du projet Jira dans lequel les tickets sont créés et suivis. Si vous avez utilisé la même dans l'exemple ci-dessus, il s'agissait de « DT »

• Summary (Résumé) : laissez la valeur par défaut

• Issue description (Description du problème) : laissez la valeur par défaut
  
  *** Conseil de pro : la section Available placeholders (Espaces réservés disponibles) de la page de configuration répertorie les espaces réservés que vous pouvez utiliser pour cette intégration. Les espaces réservés sont automatiquement remplacés par des informations liées au problème.

6. Sélectionnez Send test notification (Envoyer une notification de test) pour vous assurer que votre intégration Jira fonctionne. Vous souhaitez voir :

Et dans Jira, le ticket de test ressemblera à ceci :

7. Cliquez sur le bouton Save (Enregistrer).