Ajouter des commandes personnalisées à des traces de pipeline

La solution CI Visibility n'est pas disponible pour le site que vous avez sélectionné ().

Les commandes personnalisées vous permettent de tracer des commandes individuelles dans vos pipelines de CI. Vous pouvez ainsi mesurer la durée de votre commande, sans tenir compte des actions de configuration ou de nettoyage que la tâche peut comporter (par exemple, le temps passé à télécharger des images Docker ou à attendre un nœud disponible dans une infrastructure basée sur Kubernetes). Ces spans s’affichent dans la trace du pipeline :

Détails d'un pipeline avec des commandes personnalisées

Compatibilité

Les commandes personnalisées sont compatibles avec les fournisseurs de CI suivants :

  • Jenkins avec le plug-in Datadog v3.2.0+
  • CircleCI

Installer l’interface de ligne de commande Datadog CI

Installez l’interface de ligne de commande datadog-ci (>=v0.17.0) de façon globale avec npm :

npm install -g @datadog/datadog-ci

Tracer une commande

Pour tracer une commande, exécutez ce qui suit :

datadog-ci trace [--name <nom>] -- <commande>

Indiquez une clé d’API Datadog valide dans la variable d’environnement DATADOG_API_KEY. Exemple :


DATADOG_API_KEY=<key> DATADOG_SITE= datadog-ci trace \
--name "Greet" \
-- \
echo "Hello World"

La solution CI Visibility n'est pas disponible pour le site que vous avez sélectionné ().

Paramètres de configuration

Les options ci-dessous sont disponibles pour la commande datadog-ci trace :

--name
Nom d’affichage de la commande personnalisée.
Valeur par défaut : même valeur que <commande>
Exemple : Wait for DB to be reachable
--tags
Paires key/value au format key:value à associer à la commande personnalisée (le paramètre --tags peut être fourni plusieurs fois). Lorsque vous spécifiez des tags avec DD_TAGS, séparez-les avec des virgules (par exemple, team:backend,priority:high).
Variable d’environnement : DD_TAGS
Valeur par défaut : (aucune)
Exemple : team:backend
Remarque : les tags spécifiés avec --tags et avec la variable d’environnement DD_TAGS sont fusionnés. Si --tags et DD_TAGS comportent la même clé, la valeur de DD_TAGS est prioritaire.
--no-fail
Empêche tout échec de datadog-ci, même en cas d’exécution dans un fournisseur de CI non pris en charge. Dans ce cas, la commande est exécutée et aucune donnée n’est transmise à Datadog.
Valeur par défaut : false
Arguments positionnels
La commande qui est lancée et tracée.

Les variables d’environnement suivantes sont prises en charge :

DATADOG_API_KEY (requis)
La clé d’API Datadog utilisée pour authentifier les requêtes.
Valeur par défaut : (aucune)

En outre, configurez le site Datadog sur le site sélectionné () :

DATADOG_SITE
Le site Datadog vers lequel télécharger les résultats.
Valeur par défaut : datadoghq.com
Site sélectionné :

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles: