Skip to main content

Docker plugin

The APEX AIOps Incident Management Docker plugin collects metrics based on a count of the number of active Docker containers. This occurs automatically at one-second intervals.

Install Docker

For the Docker plugin to send data to Incident Management, you must have a running Docker platform. If you do not have one installed, download and install Docker on the systems that you want to monitor.

Note

To ensure the Docker plugin can collect metrics, add the APEX AIOps Incident Management Collector user to the Docker group. See the Post-installation steps for Linux in the Docker manuals for instructions. The Docker plugin can run but it cannot collect metrics without this permission set; instead, it outputs an error in the logs and stops.

Configure and enable the Docker plugin

You must have a collector installed to use the Docker plugin. See Install a Linux or MacOS collector or Install a Windows OS collector for instructions on setting up a new collector.

To configure and enable the Docker plugin:

  1. Navigate to Integrations > Inbound Integrations.

  2. Click Collectors and select the target collector.

  3. Click the Plugins tab, then click Docker on the tab.

  4. In the Configuration panel, enter the parameter configuration information.

Parameter configuration

  1. From the Docker plugin Configuration tab, define the following parameters:

    • Retry Interval — The interval of time (in seconds) that the plugin will wait before restarting collecting a metrics stream. Use only positive integers, otherwise the Incident Management Collector does not run.

    • Exclude Container Prefixes — A list of specific container prefixes the plugin rejects when it gathers container metrics from Docker. Separate the prefixes by a space, such as prefix1 prefix2 and so forth. Wildcards are not accepted. The plugin excludes all containers with that prefix.

    • Include Container Prefixes — A list of specific container prefixes the plugin accepts when it gathers metrics from Docker. The plugin will only include containers that match the prefix. Separate the prefixes by a space, such as prefix1 prefix2 and so forth. Wildcards are not accepted.

    • Include Image Names — A Docker image name or multiple names separated by commas. The leading slash is not needed in the image name.

  2. Toggle the Enable option on when you are ready to start plugin data ingestion.

Validate the Docker plugin integration

To validate your Docker plugin integration, you have the following options:

  1. Navigate to Inbound Integrations > Collectors > <your-collector> > Plugins. Verify the Docker tile displays both Configured and True.

  2. Navigate to Inbound Integrations > Collectors > <your-collector> > Collector Logs to view a line-by-line progress readout of your integrations.

  3. Navigate to Incidents > Metrics in the left-navigation bar to check for the Docker metrics information, such as uptime, that is gathered by the Incident Management Collector and Docker plugin.