prometheus-rds-exporter

packaged by Chainguard

Chainguard Container for prometheus-rds-exporter

Prometheus exporter for AWS RDS

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/prometheus-rds-exporter:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The prometheus-rds-exporter image is comparable to the upstream image public.ecr.aws/qonto/prometheus-rds-exporter, and is designed to be a drop-in replacement for it. It keeps the upstream entrypoint /app/prometheus-rds-exporter, the /app working directory, and the non-root exporter user (UID 1001, GID 1001) with its home directory at /app.

The image differs from upstream in the following ways:

• The image contains only the exporter, CA certificates, and their runtime dependencies, with no shell or package manager.
• To debug interactively, use the -dev variant, which includes a shell.

Getting Started

The exporter collects AWS RDS instance metrics, CloudWatch metrics, and service quotas, and publishes them on port 9043 at /metrics. It needs AWS credentials with read access to RDS, CloudWatch, EC2, Service Quotas, and the Resource Groups Tagging API.

To run the exporter locally with credentials from your environment:

docker run -d -p 9043:9043 \
  -e AWS_REGION=eu-west-1 \
  -e AWS_ACCESS_KEY_ID \
  -e AWS_SECRET_ACCESS_KEY \
  cgr.dev/ORGANIZATION/prometheus-rds-exporter:latest

Because the exporter user's home directory is /app, you can also mount an AWS shared configuration directory. The mounted files must be readable by UID 1001:

docker run -d -p 9043:9043 \
  -e AWS_PROFILE=default \
  -v $HOME/.aws:/app/.aws:ro \
  cgr.dev/ORGANIZATION/prometheus-rds-exporter:latest

Then query the metrics endpoint:

curl http://localhost:9043/metrics

To deploy with the upstream Helm chart, first create a secret that holds the AWS credentials:

kubectl create secret generic rds-exporter-aws \
  --from-literal=AWS_ACCESS_KEY_ID="$AWS_ACCESS_KEY_ID" \
  --from-literal=AWS_SECRET_ACCESS_KEY="$AWS_SECRET_ACCESS_KEY"

Create a values file that points the chart at the Chainguard image and references that secret. The chart enables a ServiceMonitor by default, which requires the Prometheus Operator CRDs, so this example turns it off:

cat > values.yaml <<EOF
image:
  repository: cgr.dev/ORGANIZATION/prometheus-rds-exporter
  tag: latest
env:
  AWS_REGION: eu-west-1
awsCredentialsSecret: rds-exporter-aws
serviceMonitor:
  enabled: false
EOF

Install the chart with the values file:

helm install rds-exporter \
  oci://public.ecr.aws/qonto/prometheus-rds-exporter-chart \
  --values values.yaml

On Amazon EKS, you can use IAM roles for service accounts instead of a credentials secret. Omit awsCredentialsSecret and add the role ARN under serviceAccount.annotations with the eks.amazonaws.com/role-arn key.

Configuration

Run docker run --rm cgr.dev/ORGANIZATION/prometheus-rds-exporter:latest --help to list the command-line flags, such as --collect-instance-metrics and --collect-quotas. These flags turn individual collectors on or off. The exporter also reads standard AWS SDK environment variables such as AWS_REGION, AWS_PROFILE, and AWS_ROLE_ARN.

The exporter serves Prometheus metrics over HTTP on port 9043/tcp.

Documentation and Resources

• Prometheus RDS Exporter documentation
• Chainguard Academy

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.