Link components
To connect your Compass components with Datadog, you can either create a new component from a Datadog host or link an existing component using Datadog host data.
Create new component from heroku app
To connect your Compass components with Datadog, you can either create a new component from a Datadog host or link an existing component using Datadog host data.
Create new component from heroku app
- Go to Manage your apps → Datadog for Compass → Click on Configure
- From the list of Datadog hosts, select the host you want to connect
- Choose the appropriate Component type and assign a Team
- Click Create component
This will create a new Compass component based on the selected Datadog host.
Link Existing Components with a Datadog Host
You can manually link an existing Compass component to a Datadog host using the host's URL. Here's how:
- Go to your Compass component’s overview page
- Click the ➕ button next to Other links
- In a new browser tab, log in to your Datadog account
- Navigate to Infrastructure → Host Map or Infrastructure → Hosts
- Select the host you want to link
- On the host details page, copy the URL from your browser’s address bar
- Go back to Compass and paste the URL into the link field
- Enter a display name, such as Datadog Host – api-service
- Click Add to save the link
- After linking successfully, it will be displayed as shown below
Be careful when using the link feature if the component is already linked to a host. Changing the host will replace all associated metrics and event sources, so please ensure this action is intentional.
Insert Datadog Metrics
This plugin enables automatic pulling of metric data from Datadog and syncing it directly into Compass components, giving engineering teams a centralized and real-time view of system performance right within their development environment.
Insert Datadog Metrics
This plugin enables automatic pulling of metric data from Datadog and syncing it directly into Compass components, giving engineering teams a centralized and real-time view of system performance right within their development environment.
- Go to Manage your apps → Datadog for Compass → Click on Configure -> Metric definitions page
- Click on Create button, that on the left of the screen, to open the Create metric definition modal
- Complete the form by selecting a Datadog metric query as the Metric name, entering a Metric suffix, and optionally adding a Metric description to provide additional context
The created metrics will be showed on the table as below, you can also manage (update, delete) metrics from this table.
- Then go to Component page → Connect a metric → Select the metric name, now the metric will be synced with Datadog host that is linked with that component
Create Scorecard and links to Compass Component
Follow the Create scorecard guide to create Scorecard. You can view all scorecards that include Datadog metrics on the Metric Definitions page.
You can easilly connect Scorecards to the any components by clicking ➕ button on the table, then select the list of components from the modal.
Create Datadog monitors and track alert events in Compass
This feature using the Datadog Webhooks Integration, but you don't need to pre-install or setup anythings on that intergrations before using Compass Datadog, just follow the instructions:
This feature using the Datadog Webhooks Integration, but you don't need to pre-install or setup anythings on that intergrations before using Compass Datadog, just follow the instructions:
- Go to Datadog monitors page, click on Create button, the Create Datadog monitor modal will show up
- Complete the form by entering the monitor name, metric name, and host, which will be used to construct the monitor query
- Set the alert and warning thresholds, and ensure that the message contains the webhook name
The webhook name is required to specify which webhook configuration should be used to send data to the Compass Datadog webtrigger. This webhook is automatically created when you update the Datadog authentication configuration. It is unique to each Compass site and follows a specific format required for the application to process incoming alerts correctly.
- The recently created Datadog monitor will be listed on the table as below.
- Events will be displayed on the Component Activity page when the Datadog monitor query value exceeds the alert threshold. You can click on an event to open the corresponding Datadog monitor event page for more details.
