{ "info": { "author": "Marco Pracucci", "author_email": "marco@pracucci.com", "bugtrack_url": null, "classifiers": [], "description": "# Prometheus exporter for AWS GuardDuty\n\n\n## Features\n\n- Exports the number of current (unarchived) findings from AWS GuardDuty, splitted by region and severity\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_guardduty_exporter_up` | gauge | _None_ | Always `1`: can be used to check if it's running |\n| `aws_guardduty_current_findings` | gauge | `region`, `severity` | The current number of unarchived findings |\n| `aws_guardduty_scrape_errors_total` | counter | `region`, `severity` | The total number of scrape errors |\n\n\n## How to run it\n\nYou have two options to run it:\n\n1. Manually install and run the [`prometheus-aws-guardduty-exporter` Python package](https://pypi.org/project/prometheus-aws-guardduty-exporter/)\n ```\n pip3 install prometheus-aws-guardduty-exporter\n\n prometheus-aws-guardduty-exporter --region us-east-1\n ```\n\n2. Use the [Docker image available on Docker hub](https://hub.docker.com/r/spreaker/prometheus-aws-guardduty-exporter/)\n ```\n docker run --env AWS_ACCESS_KEY_ID=\"id\" --env AWS_SECRET_ACCESS_KEY=\"secret\" spreaker/prometheus-aws-guardduty-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 GuardDuty region (can specify multiple space separated regions) |\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\": \"ListDetectorsAndGetFindingsStatisticsInAnyRegion\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"guardduty:ListDetectors\",\n \"guardduty:GetFindingsStatistics\"\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:\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/spreaker/prometheus-aws-guardduty-exporter/archive/1.1.2.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/spreaker/prometheus-aws-guardduty-exporter", "keywords": "prometheus,aws,guardduty", "license": "", "maintainer": "", "maintainer_email": "", "name": "prometheus-aws-guardduty-exporter", "package_url": "https://pypi.org/project/prometheus-aws-guardduty-exporter/", "platform": "", "project_url": "https://pypi.org/project/prometheus-aws-guardduty-exporter/", "project_urls": { "Download": "https://github.com/spreaker/prometheus-aws-guardduty-exporter/archive/1.1.2.tar.gz", "Homepage": "https://github.com/spreaker/prometheus-aws-guardduty-exporter" }, "release_url": "https://pypi.org/project/prometheus-aws-guardduty-exporter/1.1.2/", "requires_dist": null, "requires_python": ">= 3", "summary": "Prometheus exporter for AWS GuardDuty", "version": "1.1.2" }, "last_serial": 5391382, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "85806586e084bc08006e715bc37079ac", "sha256": "76ba2135d119e6f9af356d101898331b41af3f2075593964de16375cd9203817" }, "downloads": -1, "filename": "prometheus-aws-guardduty-exporter-1.0.0.tar.gz", "has_sig": false, "md5_digest": "85806586e084bc08006e715bc37079ac", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4318, "upload_time": "2019-05-15T16:38:34", "url": "https://files.pythonhosted.org/packages/c4/77/bd67a2103ddefe2ebe72d791f571e5b350813123b3d2af07e932fce6f70e/prometheus-aws-guardduty-exporter-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "c353ff82f9e1a816654a67c3b9978c1c", "sha256": "0d80c3515d08418cc92bae616c2b9132dd22a2573d6198177eded650a0c5e22f" }, "downloads": -1, "filename": "prometheus-aws-guardduty-exporter-1.1.0.tar.gz", "has_sig": false, "md5_digest": "c353ff82f9e1a816654a67c3b9978c1c", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4648, "upload_time": "2019-06-12T08:39:27", "url": "https://files.pythonhosted.org/packages/65/d9/64a527f06c0146df23fefc82e5d0cc07eb6bd42ee4e8e220ee39e694aeba/prometheus-aws-guardduty-exporter-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "4d13ab07d07112b5883fcf66f0881a1b", "sha256": "d454a79b827a11779f6309a70e290a78fd9418a000e9a96db2f1bd243742b0d2" }, "downloads": -1, "filename": "prometheus-aws-guardduty-exporter-1.1.1.tar.gz", "has_sig": false, "md5_digest": "4d13ab07d07112b5883fcf66f0881a1b", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4640, "upload_time": "2019-06-12T10:23:35", "url": "https://files.pythonhosted.org/packages/5c/38/49079241ae59c13c4831c8af2aca392aeb6290eca6cb92f73c1c1a1e3771/prometheus-aws-guardduty-exporter-1.1.1.tar.gz" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "4f81b7953c06a0bb48be109c8ecb430f", "sha256": "5da42f3d96ed302d708c4627f6b75bc26ff70dee0e04c841a59f4ab03826e526" }, "downloads": -1, "filename": "prometheus-aws-guardduty-exporter-1.1.2.tar.gz", "has_sig": false, "md5_digest": "4f81b7953c06a0bb48be109c8ecb430f", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4656, "upload_time": "2019-06-12T14:11:22", "url": "https://files.pythonhosted.org/packages/84/e5/c4800bf704083a5fb9e5a2cc836f9d23a1b77cc9d82f478d0b3d65a14015/prometheus-aws-guardduty-exporter-1.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4f81b7953c06a0bb48be109c8ecb430f", "sha256": "5da42f3d96ed302d708c4627f6b75bc26ff70dee0e04c841a59f4ab03826e526" }, "downloads": -1, "filename": "prometheus-aws-guardduty-exporter-1.1.2.tar.gz", "has_sig": false, "md5_digest": "4f81b7953c06a0bb48be109c8ecb430f", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3", "size": 4656, "upload_time": "2019-06-12T14:11:22", "url": "https://files.pythonhosted.org/packages/84/e5/c4800bf704083a5fb9e5a2cc836f9d23a1b77cc9d82f478d0b3d65a14015/prometheus-aws-guardduty-exporter-1.1.2.tar.gz" } ] }