Metrics and Datadog

Datadog is a popular cloud-based monitoring service. You can send metrics to Datadog using a metrics collection agent for graphing, service dashboards, alerting, and logging. Managed Service for TimescaleDB can send data directly to Datadog for monitoring. Datadog integrations are provided free of charge on Managed Service for TimescaleDB.

You need to create a Datadog API key, and use the key to enable metrics for your Managed Service for TimescaleDB service.

note

We do not currently support Datadog logging on Managed Service for TimescaleDB.

Create and upload a Datadog API key

You can create an API key in your Datadog account, and upload it to your Managed Service for TimescaleDB account.

important

Before you begin, you need to have signed up for both Datadog and Managed Service for TimescaleDB, and be able to log in to your Datadog and Managed Service for TimescaleDB dashboards. You also need a running Managed Service for TimescaleDB service.

Procedure: Creating a Datadog API key

  1. Log in to your Datadog dashboard and navigate to Integrations → APIs. Click API Keys.
  2. In the New API key field, type a name for your new key. For example, TimescaleDB. Click Create API Key.
  3. Hover your mouse over the purple bar in the Key field to see the key, and copy it to use later.

Procedure: Uploading a Datadog API key to MST

  1. Log in to your Managed Service for TimescaleDB. By default, you start in the Services view, showing any services you currently have in your project.
  2. Check that you are in the project that you want to connect to Datadog, and click Service Integrations.
  3. In the Datadog section, click Add endpoint, and complete these details:
    • In the Endpoint integration section, give your endpoint a name, and paste the API key from your Datadog dashboard. Ensure you choose the site location that matches where your Datadog service is hosted.
    • Optional: In the Endpoint tags section, you can add custom tags to help you manage your integrations.
  4. Click Add endpoint to save the integration.

Activate Datadog integration for a service

When you have successfully added the endpoint, you can set up one of your services to send data to Datadog.

Procedure: Activating Datadog integration for a service

  1. In the Managed Service for TimescaleDB Services view, click the name of the service that you want to connect to Datadog.
  2. In the Service integrations section, click Manage integrations. Locate the Datadog integration, and click Use integration.
  3. In the Datadog integration dialog, select the Datadog endpoint you created earlier, and click Enable. If the connection is successful, the Datadog integration shows with a green active symbol.

Datadog dashboards

When you have your Datadog integration set up successfully, you can use the Datadog dashboard editor to configure your visualizations. See the Datadog Dashboard documentation for more information.

Found an issue on this page?

Report an issue!

Related Content