Set up Tracing on a CircleCI Workflow
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.
CI Visibility is not available in the selected site () at this time.
Compatibility
Partial pipelines: View partial and downstream pipeline executions
Custom spans: Configure custom spans
Custom pre-defined tags: Set custom tags to all generated pipeline and job spans
Custom tags and metrics at runtime: Configure custom tags and metrics at runtime
The Datadog integration for CircleCI works by using webhooks to send data to Datadog.
For each project, go to Project Settings > Webhooks in CircleCI and add a new webhook:
- Webhook URL:
https://webhook-intake./api/v2/webhook/?dd-api-key=<API_KEY>
where <API_KEY>
is your Datadog API key. - Name:
Datadog CI Visibility
or any other identifier name that you want to provide. - Events: Select
Workflow Completed
and Job Completed
. - Certificate verifications: Enable this check.
Click Add Webhook to save the new webhook.
You can enable the hooks for many or all of your CircleCI projects in bulk, using this Python script which calls the Circle CI API.
The script requires:
- Python 3 and the requests package. For more info, run:
./service_hooks.py --help
- Your Datadog API key
- A Circle CI personal API token
To bulk-configure hooks for your projects:
Log in to your Circle CI account and follow all the projects for which you want to enable the hooks. Optionally, use the Follow All button on the Projects page.
Run the script either using environment variables DD_API_KEY
and DD_SITE
, or passing in flag parameters --dd-api-key
and --dd-site
:
For example:
./service_hooks.py \
--dd-api-key <DD_API_KEY> \
--circle-token <CIRCLECI_TOKEN> \
--dd-site
\
--threads 4
To set custom tags to all the pipeline and job spans generated by the integration, add to the Webhook URL a URL-encoded query parameter tags
, with key:value
pairs separated by commas. If a key:value pair contains any commas, surround it with quotes. For example, to add key1:value1,"key2: value with , comma",key3:value3
, the following string would need to be appended to the Webhook URL:
?tags=key1%3Avalue1%2C%22key2%3A+value+with+%2C+comma%22%2Ckey3%3Avalue3
Integrate with Datadog Teams
To display and filter the teams associated with your pipelines, add team:<your-team>
as a custom tag. The custom tag name must match your Datadog Teams team handle exactly.
Visualize pipeline data in Datadog
The Pipelines and Pipeline Executions pages populate with data after the workflows finish.
Note: The Pipelines page shows data for only the default branch of each repository.
Further reading
Documentation, liens et articles supplémentaires utiles: