Configuring Docker using the TrueSight or Central Monitoring Administration console


Monitor the performance and metrics of your docker environment. For details about the attributes collected during monitoring, see Monitor-types-and-attributes.

Before you can begin using the PATROL for Docker KM, you must configure it. 

Docker Swarm configuration video

Click to watch a short video (4.45) on how to configure a docker swarm for monitoring.


icon-play.pngWatch this video to understand how to configure docker Swarm for monitoring. 

To configure docker environment monitoring

  1. Perform one of the following actions:
    1. In BMC Helix Operations Management, select Configuration > Monitoring Policies > Create Policy.
    2. In TrueSight Operations Management, select Configuration > Infrastructure Policies > Create Policy.
  2. Click Add Monitoring Configuration.
  3. From the Monitoring Solution list, select Docker.
  4. From the Monitor Profile and Monitor Type lists, select Docker.
  5. In the Add Monitoring Configuration section, click Add.

The following table lists the fields that are displayed on the Add Monitoring Configuration page.

Field

Description

Docker Host Monitoring Configuration

Docker Host Details: Click Add to configure the Docker host.

Monitor

Select the entity that you want to monitor. You can either monitor a Docker Swarm or a Docker Host.

Host Name

If you are monitoring a Docker host, enter the host name or the IP address of the Docker engine.

If you are monitoring a Docker Swarm, enter the host name or the IP address of the Manager node.

Port Number

If you are monitoring a Docker host, enter the port number of the docker daemon configured for remote connections.

If you are monitoring a Docker Swarm, enter the same port number for all the daemons of all nodes.

Connection Protocol

Select one of the following protocols for connection:

  • HTTP
  • HTTPS

Container Name Filter

Enter a container name or a regular expression to Include or Exclude the containers from monitoring.

Container Name Filter Type

Select whether to Include or Exclude the containers specified in Container Name Filter from monitoring.

Certificate Based Authentication

Certificate Based Authentication is required when the connection protocol is set to HTTPS.

Client Certificate File Path (.pfx)

Enter the path (along with the file name and .pfx extension) where the certificate file is located.

Important:

  • The client certificate file must reside on the host where the PATROL agent is running.
  • BMC PATROL default account must have read permission on the directory where the client certificate file is located.

Client Certificate Password

Enter a password for the certificate file.

OK

Click OK to save the configuration.

Cancel

Click this option to exit without saving any changes.


Administration

Field

Description

Enable device mapping

Select this checkbox to enable the device mapping.

Include container name in instance id

Select this checkbox to include the container name in the Container (DKR_CONTAINER) instance SID.

Important:

If you want to include Docker host or swarm node in the container SID, set the following PATROL configuration variable:

/DKR/HOST/<HOSTNAME>/includeHostName = 1

Where <HOSTNAME> is the host name provided in the Host Name policy field. For example, /DKR/HOST/abc.xyz.com/includeHostName.

After setting up the variable value to 1, the KM overrides the flag set in the field Include container name in instance id in the Administration section of policy configuration.

JAVA Home

Enter the JAVA home details. By default, BMC PATROL for Docker uses JAVA Runtime Environment (JRE) that is installed with the PATROL Agent. To use your own JRE that is installed in a different location, specify the path for the JAVA home directory.

For example, if your JAVA executable exists in the /usr/java/jdk1.8.0_45/jre/bin/java path, specify /usr/java/jdk1.8.0_45/jre as the value in this field.

Enable Debug

Select this checkbox to enable the debug.

OK and Close

Click this option to add this monitoring configuration. This information is displayed on the Monitor Configuration page.

After you click this option, you can continue to add more objects for monitoring.

OK

Click OK to save and close the configuration window.

Cancel

Click this option to exit without saving any changes.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*