Versions:

Integrate Timescale Cloud services with third-party monitoring tools

You can export your service telemetry to a third-party monitoring tool, such as Datadog or AWS CloudWatch. Exported metrics include CPU usage, RAM usage, and storage.

Export telemetry data to Datadog

Export telemetry data to Datadog by:

  1. Creating a data exporter
  2. Attaching your database service to the exporter

important

Your exporter must be in the same AWS region as your database service. If you have databases in multiple regions, you can create multiple exporters.

Creating a data exporter for Datadog

  1. In the Timescale Cloud console, navigate to Integrations.
  2. Click Create exporter.
  3. Under Choose a provider, choose Datadog.
  4. Choose an AWS region for your exporter to live within Timescale Cloud. The exporter is only available to database services in the same AWS region.
  5. Name your exporter. This name appears in the Cloud console, so choose a descriptive name.
  6. Add a Datadog API key. If you don't have an API key yet, you can create one by following the instructions in the Datadog documentation.
  7. Under Site, choose your Datadog region. You can choose a region to meet any regulatory requirements or application needs you might have.
  8. Click Create exporter.

Attaching a Datadog data exporter to a service

Once you create a data exporter, you can attach it to a service. The exporter then exports that service's telemetry data.

You can only have one exporter per service.

important

Your exporter must be in the same AWS region as your database service. If you have databases in multiple regions, you can create multiple exporters.

  1. Navigate to Services. Click on the service you want to connect to your exporter.
  2. Navigate to Operations, then Integrations.
  3. Select and add an exporter.

You can now monitor your service metrics from the metrics explorer in Datadog. For more information, see the Datadog documentation.

When you have set up your integration, you can check that it is working correctly by looking for the metrics that Timescale Cloud exports. The metric names are:

  • timescale.cloud.system.cpu.usage.millicores
  • timescale.cloud.system.cpu.total.millicores
  • timescale.cloud.system.memory.usage.bytes
  • timescale.cloud.system.memory.total.bytes
  • timescale.cloud.system.disk.usage.bytes
  • timescale.cloud.system.disk.total.bytes

Additionally, Timescale Cloud exports tags that you can use to filter your results. You can also check that these tags are being correctly exported:

TagExample variableDescription
hostus-east-1.timescale.cloud
project-id
service-id
regionus-east-1Timescale Cloud region
rolereplica or primaryFor services with replicas
node-idFor multi-node services

Export telemetry data to AWS CloudWatch

Export telemetry data to AWS CloudWatch by:

  1. Creating a data exporter
  2. Attaching your database service to the exporter

important

Your exporter must be in the same AWS region as your database service. If you have databases in multiple regions, you can create multiple exporters.

Creating a data exporter for AWS CloudWatch

  1. In the Timescale Cloud console, navigate to Integrations.
  2. Click Create exporter.
  3. Under Choose a provider, choose AWS CloudWatch.
  4. Choose an AWS region for your exporter to live within Timescale Cloud. The exporter is only available to database services in the same AWS region.
  5. Name your exporter. This name appears in the Cloud console, so choose a descriptive name.
  6. Define names for your CloudWatch log group, log stream, and namespace. If you're uncertain, use the default values. For more information on naming log groups and logs streams, see the AWS CloudWatch docs.
  7. Enter your AWS credentials. To get your AWS keys, you need to create a new Identity and Access Management (IAM) user in your AWS console. Make sure your new user has restricted access to only Cloudwatch, and keep your keys secret. For instructions, see the AWS documentation.
  8. Select an AWS Region for your CloudWatch instance.
  9. OPTIONAL Define an IAM role to use for uploading metrics. Having a dedicated role with only CloudWatch permissions is a recommended security practice.
  10. Click Create exporter.

warning

AWS keys give access to your AWS services. To keep your AWS account secure, restrict users to the minimum required permissions. Always store your keys in a safe location.

Attaching a CloudWatch data exporter to a service

Once you create a data exporter, you can attach it to a service. The exporter then exports that service's telemetry data.

You can only have one exporter per service.

important

Your exporter must be in the same AWS region as your database service. If you have databases in multiple regions, you can create multiple exporters.

  1. Navigate to Services. Click on the service you want to connect to your exporter.
  2. Navigate to Operations, then Integrations.
  3. Select and add an exporter.

You can now query your service metrics from the CloudWatch metrics page in AWS Console. For more information, see the CloudWatch documentation.

When you have set up your integration, you can check that it is working correctly by looking for the metrics that Timescale Cloud exports. The metric names are:

  • timescale.cloud.system.cpu.usage.millicores
  • timescale.cloud.system.cpu.total.millicores
  • timescale.cloud.system.memory.usage.bytes
  • timescale.cloud.system.memory.total.bytes
  • timescale.cloud.system.disk.usage.bytes
  • timescale.cloud.system.disk.total.bytes

Additionally, Timescale Cloud exports tags that you can use to filter your results. You can also check that these tags are being correctly exported:

TagExample variableDescription
hostus-east-1.timescale.cloud
project-id
service-id
regionus-east-1Timescale Cloud region
rolereplica or primaryFor services with replicas
node-idFor multi-node services

Edit a data exporter

You can edit a data exporter after you create it. Some fields, such as the provider and AWS region, can't be changed.

Editing a data exporter

  1. Navigate to Integrations.
  2. Beside the exporter you want to edit, click the menu button. Click Edit.
  3. Edit the exporter fields and save your changes.

Delete a data exporter

Delete any data exporters that you no longer need.

Deleting a data exporter

  1. Before deleting a data exporter, remove all connected services.
  2. For each connected service, navigate to the service Operations tab.
  3. Click Integrations.
  4. Click the trash can icon to remove the exporter from the service. This doesn't delete the exporter itself.
  5. In the main menu, navigate to Integrations.
  6. Beside the exporter you want to delete, click the menu button. Click Delete.
  7. Confirm that you want to delete.

Found an issue on this page?

Report an issue!

Keywords

Related Content