Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel,
n'hésitez pas à nous contacter.
Test Optimization is not available in the selected site () at this time.
Join the Preview!
Test optimization for Go is in Preview.
Compatibility
Supported test frameworks:
Configuring reporting method
To report test results to Datadog, you need to configure the Datadog Go library:
Si vous utilisez un fournisseur de CI sur le cloud sans accès aux nœuds de worker sous-jacents, comme GitHub Actions ou CircleCI, configurez la bibliothèque pour utiliser le mode sans Agent. Pour cela, définissez les variables d’environnement suivantes :
DD_CIVISIBILITY_AGENTLESS_ENABLED=true (requis)- Active ou désactive le mode sans Agent.
Valeur par défaut : false DD_API_KEY (requis)- La clé d’API Datadog utilisée pour importer les résultats de test.
Valeur par défaut: (empty)
Configurez aussi le site Datadog vers lequel vous souhaitez envoyer des données.
DD_SITE (requis)- Le site Datadog vers lequel importer les résultats.
Valeur par défaut : datadoghq.com
SI vous exécutez des tests avec un fournisseur de CI sur site, comme Jenkins ou GitLab CI autogéré, installez l’Agent Datadog sur chaque nœud de worker en suivant les instructions d’installation de l’Agent. Cette méthode est recommandée, car elle vous permet d’associer automatiquement les résultats de test aux logs et aux métriques des hosts sous-jacents.
Si vous utilisez un exécuteur Kubernetes, Datadog vous conseille d’utiliser l’Operator Datadog. Celui-ci comprend le contrôleur d’admission Datadog, qui peut automatiquement injecter la bibliothèque du traceur dans les pods du build. Remarque : si vous utilisez l’Operator Datadog, il n’est pas nécessaire de télécharger et d’injecter la bibliothèque du traceur, car le contrôleur d’admission le fait à votre place. Vous pouvez donc ignorer l’étape correspondante ci-dessous. Vous devez toutefois vous assurer que vos pods définissent les variables d’environnement ou paramètres de ligne de commande nécessaires à l’activation de Test Visibility.
Si vous n’utilisez pas Kubernetes, ou si vous ne pouvez pas utiliser le contrôleur d’admission Datadog, et que le fournisseur de CI repose sur un exécuteur basé sur des conteneurs, définissez la variable d’environnement DD_TRACE_AGENT_URL (valeur par défaut : http://localhost:8126) dans le conteneur du build exécutant le traceur sur un endpoint accessible dans le conteneur. Remarque : lorsqu’elle est utilisée à l’intérieur du conteneur, la valeur localhost désigne le conteneur, et non le nœud de worker sous-jacent ou un conteneur dans lequel l’Agent pourrait s’exécuter.
DD_TRACE_AGENT_URL comprend le protocole et le port (par exemple, http://localhost:8126) et est prioritaire par rapport à DD_AGENT_HOST et DD_TRACE_AGENT_PORT. Ce paramètre est recommandé pour la configuration de l’URL de l’Agent Datadog pour CI Visibility.
Si vous ne parvenez pas à établir une connexion avec l’Agent Datadog, utilisez le mode sans agent. Remarque : avec cette méthode, les tests ne sont pas mis en corrélation avec les logs et les métriques d’infrastructure.
Installing Orchestrion
Orchestrion is a tool to process Go source code at compilation time and automatically insert instrumentation using dd-trace-go.
Install orchestrion from https://github.com/datadog/orchestrion using the command:
$ go install github.com/DataDog/orchestrion@latest
Optional: project go.mod registration
You can automatically add orchestrion to your project’s dependencies by running:
This command has the following effects:
- Create a new
orchestrion.tool.go file containing content similar to:// Code generated by `orchestrion pin`; DO NOT EDIT.
// This file is generated by `orchestrion pin`, and is used to include a blank import of the
// orchestrion package(s) so that `go mod tidy` does not remove the requirements rom go.mod.
// This file should be checked into source control.
//go:build tools
package tools
import _ "github.com/DataDog/orchestrion"
- Run
go get github.com/DataDog/orchstrion@<current-release> to make sure the project version corresponds to the
one currently being used - Run
go mod tidy to make sure your go.mod and go.sum files are up-to-date
If you do not run this command, it is done automatically when required. Once done, the version of orchestrion
used by this project can be controlled directly using the go.mod file, as you would control any other dependency.
Orchestrion supports the two latest releases of Go, matching Go’s official release policy. It may
function correctly with older Go releases, but Datadog cannot support older releases that do not work.
In addition to this, Orchestrion only supports projects using Go modules.
Instrumenting tests
Set the following environment variables to configure the library:
DD_CIVISIBILITY_ENABLED=true (Required)- Enables the Test Optimization product.
DD_ENV (Required)- Environment where the tests are being run (for example:
local when running tests on a developer workstation or ci when running them on a CI provider).
Prefix your go test command with orchestrion:
$ orchestrion go test -race ./...
If you have not run orchestrion pin, you may see a message similar to the following appear, as orchestrion pin is automatically executed:
╭──────────────────────────────────────────────────────────────────────────────╮
│ │
│ Warning: github.com/DataDog/orchestrion is not present in your go.mod │
│ file. │
│ In order to ensure build reliability and reproductibility, orchestrion │
│ will now add itself in your go.mod file by: │
│ │
│ 1. creating a new file named orchestrion.tool.go │
│ 2. running go get github.com/DataDog/orchestrion@v0.9.4 │
│ 3. running go mod tidy │
│ │
│ You should commit the resulting changes into your source control system. │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
Alternative
Orchestrion at the core is a standard Go toolchain -toolexec proxy. Instead of using orchestrion go, you can
also manually provide the -toolexec argument to go commands that accept it:
$ go build -toolexec 'orchestrion toolexec' .
$ go test -toolexec 'orchestrion toolexec' -race .
Further reading
Documentation, liens et articles supplémentaires utiles:
