{ "info": { "author": "Jim Lamb", "author_email": "jim.lamb@airwalkconsulting.com", "bugtrack_url": null, "classifiers": [], "description": "# Prometheus exporter for AWS Config\n\n## Credits\n\nHeavily based upon [Spreaker's Guard Duty exporter]( https://github.com/spreaker/prometheus-aws-guardduty-exporter)\n\n## Features\n\n- Exports the number of compliant and non-compliant resources from AWS Config, labelled by region and resource type\n- Supports multiple AWS regions\n\n\n## Exported metrics\n\nThe exporter exports the following metrics:\n\n| Metric name | Type | Labels | Description |\n| ----------------------------------- | -------- | ------------------------ |------------------------------------------------------------- |\n| `aws_config_exporter_up` | gauge | _None_ | Always `1`: can be used to check if the exporter is running |\n| `aws_config_current_resources` | guage | `region`,`resource_type` | The total number of resources recorded by AWS Config |\n| `aws_config_compliant_resources` | guage | `region`,`resource_type` | The number of compliant resources recorded by AWS Config |\n| `aws_config_noncompliant_resources` | guage | `region`,`resource_type` | The number of non-compliant resources recorded by AWS Config |\n| `aws_config_scrape_errors_total` | counter | `region` | The total number of scrape errors |\n\n## How to run it\n\nYou have two options to run it:\n\n1. Manually install and run the [`prometheus-aws-configservice-exporter` Python package](https://pypi.org/project/prometheus-aws-configservice-exporter/)\n ```\n pip3 install prometheus-aws-configservice-exporter\n\n prometheus-aws-configservice-exporter --region us-east-1\n ```\n\n2. Use the [Docker image available on Docker hub](https://hub.docker.com/r/airwalkconsulting/prometheus-aws-configservice-exporter/)\n ```\n docker run --env AWS_ACCESS_KEY_ID=\"id\" --env AWS_SECRET_ACCESS_KEY=\"secret\" airwalkconsulting/prometheus-aws-configservice-exporter --region us-east-1\n ```\n\nThe cli supports the following arguments:\n\n| Argument | Required | Description |\n| ------------------------------ | -------- | ----------- |\n| `--region REGION [REGION ...]` | yes | AWS Config region (can specify multiple space separated regions) |\n| `--throttle SECONDS` | | The number of seconds to wait between AWS Config API requests. Float, eg `0.5`. Defaults to `1.0` |\n| `--exporter-host` | | The host at which the Prometheus exporter should listen to. Defaults to `127.0.0.1` |\n| `--exporter-port` | | The port at which the Prometheus exporter should listen to. Defaults to `9100` |\n| `--log-level LOG_LEVEL` | | Minimum log level. Accepted values are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`. Defaults to `INFO` |\n\n\n## Required IAM privileges\n\nIn order to successfully run, this application requires the following IAM privileges:\n\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"ConfigServiceGetOnly\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"config:Get*\",\n ],\n \"Resource\": \"*\"\n }\n ]\n}\n```\n\n\n## Development\n\nRun the development environment:\n\n```\ndocker-compose build dev && docker-compose run --rm dev\n```\n\nRun tests in the dev environment (Warning: See TODO.md):\n\n```\npython3 -m unittest\n```\n\n\n## License\n\nThis software is released under the [MIT license](LICENSE.txt).", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/AirWalk-Digital/prometheus-aws-configservice-exporter/archive/1.0.7.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/AirWalk-Digital/prometheus-aws-configservice-exporter", "keywords": "prometheus,aws,config,configservice", "license": "", "maintainer": "", "maintainer_email": "", "name": "prometheus-aws-configservice-exporter", "package_url": "https://pypi.org/project/prometheus-aws-configservice-exporter/", "platform": "", "project_url": "https://pypi.org/project/prometheus-aws-configservice-exporter/", "project_urls": { "Download": "https://github.com/AirWalk-Digital/prometheus-aws-configservice-exporter/archive/1.0.7.tar.gz", "Homepage": "https://github.com/AirWalk-Digital/prometheus-aws-configservice-exporter" }, "release_url": "https://pypi.org/project/prometheus-aws-configservice-exporter/1.0.7/", "requires_dist": null, "requires_python": ">= 3", "summary": "Prometheus exporter for AWS Config", "version": "1.0.7" }, "last_serial": 5708283, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "ab34e4602fed34c0c35499b1ef48b46b", "sha256": "72b49fa221ba989e2e70898ab9c72fd4b35062978341609fe91a4f5b8cb0c105" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.0.tar.gz", "has_sig": false, "md5_digest": "ab34e4602fed34c0c35499b1ef48b46b", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4754, "upload_time": "2019-08-15T15:47:56", "url": "https://files.pythonhosted.org/packages/ad/29/9d22349de3e2e26a78cef298ea3db98ce69ff8c4f623337d807cf040a970/prometheus-aws-configservice-exporter-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "cc8a24a3a4edd67f41315ce6947b06ef", "sha256": "94c0bac9016a99a654bd4599f9585b23c63130ba71328a5e33a2887e50fe734d" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.1.tar.gz", "has_sig": false, "md5_digest": "cc8a24a3a4edd67f41315ce6947b06ef", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4752, "upload_time": "2019-08-15T15:52:56", "url": "https://files.pythonhosted.org/packages/cc/3e/66d615a920433f550bfae327147a0d506ab4f4216436a84d6982bd806d93/prometheus-aws-configservice-exporter-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "72e210b41c431307360168dc81d87050", "sha256": "709b3d34fb62aec7e70871ce04cd536ef59871db5c9469bddceb2fe1c95c24c5" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.2.tar.gz", "has_sig": false, "md5_digest": "72e210b41c431307360168dc81d87050", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4813, "upload_time": "2019-08-16T08:40:03", "url": "https://files.pythonhosted.org/packages/58/bb/2d779bb0d726dcf5dd90a83430c2cc8d9adb6deb7be917b0ab3950654a66/prometheus-aws-configservice-exporter-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "1bd5b460d8a5ac34a0ed014bbd1947a6", "sha256": "b694104d1a266dfc32daaa0b7871eac844550953135135adbeb6ab7c6d88df8c" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.3.tar.gz", "has_sig": false, "md5_digest": "1bd5b460d8a5ac34a0ed014bbd1947a6", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4813, "upload_time": "2019-08-16T14:52:24", "url": "https://files.pythonhosted.org/packages/f0/b1/eb11d7b239b9ff7402d0594d16f37d70d17c71211c3daa35977aea3702fb/prometheus-aws-configservice-exporter-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "4d2479ae097073ed307218668c7c85f3", "sha256": "66c5d9936347ff8df7f1be55c238d6090ed33fa52af36b9494a35684c2b47d77" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.4.tar.gz", "has_sig": false, "md5_digest": "4d2479ae097073ed307218668c7c85f3", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4808, "upload_time": "2019-08-19T09:57:15", "url": "https://files.pythonhosted.org/packages/47/69/6a7fae1f2c655df93ecad41d2cadfd2aad8951b2166997314e744d54fd04/prometheus-aws-configservice-exporter-1.0.4.tar.gz" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "d3affc45717aedafbf5cdeae828d6a37", "sha256": "15bd1371f19325f64bd83211b89a72184c255fa8c742e48c8d1cd830e03c08f1" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.5.tar.gz", "has_sig": false, "md5_digest": "d3affc45717aedafbf5cdeae828d6a37", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4808, "upload_time": "2019-08-20T08:37:35", "url": "https://files.pythonhosted.org/packages/a3/29/350a2459e4094f87ce3968369e451a5f6ae2904c02a79d10140bcc79a0b4/prometheus-aws-configservice-exporter-1.0.5.tar.gz" } ], "1.0.6": [ { "comment_text": "", "digests": { "md5": "26310f201466892b042c563aa0764cec", "sha256": "1a24187ac86df1db04896727b120f02d14e1f8eb038421f40a6351450ab9e9a3" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.6.tar.gz", "has_sig": false, "md5_digest": "26310f201466892b042c563aa0764cec", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4941, "upload_time": "2019-08-20T14:49:28", "url": "https://files.pythonhosted.org/packages/ea/dc/bb20c4d28dd7ad126d4142bfe0b5e08177f39205571a2b189aa6f206a1ce/prometheus-aws-configservice-exporter-1.0.6.tar.gz" } ], "1.0.7": [ { "comment_text": "", "digests": { "md5": "194ae063827546f2afa8d3613e68d84f", "sha256": "c36544abda47e3775e37a4669fd4cce27255a632acd317e3a8fb66f8ddca2a1e" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.7.tar.gz", "has_sig": false, "md5_digest": "194ae063827546f2afa8d3613e68d84f", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4946, "upload_time": "2019-08-21T09:50:57", "url": "https://files.pythonhosted.org/packages/eb/de/c3ad1927db3c42084d3155c9aac9815121aad14c17b39876b51522c8cedb/prometheus-aws-configservice-exporter-1.0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "194ae063827546f2afa8d3613e68d84f", "sha256": "c36544abda47e3775e37a4669fd4cce27255a632acd317e3a8fb66f8ddca2a1e" }, "downloads": -1, "filename": "prometheus-aws-configservice-exporter-1.0.7.tar.gz", "has_sig": false, "md5_digest": "194ae063827546f2afa8d3613e68d84f", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4946, "upload_time": "2019-08-21T09:50:57", "url": "https://files.pythonhosted.org/packages/eb/de/c3ad1927db3c42084d3155c9aac9815121aad14c17b39876b51522c8cedb/prometheus-aws-configservice-exporter-1.0.7.tar.gz" } ] }