ContextQMD
Back to Gitlabhq

Datadog

doc/integration/datadog.md

18.11.23.3 KB
Original Source

{{< details >}}

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

The Datadog integration enables you to connect your GitLab projects to Datadog, synchronizing repository metadata to enrich your Datadog telemetry, have Datadog comment on Merge Requests, and send CI/CD pipeline and job information to Datadog.

Connect your Datadog account

Users with the Administrator role can configure the integration for the entire instance or for a specific project or group:

  1. If you do not have a Datadog API key:
    1. Sign in to Datadog.
    2. Go to the Integrations section.
    3. Generate an API key in the APIs tab. Copy this value, as you need it in a later step.
  2. For integrations for a specific project or group: In GitLab, go to your project or group.
  3. For integrations for the entire instance:
    1. Sign in to GitLab as a user with administrator access.
    2. In the upper-right corner, select Admin.
  4. Select Settings > Integrations.
  5. Scroll to Add an integration, and select Datadog.
  6. Select Active to enable the integration.
  7. Specify the Datadog site to send data to.
  8. Optional. To override the API URL used to send data directly, provide an API URL. Used only in advanced scenarios.
  9. Provide your Datadog API key.

Configure CI Visibility

You can optionally enable Datadog CI Visibility to send the CI/CD pipeline and job data to Datadog. Use this feature to monitor and troubleshoot job failures and performance issues.

For more information, see the Datadog CI Visibility documentation.

[!warning] Datadog CI Visibility is priced per committer. Using this feature might affect your Datadog bill. For details, see the Datadog pricing page.

This feature is based on Webhooks, and only requires configuration in GitLab:

  1. Optional. Select Enable Pipeline job logs collection to enable logs collection for the output of jobs. (Introduced in GitLab 15.3.)
  2. Optional. If you use more than one GitLab instance, provide a unique Service name to differentiate between your GitLab instances. <!-- vale gitlab_base.Spelling = NO -->
  3. Optional. If you use groups of GitLab instances (such as staging and production environments), provide an Env name. This value is attached to each span the integration generates. <!-- vale gitlab_base.Spelling = YES -->
  4. Optional. To define any custom tags for all spans at which the integration is being configured, enter one tag per line in Tags. Each line must be in the format key:value.
  5. Optional. Select Test settings.
  6. Select Save changes.

When the integration sends data, you can view it in the CI Visibility section of your Datadog account.