Ajouter des métriques custom à vos tests

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

Présentation

Avant de commencer, assurez-vous que Test Visibility est déjà configuré pour votre langage. Ce guide vous explique comment ajouter et utiliser des métriques custom pour vos tests.

Ces métriques custom ne sont pas des métriques Datadog. Elles correspondent à des tags numériques (ou « mesures ») qui représentent des valeurs telles que l'utilisation de la mémoire ou des taux de requêtes.

Ajouter la métrique custom à votre test

Ajoutez la métrique custom à votre test. Grâce à l’instrumentation native, vous pouvez utiliser l’API de programmation :

  it('sum function can sum', () => {
    const testSpan = require('dd-trace').scope().active()
    testSpan.setTag('test.memory.rss', process.memoryUsage().rss)
    // le test se poursuit normalement
    // ...
  })
// dans votre test
final Span span = GlobalTracer.get().activeSpan();
if (span != null) {
  span.setTag("test.memory.usage", 1e8);
}
// le test se poursuit normalement
// ...
from ddtrace import tracer
import os, psutil

# Déclarer `ddspan` en tant qu'argument de votre test
def test_simple_case(ddspan):
    # Définir vos tags
    process = psutil.Process()
    ddspan.set_tag("test.memory.rss", process.memory_info().rss)
    # le test se poursuit normalement
    # ...
// dans votre test
var scope = Tracer.Instance.ActiveScope; // from Datadog.Trace;
if (scope != null) {
    scope.Span.SetTag("test.memory.usage", 1e8);
}
// le test se poursuit normalement
// ...
require 'datadog/ci'

# dans votre test
Datadog::CI.active_test&.set_tag('test.memory.usage', 1e8)
# le test se poursuit normalement
# ...

Pour datadog-ci, utilisez la variable d’environnement DD_METRICS ou l’argument CLI --metrics :

DD_METRICS="test.memory.usage:1000" datadog-ci junit upload --service my-service --metrics test.request.rate:30 report.xml

Créer une facette

Créez une facette pour la métrique custom que vous avez ajoutée au test en accédant à la page Test Runs et en cliquant sur + Add dans la liste des facettes.

Assurez-vous de sélectionner Measure comme type de facette. La mesure représente une valeur numérique :

Cliquez sur Add pour commencer à utiliser votre métrique custom.

Générer un graphique illustrant l’évolution de votre métrique

Représentez l’évolution de votre métrique en sélectionnant la visualisation Timeseries :

Vous pouvez par exemple utiliser cette visualisation pour suivre l’évolution de l’utilisation de la mémoire dans vos tests.

Exporter votre graphique

Vous pouvez exporter votre graphique au sein d’un dashboard ou d’un notebook. Pour créer un monitor basé sur ce graphique, cliquez sur le bouton Export :

Ajouter un monitor

Pour recevoir une alerte lorsque la valeur de votre métrique passe sous un certain seuil, créez un monitor de test CI.

Ce type d’alerte peut par exemple vous prévenir lorsque l’utilisation de la mémoire atteint un certain seuil.

Pour aller plus loin