Tutorials

Tutorial: How to Set Up a Prometheus Endpoint for a Timescale Cloud Database

You can get more insights into the performance of your Timescale Cloud database by monitoring it using Prometheus, a popular open-source metrics-based systems monitoring solution. This tutorial will take you through setting up a Prometheus endpoint for a database running in Timescale Cloud. To create a monitoring system to ingest and analyze Prometheus metrics from your Timescale Cloud instance, see this tutorial

This will expose metrics from the node_exporter as well as pg_stats metrics.

Prerequisites

In order to proceed with this tutorial, you will need a Timescale Cloud database. To create one, see these instructions for how to get started with Timescale Cloud

Step 1: Enable Prometheus Service Integration

In the navigation bar, select ‘Service Integrations’. Navigate to the service integrations, pictured below.

Service Integrations Menu Option

This will present you with the option to add a Prometheus integration point. Select the plus icon to add a new endpoint and give it a name of your choice. We’ve named ours endpoint_dev.

Create a Prometheus endpoint on Timescale Cloud

Furthermore, notice that you are given basic authentication information and a port number in order to access the service. This will be used when setting up your Prometheus installation, in the prometheus.yml configuration file. This will enable you to make this Timescale Cloud endpoint a target for Prometheus to scrape.

Here’s a sample configuration file you can use when you setup your Prometheus installation, substituting the target port, IP address, username, and password for those of your Timescale Cloud instance:

  1. # prometheus.yml for monitoring a Timescale Cloud instance
  2. global:
  3.  scrape_interval:     10s
  4.  evaluation_interval: 10s
  5. scrape_configs:
  6.  - job_name: prometheus
  7.    scheme: https
  8.    static_configs:
  9.      - targets: ['{TARGET_IP}:{TARGET_PORT}']
  10.    tls_config:
  11.      insecure_skip_verify: true
  12.    basic_auth:
  13.      username: {ENDPOINT_USERNAME}
  14.      password: {ENDPOINT_PASSWORD}
  15. remote_write:
  16.  - url: "http://{ADAPTER_IP}:9201/write"
  17. remote_read:
  18.  - url: "http://{ADAPTER_IP}:9201/read"

Step 2: Associate Prometheus Endpoint with Managed Service

Next, we want to associate our Prometheus endpoint with our Timescale Cloud service. Using the navigation menu, select the service we want to monitor and click the ‘Overview’ tab.

Navigate down to the ‘Service Integrations’ section and click the ‘Manage Integrations’ button.

Manage Service integrations on your managed service

Find the Prometheus integration option and select ‘Use Prometheus’.

Select Prometheus integration to integrate with

Next, select the endpoint name you created in Step 1 as the endpoint you’d like to use with this service and then click the ‘Enable’ button. It’s possible to use the same endpoint for multiple services or a separate one for services you’d like to keep apart.

Select name of Prometheus endpoint to integrate with

To check if this was successful, navigate back to the Service Integrations section of your managed service, and check if that “Active” flag appears, along with the name of the endpoint you associated the service with.

Success! Active prometheus endpoint with name

Congratulations, you have successfully set up a Prometheus endpoint on your managed service on Timescale Cloud!

Next Steps

Next, create a monitoring system using Timescale, Grafana, and Prometheus to ingest and analyze Prometheus metrics from your Timescale Cloud instance.