🔎 Prometheus Service Discovery for AWS RDS

Discover and monitor your AWS RDS clusters effortlessly with this Golang Prometheus HTTP ServiceDiscovery tool. 🚀
This service solves issues in case you have RDS autoscaling, and you need to measure metrics per instance (user cpu time, number of connections etc).

Pre-built docker image is available on Docker Hub currently supporting ARM architecture.
If you need a different architecture, please open an issue.

Table of Contents

1. Setup
2. HTTP Endpoints
3. IAM Permissions
4. Example Usage

---

Setup

Before you start monitoring your AWS RDS clusters, follow these steps to set up the service discovery:

1. Define the port on which you want to run your app by setting the $PORT environment variable. The default fallback port is 8080.
2. Ensure AWS credentials are properly configured if needed. (This service is ECS and EKS ready, so container credentials can also be used.)

To configure clusters for discovery, follow this naming convention:

• SCRAPER_0_CLUSTER_ARN=arn:aws:rds:<aws-region>:<aws-account-id>:cluster:<cluster-identify>
• SCRAPER_1_CLUSTER_ARN=arn:aws:rds:<aws-region>:<aws-account-id>:cluster:<cluster-identify>

You can configure N scraper clusters by incrementing the number in the middle of the environment variable name. This service supports multi-region and multi-account clusters discovery.

---

HTTP Endpoints

This service provides the following HTTP endpoints:

• /.health: Use this endpoint for health checks.
• /discovery: This endpoint provides Prometheus HTTP-SD compatible output in JSON format.

---

IAM Permissions

Ensure your service has the necessary IAM permissions to function correctly.
You should grant the DescribeDBInstances permission in the specific AWS region where your RDS clusters are located.

data "aws_iam_policy_document" "rds_service_discovery" {
  statement {
    actions = [
      "rds:DescribeDBInstances",
    ]

    resources = [
      "*"
    ]
  }
}

---

Example Usage

Usage with Prometheus Postgres Exporter

- job_name: 'rds'
  metrics_path: /probe
  params:
    auth_module: [internal]
  http_sd_configs:
  - url: http://rds-service-discovery:3000/discovery
  relabel_configs:
    - source_labels: [__address__]
      target_label: __param_target
    - source_labels: [__param_target]
      target_label: instance
    - target_label: __address__
      replacement: 'pg_exporter.svc.cluster.local'