Module 8 du parcours Dynatrace Managed — Automatisation, API d’environnement et API Cluster : passer des réglages manuels aux scripts et à la configuration as code.
Parcours : Dynatrace Managed · Module 8/8 · Durée : ~75 min · Niveau : Avancé
Objectifs :
- Distinguer l’API d’environnement et l’API Cluster, et savoir laquelle utiliser.
- Créer un jeton d’API au périmètre minimal et faire ses premiers appels.
- Lire des entités, des métriques et des problèmes depuis un script.
- Comprendre l’approche configuration as code et ses outils.
Prérequis : modules 1 à 7, un environnement Managed de recette, les droits pour créer des jetons d’API, un poste avec curl et jq, et des notions de JSON et de Git.
Tout ce que vous avez réglé à la main pendant ce parcours (tags, management zones, profils d’alerte, environnements) peut être créé, lu et contrôlé par programme. Ce dernier module du parcours Dynatrace Managed est consacré à l’automatisation par API en Managed : les deux familles d’API, les jetons, les premiers scripts, puis le passage à la configuration as code pour versionner vos réglages comme du code applicatif.
Il prolonge directement le module 7, dont les contrôles d’exploitation sont de bons candidats à l’automatisation. Le sommaire du parcours récapitule l’ensemble des modules.
Quelles API pour l’automatisation API en Managed ?
Un déploiement Managed expose deux familles d’API, avec des adresses et des jetons distincts :
| API | Adresse de base | Usage |
|---|---|---|
| API d’environnement (v1 et v2) | https://{votre-domaine}/e/{id-environnement}/api/… |
Données et configuration d’un environnement : entités, métriques, problèmes, paramètres, jetons |
| API Cluster (v1 et v2) | https://{votre-domaine}/api/cluster/… |
Administration du cluster : environnements, nœuds, utilisateurs et groupes, quotas |
Règle simple : si la tâche concerne ce qui est supervisé, c’est l’API d’environnement ; si elle concerne la plateforme elle-même, c’est l’API Cluster. Les jetons de l’une ne fonctionnent pas sur l’autre.
Créer un jeton d’API au juste périmètre
Les jetons d’environnement se créent dans les paramètres de l’environnement, les jetons Cluster dans la CMC. Dans les deux cas, cochez uniquement les permissions (scopes) nécessaires, donnez un nom explicite au jeton (« audit-lecture », « pipeline-config-recette ») et stockez-le dans un coffre de secrets, jamais dans un dépôt Git. Le jeton se transmet dans l’en-tête HTTP :
Authorization: Api-Token {votre-jeton}
Pour les premiers appels de ce module, un jeton d’environnement en lecture seule suffit, avec les permissions de lecture des entités, des métriques, des problèmes et des paramètres. Les noms exacts figurent dans l’écran de création du jeton.
Lire des données avec l’API d’environnement
Quelques appels utiles, à adapter à votre domaine et à votre identifiant d’environnement :
export DT_URL="https://{votre-domaine}/e/{id-environnement}"
export DT_TOKEN="..." # à charger depuis votre coffre de secrets
# Lister les hôtes supervisés
curl -s -H "Authorization: Api-Token $DT_TOKEN" \
"$DT_URL/api/v2/entities?entitySelector=type(%22HOST%22)" | jq '.entities[].displayName'
# Lister les problèmes ouverts ou récents
curl -s -H "Authorization: Api-Token $DT_TOKEN" \
"$DT_URL/api/v2/problems" | jq '.problems[] | {title, severityLevel, status}'
# Interroger une métrique
curl -s -H "Authorization: Api-Token $DT_TOKEN" \
"$DT_URL/api/v2/metrics/query?metricSelector=builtin:host.cpu.usage&from=now-2h"
Les réponses volumineuses sont paginées : suivez la clé de page suivante renvoyée par l’API jusqu’à épuisement. Vérifiez aussi le code HTTP de chaque appel dans vos scripts, un 401 ou un 403 signalant presque toujours un jeton invalide ou une permission manquante.
Administrer avec l’API Cluster
L’API Cluster sert surtout à industrialiser la création d’environnements, la gestion des groupes et le contrôle de l’état des nœuds avant une maintenance. Un premier appel typique consiste à lister les environnements :
curl -s -H "Authorization: Api-Token $CLUSTER_TOKEN" \
"https://{votre-domaine}/api/cluster/v2/environments" | jq
Écrivez vos scripts de façon idempotente : on vérifie si l’objet existe avant de le créer, pour pouvoir relancer le script sans effet de bord. L’article Automatiser l’administration avec l’API Cluster de Dynatrace Managed déroule plusieurs scénarios complets.
Passer à la configuration as code
Les appels unitaires montrent vite leurs limites : il faut gérer l’ordre de création, les dépendances (un profil d’alerte qui référence une management zone) et la promotion d’un environnement à l’autre. La configuration as code répond à ces besoins : la configuration est décrite dans des fichiers versionnés, relus en revue de code et appliquée par un outil.
| Outil | Principe | Quand le choisir |
|---|---|---|
| Monaco (Dynatrace Configuration as Code) | CLI open source maintenue par Dynatrace, configurations en YAML et JSON, déploiement vers un ou plusieurs environnements | Équipes qui veulent un outil dédié à Dynatrace |
| Fournisseur Terraform Dynatrace | Ressources Terraform pour la configuration Dynatrace | Organisations déjà outillées en Terraform |
| Scripts maison | Appels API directs | Besoins ponctuels ou très spécifiques |
Avant de choisir, vérifiez dans la documentation de chaque outil sa compatibilité avec votre version de Managed et les types de configuration pris en charge. Dans tous les cas, le schéma cible est le même : dépôt Git, revue, pipeline qui applique d’abord en recette puis en production.
depot-config-dynatrace/
├── recette/
│ ├── management-zones/
│ ├── auto-tagging/
│ └── alerting-profiles/
└── prod/
└── ...
Pour les tags et zones, l’article Management zones et tagging automatique montre comment les créer via l’API de paramètres.
Exercice pratique
Étape 1 — Créer un jeton en lecture seule
Dans votre environnement de recette, créez un jeton nommé formation-lecture avec uniquement des permissions de lecture (entités, métriques, problèmes).
Résultat attendu : un jeton affiché une seule fois, que vous rangez dans votre gestionnaire de secrets.
Étape 2 — Lister les hôtes
Exécutez l’appel entities ci-dessus.
Résultat attendu : la liste des noms d’hôtes, identique à celle de l’interface.
Étape 3 — Produire un rapport de problèmes
Adaptez l’appel problems pour sortir un fichier CSV (titre, sévérité, statut) avec jq -r.
Résultat attendu : un fichier lisible dans un tableur, que vous pourriez envoyer chaque lundi.
Étape 4 — Vérifier les permissions
Tentez une écriture (par exemple la création d’un paramètre) avec ce même jeton.
Résultat attendu : un refus (code 403), preuve que le périmètre du jeton est bien limité.
Étape 5 — Exporter une configuration
Avec Monaco ou le fournisseur Terraform, en suivant leur documentation, exportez les management zones de l’environnement de recette dans un dépôt Git local.
Résultat attendu : des fichiers décrivant vos zones, prêts à être relus et réappliqués.
Quiz
- Quelle API utilisez-vous pour créer un nouvel environnement ?
A. L’API d’environnement · B. L’API Cluster · C. L’API OneAgent - Comment le jeton est-il transmis lors d’un appel ?
A. Dans l’en-têteAuthorization: Api-Token …· B. Dans le nom de domaine · C. Dans un cookie de session de l’interface - Un script reçoit un code 403. Quelle est la cause la plus probable ?
A. Le cluster est éteint · B. Le jeton n’a pas la permission requise · C. La métrique n’existe pas - Quel est l’apport principal de la configuration as code ?
A. Elle remplace la supervision · B. Elle versionne, relit et rejoue la configuration de façon reproductible · C. Elle supprime le besoin de jetons
Corrigé
- B. La création d’environnements relève de l’administration du cluster.
- A. L’en-tête
Authorizationavec le préfixeApi-Tokenporte le jeton. - B. Un 403 signale un accès refusé, le plus souvent une permission absente du jeton.
- B. Les fichiers versionnés rendent chaque changement traçable et reproductible d’un environnement à l’autre.
Pour aller plus loin
- Automatiser l’administration avec l’API Cluster de Dynatrace Managed
- Gérer plusieurs environnements et quotas de licence dans la CMC
- Management zones et tagging automatique : structurer un environnement partagé
- Documentation officielle Dynatrace Managed : docs.dynatrace.com/managed (rubriques sur l’API d’environnement, l’API Cluster et la configuration as code)
← Module 7 : exploiter le cluster · Sommaire du parcours →
Questions fréquentes
Faut-il préférer l’API v2 à la v1 ?
Pour les nouveaux scripts, oui lorsque l’équivalent existe en v2. Certaines opérations de configuration restent disponibles uniquement en v1 selon la version : vérifiez dans la documentation de votre version.
Peut-on utiliser le même jeton pour tout ?
C’est déconseillé. Un jeton par usage, au périmètre minimal, limite l’impact d’une fuite et facilite la rotation.
Les scripts écrits pour Managed fonctionnent-ils en SaaS ?
Une partie des API d’environnement est commune, mais la plateforme SaaS de dernière génération propose d’autres mécanismes et n’a pas d’API Cluster. Le parcours Dynatrace SaaS les présente séparément.
Ce module clôt le parcours : vous savez désormais installer, déployer, explorer, alerter, organiser, exploiter et automatiser un environnement Dynatrace Managed. Revenez au sommaire pour réviser un module ou préparer une certification officielle.
span.observer est un blog indépendant de la communauté, non affilié à Dynatrace LLC. Ce parcours ne remplace pas les formations et certifications officielles de Dynatrace University. Vérifiez les fonctionnalités dans la documentation officielle de votre version.
1 comment