Metadata-Version: 2.1
Name: prometheus-aws-guardduty-exporter
Version: 1.1.2
Summary: Prometheus exporter for AWS GuardDuty
Home-page: https://github.com/spreaker/prometheus-aws-guardduty-exporter
Author: Marco Pracucci
Author-email: marco@pracucci.com
License: UNKNOWN
Download-URL: https://github.com/spreaker/prometheus-aws-guardduty-exporter/archive/1.1.2.tar.gz
Description: # Prometheus exporter for AWS GuardDuty
        
        
        ## Features
        
        - Exports the number of current (unarchived) findings from AWS GuardDuty, splitted by region and severity
        - Supports multiple AWS regions
        
        
        ## Exported metrics
        
        The exporter exports the following metrics:
        
        | Metric name                          | Type     | Labels               | Description      |
        | ------------------------------------ | -------- | -------------------- | ---------------- |
        | `aws_guardduty_exporter_up`          | gauge    | _None_               | Always `1`: can be used to check if it's running |
        | `aws_guardduty_current_findings`     | gauge    | `region`, `severity` | The current number of unarchived findings |
        | `aws_guardduty_scrape_errors_total`  | counter  | `region`, `severity` | The total number of scrape errors |
        
        
        ## How to run it
        
        You have two options to run it:
        
        1. Manually install and run the [`prometheus-aws-guardduty-exporter` Python package](https://pypi.org/project/prometheus-aws-guardduty-exporter/)
           ```
           pip3 install prometheus-aws-guardduty-exporter
        
           prometheus-aws-guardduty-exporter --region us-east-1
           ```
        
        2. Use the [Docker image available on Docker hub](https://hub.docker.com/r/spreaker/prometheus-aws-guardduty-exporter/)
           ```
           docker run --env AWS_ACCESS_KEY_ID="id" --env AWS_SECRET_ACCESS_KEY="secret" spreaker/prometheus-aws-guardduty-exporter --region us-east-1
           ```
        
        The cli supports the following arguments:
        
        | Argument                       | Required | Description |
        | ------------------------------ | -------- | ----------- |
        | `--region REGION [REGION ...]` | yes      | AWS GuardDuty region (can specify multiple space separated regions) |
        | `--exporter-host`              |          | The host at which the Prometheus exporter should listen to. Defaults to `127.0.0.1` |
        | `--exporter-port`              |          | The port at which the Prometheus exporter should listen to. Defaults to `9100` |
        | `--log-level LOG_LEVEL`        |          | Minimum log level. Accepted values are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`. Defaults to `INFO` |
        
        
        ## Required IAM privileges
        
        In order to successfully run, this application requires the following IAM privileges:
        
        ```
        {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Sid":    "ListDetectorsAndGetFindingsStatisticsInAnyRegion",
              "Effect": "Allow",
              "Action": [
                "guardduty:ListDetectors",
                "guardduty:GetFindingsStatistics"
              ],
              "Resource": "*"
            }
          ]
        }
        ```
        
        
        ## Development
        
        Run the development environment:
        
        ```
        docker-compose build dev && docker-compose run --rm dev
        ```
        
        Run tests in the dev environment:
        
        ```
        python3 -m unittest
        ```
        
        
        ## License
        
        This software is released under the [MIT license](LICENSE.txt).
        
Keywords: prometheus,aws,guardduty
Platform: UNKNOWN
Requires-Python:  >= 3
Description-Content-Type: text/markdown
Provides-Extra: dev
