667a402226
* Create user facing documentation Create a docs/ directory with user facing documentation. This covers getting started, running with docker, specifying secrets, configuration, and database permissions. This is all focused on the perspective of a user or someone deploying the exporter. Signed-off-by: Joe Adams <github@joeadams.io> * Update getting started to show multiple options Clean up duplication on docker commands. Make the docs README more useful as a standalone page. Signed-off-by: Joe Adams <github@joeadams.io> * Update configuration docs Add more details on each flag and collector to help the user understand the purpose. Signed-off-by: Joe Adams <github@joeadams.io> * Add frontmatter Signed-off-by: Joe Adams <github@joeadams.io> * Review feedback Remove deprecated option doc and /-/reload endpoint (unimplemented). Signed-off-by: Joe Adams <github@joeadams.io> * Add 2 new flags in user docs configuration Signed-off-by: Joe Adams <github@joeadams.io> * Fix docs link Signed-off-by: Joe Adams <github@joeadams.io> * Fix correctness in docs Signed-off-by: Joe Adams <github@joeadams.io> --------- Signed-off-by: Joe Adams <github@joeadams.io>
1.7 KiB
title, nav_title, sort_rank
| title | nav_title | sort_rank |
|---|---|---|
| Running Against AWS RDS | AWS RDS | 8 |
Running Against AWS RDS
RDS is a managed PostgreSQL service, so you don't have superuser access — a few things need to be set up differently than on a self-managed server.
Excluded database and role
rdsadmin is an RDS-internal database and role you can't (and shouldn't) query. Point DATA_SOURCE_NAME at your actual database (e.g. postgres), same as any other target — see Connecting to PostgreSQL. If you use the deprecated --auto-discover-databases flag to scrape every database on the instance, exclude it with PG_EXPORTER_EXCLUDE_DATABASES=rdsadmin.
Permissions
Follow the standard non-superuser database permissions setup, granting pg_monitor to your exporter role. Since you don't have a true superuser on RDS, run the grant as your RDS master user, and grant the exporter role to the master user first if needed (see the note in database-permissions.md).
pg_stat_statements
To use the stat_statements collector, pg_stat_statements must be preloaded via the RDS parameter group, not just created as an extension:
- In the RDS parameter group attached to your instance, ensure that the pg_stat_statements extension is preloaded:
shared_preload_libraries = "pg_stat_statements" - Reboot the RDS instance for the change to take effect.
- Then
CREATE EXTENSION pg_stat_statements;as usual.
pg_stat_statements rows include queries run by RDS's own rdsadmin role. Exclude them with --collector.stat_statements.exclude_users=rdsadmin.