diff options
Diffstat (limited to 'doc/integration/datadog.md')
| -rw-r--r-- | doc/integration/datadog.md | 67 |
1 files changed, 43 insertions, 24 deletions
diff --git a/doc/integration/datadog.md b/doc/integration/datadog.md index 38ff004a203..e06cca19e60 100644 --- a/doc/integration/datadog.md +++ b/doc/integration/datadog.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -8,25 +8,44 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270123) in GitLab 14.1 -This integration allows sending CI/CD pipeline and job information to [Datadog](https://www.datadoghq.com/) for monitoring and troubleshooting of job failures and performance issues using the [CI Visibility](https://app.datadoghq.com/ci) product. - -You can find out more information on [Datadog's CI Visibility documentation site](https://docs.datadoghq.com/continuous_integration/). - -## How to configure it - -The integration is based on [Webhooks](../user/project/integrations/webhooks.md) and it only requires setup on GitLab. - -Configure the integration on a project or group by going to **Settings > Integrations > Datadog** for each project or group you want to instrument. You can also activate the integration for the entire GitLab instance. - -Fill in the integration configuration settings: - -- `Active` enables the integration. -- `Datadog site` specifies which [Datadog site](https://docs.datadoghq.com/getting_started/site/) to send data to. -- `API URL` (optional) allows overriding the API URL used for sending data directly, only used in advanced scenarios. -- `API key` specifies which API key to use when sending data. You can generate one in the [APIs tab](https://app.datadoghq.com/account/settings#api) of the Integrations section on Datadog. -- `Service` (optional) specifies which service name to attach to each span generated by the integration. Use this to differentiate between GitLab instances. -- `Env` (optional) specifies which environment (`env` tag) to attach to each span generated by the integration. Use this to differentiate between groups of GitLab instances (i.e. staging vs production). - -You can test the integration with the `Test settings` button. After it’s successful, click `Save changes` to finish the integration set up. - -Data sent by the integration will be available in the [CI Visibility](https://app.datadoghq.com/ci) section of your Datadog account. +This integration enables you to send CI/CD pipeline and job information to +[Datadog](https://www.datadoghq.com/). Datadog's [CI Visibility](https://app.datadoghq.com/ci) +product helps you monitor for job failures and performance issues, then troubleshoot them. +It's based on [Webhooks](../user/project/integrations/webhooks.md), +and only requires configuration on GitLab. + +## Configure the integration + +Users with the **Administrator** role can configure the integration at the +project, group, or instance level: + +1. If you do not have a Datadog API key: + 1. Sign in to Datadog. + 1. Go to the **Integrations** section. + 1. Generate an API key in the [APIs tab](https://app.datadoghq.com/account/settings#api). + Copy this value, as you need it in a later step. +1. *For project-level or group-level integrations:* In GitLab, go to your project or group. +1. *For instance-level integrations:* + 1. Sign in to GitLab as a user with the [Administrator role](../user/permissions.md). + 1. On the top bar, select **Menu >** **{admin}** **Admin**. +1. In the left sidebar, select **Settings > Integrations**. +1. Scroll to **Add an integration**, and select **Datadog**. +1. Select **Active** to enable the integration. +1. Specify the [**Datadog site**](https://docs.datadoghq.com/getting_started/site/) to send data to. +1. (Optional) To override the API URL used to send data directly, provide an **API URL**. + Used only in advanced scenarios. +1. Provide your Datadog **API key**. +1. (Optional) If you use more than one GitLab instance, provide a unique **Service** name + to differentiate between your GitLab instances. +1. (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. +1. (Optional) Select **Test settings** to test your integration. +1. Select **Save changes**. + +When the integration sends data, you can view it in the [CI Visibility](https://app.datadoghq.com/ci) +section of your Datadog account. + +## Related links + +- [Datadog's CI Visibility](https://docs.datadoghq.com/continuous_integration/) documentation. |