{"id":13698585,"url":"https://github.com/percona/rds_exporter","last_synced_at":"2025-05-04T03:31:40.329Z","repository":{"id":40625757,"uuid":"108108265","full_name":"percona/rds_exporter","owner":"percona","description":"AWS RDS exporter for Prometheus","archived":false,"fork":true,"pushed_at":"2024-03-07T14:13:48.000Z","size":15024,"stargazers_count":126,"open_issues_count":13,"forks_count":85,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-04-09T02:58:07.952Z","etag":null,"topics":["hacktoberfest","pmm"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Technofy/cloudwatch_exporter","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/percona.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-24T09:54:18.000Z","updated_at":"2024-03-19T08:21:50.000Z","dependencies_parsed_at":"2023-02-14T08:17:12.252Z","dependency_job_id":null,"html_url":"https://github.com/percona/rds_exporter","commit_stats":null,"previous_names":["percona-lab/rds_exporter"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2Frds_exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2Frds_exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2Frds_exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percona%2Frds_exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/percona","download_url":"https://codeload.github.com/percona/rds_exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224383684,"owners_count":17302243,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","pmm"],"created_at":"2024-08-02T19:00:50.299Z","updated_at":"2024-11-13T03:31:14.740Z","avatar_url":"https://github.com/percona.png","language":"Go","funding_links":[],"categories":["Exporters"],"sub_categories":["Percona"],"readme":"# RDS Exporter\n\n[![Release](https://img.shields.io/github/release/percona/rds_exporter.svg?style=flat)](https://github.com/percona/rds_exporter/releases/latest)\n[![Go Report Card](https://goreportcard.com/badge/github.com/percona/rds_exporter)](https://goreportcard.com/report/github.com/percona/rds_exporter)\n[![CLA assistant](https://cla-assistant.percona.com/readme/badge/percona/rds_exporter)](https://cla-assistant.percona.com/percona/rds_exporter)\n[![codecov.io Code Coverage](https://img.shields.io/codecov/c/github/percona/rds_exporter.svg?maxAge=2592000)](https://codecov.io/github/percona/rds_exporter?branch=main)\n\nAn [AWS RDS](https://aws.amazon.com/ru/rds/) exporter for [Prometheus](https://github.com/prometheus/prometheus).\nIt gets metrics from both [basic CloudWatch Metrics](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MonitoringOverview.html)\nand [RDS Enhanced Monitoring via CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html).\n\n## Quick start\n\nCreate configration file `config.yml`:\n\n```yaml\n---\ninstances:\n  - region: us-east-1\n    instance: rds-aurora1\n\n  - region: us-east-1\n    instance: rds-mysql57\n    aws_access_key: AKIAIOSFODNN7EXAMPLE\n    aws_secret_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\n    aws_role_arn: arn:aws:iam::76784568345:role/my-role\n    disable_basic_metrics: true\n    disable_enhanced_metrics: false\n    labels:\n      foo: bar\n      baz: qux\n```\n\nIf `aws_role_arn` is present it will assume role otherwise if `aws_access_key` and `aws_secret_key` are present, they are used for that instance.\nOtherwise, [default credential provider chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials)\nis used, which includes `AWS_ACCESS_KEY_ID`/`AWS_ACCESS_KEY` and `AWS_SECRET_ACCESS_KEY`/`AWS_SECRET_KEY` environment variables, `~/.aws/credentials` file,\nand IAM role for EC2.\n\nReturned metrics contain `instance` and `region` labels set. They also contain extra labels specified in the configuration file.\n\nStart exporter by running:\n```\nrds_exporter\n```\n\nTo see all flags run:\n```\nrds_exporter --help\n```\n\nConfigure Prometheus:\n\n```yaml\n---\nscrape_configs:\n  - job_name: rds-basic\n    scrape_interval: 60s\n    scrape_timeout: 55s\n    metrics_path: /basic\n    honor_labels: true\n    static_configs:\n      - targets:\n        - 127.0.0.1:9042\n\n  - job_name: rds-enhanced\n    scrape_interval: 10s\n    scrape_timeout: 9s\n    metrics_path: /enhanced\n    honor_labels: true\n    static_configs:\n      - targets:\n        - 127.0.0.1:9042\n```\n\n`honor_labels: true` is important because exporter returns metrics with `instance` label set.\n\n## Metrics\n\nExporter synthesizes [node_exporter](https://github.com/prometheus/node_exporter)-like metrics where possible.\n\nYou can see a list of basic monitoring metrics [there](https://github.com/percona/rds_exporter/blob/main/basic/testdata/all.txt)\nand a list of enhanced monitoring metrics in text files [there](https://github.com/percona/rds_exporter/tree/main/enhanced/testdata).\n\n## Cost\nAmazon charges for every CloudWatch API request, see the [current charges](http://aws.amazon.com/cloudwatch/pricing/).\n\nEvery metric retrieved requires one API request, which can include multiple statistics.\n\nIf you have 100 API requests every minute, with the price of $10 per million requests (as of Aug 2018), that is around $45 per month. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona%2Frds_exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercona%2Frds_exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona%2Frds_exporter/lists"}