New announcements for Serverless, Network, RUM, and more from Dash!

Aqua

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

This check monitors Aqua.

The Aqua check will alert the user if total high-severity vulnerability is reached, or if a container is running inside a host not registered by Aqua. Aqua will also send data alerts regarding blocked events in runtime, and it is possible to trigger a webhook to scale infrastructure if more Aqua scanners are required.

Setup

The Aqua check is not included in the Datadog Agent package, so you will need to install it yourself.

Installation

If you are using Agent v6.8+ follow the instructions below to install the Aqua check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior to version 6.8 or the Docker Agent:

  1. Install the developer toolkit.
  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
    
  4. To build the aqua package, run:

    ddev -e release build aqua
    
  5. Download and launch the Datadog Agent.

  6. Run the following command to install the integrations wheel with the Agent:

    datadog-agent integration install -w <PATH_OF_AQUA_ARTIFACT>/<AQUA_ARTIFACT_NAME>.whl
    
  7. Configure your integration like any other packaged integration.

Configuration

  1. Edit the aqua.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Aqua metrics and logs. See the sample conf.yaml for all available configuration options.

Metric Collection

  1. Add this configuration block to your aqua.d/conf.yaml file to start gathering your Aqua Metrics:
instances:
  - url: http://your-aqua-instance.com
    api_user: <api_username>
    password: <api_user_password>

Change the api_user and password parameter values and configure them for your environment.

Restart the Agent.

Log Collection

There are two types of logs generated by Aqua:

  • Aqua audit logs
  • Aqua enforcer logs

To collect Aqua audit logs:

  1. Connect to your Aqua account
  2. Go to the Log Management Section of the Integration Page
  3. Activate the Webhook integration
  4. Enable it and add the following endpoint: https://http-intake.logs.datadoghq.com/v1/input/<DATADOG_API_KEY>?ddsource=aqua
  • Replace <DATADOG_API_KEY> by your Datadog Api Key.
  • Note: For the EU region, replace .com by .eu in the endpoint.

For the Aqua Enforcer logs: Available for Agent >6.0

(...)
  env:
    (...)
    - name: DD_LOGS_ENABLED
        value: "true"
    - name: DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL
        value: "true"
(...)

Validation

Run the Agent’s status subcommand and look for aqua under the Checks section.

Data Collected

Metrics

aqua.images
(gauge)
The number of images seen by Aqua
shown as unit
aqua.vulnerabilities
(gauge)
The number and categories of vulnerabilities detected by Aqua
shown as occurrence
aqua.running_containers
(gauge)
The number of running containers seen by Aqua
shown as container
aqua.audit.access
(gauge)
The number of audit events per category
shown as event
aqua.scan_queue
(gauge)
The number of scan queues per type
shown as occurrence
aqua.enforcers
(gauge)
The number of host enforcers per status
shown as host

Service Checks

aqua.can_connect:

Returns CRITICAL if the Agent cannot connect to Aqua to collect metrics. Returns OK otherwise.

Events

Aqua does not include any events.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!