> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/internal-developer-portal/3.0/use-idp/plugins/available-plugins/datadog.md).

# Datadog

| Plugin details |                                                                                                                    |
| -------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Created by** | [RoadieHQ](https://github.com/RoadieHQ)                                                                            |
| **Category**   | Monitoring                                                                                                         |
| **Source**     | [GitHub](https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-datadog) |
| **Type**       | Open-source plugin                                                                                                 |

### Configuration <a href="#configuration" id="configuration"></a>

#### Application configuration YAML <a href="#application-configuration-yaml" id="application-configuration-yaml"></a>

*No action required*

* This is a frontend plugin without any authentication configured hence no configuration required.

#### Secrets <a href="#secrets" id="secrets"></a>

* No secrets are required for this plugin as there are no authentication configured.

### Layout <a href="#layout" id="layout"></a>

*No action required*

This plugin exports a UI tab that you can use as a new **Datadog** tab for a service or for any other layout page. The following configuration is set by default in **Layout** under **Configure** for **Service** and you do not need to change anything:

```yaml
    - name: EntityDatadogContent
      path: /datadog
      title: Datadog
      contents:
        - component: EntityDatadogContent
```

This plugin exports the `EntityDatadogGraphCard` that you can show on the **Overview** tab of a service or any other layout page. The following configuration is set by default in **Layout** under **Configure** for **Service** and you do not need to change anything:

```yaml
- component: EntityDatadogGraphCard
```

### Annotations <a href="#annotations" id="annotations"></a>

To configure the plugin for a service in the software catalog, you need to add specific annotations to its `catalog-info.yaml` definition file. Below are the steps to configure these annotations.

#### Embed a Datadog dashboard in Backstage <a href="#embed-a-datadog-dashboard-in-backstage" id="embed-a-datadog-dashboard-in-backstage"></a>

**Steps to get the dashboard URL**

1. Navigate to the dashboards list by hovering over **Dashboards** on the page’s left-hand side and selecting **Dashboard List**.
2. Select a dashboard from this list.
3. Within the chosen dashboard, click the Settings cog on the right-hand side of the screen, circled in red.
4. Copy the URL from the **Sharing** text box.
5. Use this URL as the value for the `datadoghq.com/dashboard-url` annotation.

Add the annotations and the values from Datadog to your component’s metadata file.

```yaml
## Example catalog-info.yaml <a href="#example-catalog-infoyaml" id="example-catalog-infoyaml"></a>
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: sample-service
  description: |
    A sample service
  annotations:
    datadoghq.com/site: datadoghq.com ## non-default top level domain
    datadoghq.com/dashboard-url: <<DATADOGURL>>
...
```

{% hint style="info" %}

#### Set the Datadog domain <a href="#set-the-datadog-domain" id="set-the-datadog-domain"></a>

By default, the Datadog embedded graph uses `datadoghq.eu` as its top-level domain unless specified otherwise. If you are using a different domain, you must specify it using the `datadoghq.com/site annotation`.

```yaml
...
datadoghq.com/site: datadoghq.com
...
```

{% endhint %}

### Support <a href="#support" id="support"></a>

The plugin is owned by Roadie and managed in this [repository](https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-datadog) as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.