PRTG Manual: Docker Container Status Sensor

Sensor Name

Enter a name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets.

If the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?

Parent Tags

The tags that the sensor inherits from its parent device, parent group, and parent probe.

This setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

It is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

For performance reasons, it can take some minutes until you can filter for new tags that you added.

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

• docker
• dockercontainer

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority () to the highest priority ().

Port

Enter the number of the port to which this sensor connects. The default port on which Docker over Transport Layer Security (TLS) runs is 2376.

Private Key

Provide the private key for the connection to Docker. If you have already created a key, you can use it here. Otherwise, create a key on Docker first.

Open the key with a text editor, copy everything that the file includes, and paste it here. Usually, the key starts with -----BEGIN RSA PRIVATE KEY----- and ends with -----END RSA PRIVATE KEY-----

For more information on how to create a Docker certificate, see the Knowledge Base: How can I create private key and certificate for the Docker sensor?

Certificate

Provide the certificate for the connection to Docker. If you have already created a certificate, you can use it here. Otherwise, create a certificate on Docker first.

Open the certificate with a text editor, copy everything that the file includes, and paste it here. Usually, the certificate starts with -----BEGIN CERTIFICATE----- and ends with -----END CERTIFICATE-----

For more information on how to create a Docker certificate, see the Knowledge Base: How can I create private key and certificate for the Docker sensor?

Container ID

The ID of the container that this sensor monitors.

Container Name

The name of the container that this sensor monitors.

Image

The name of the image that was used to create the Docker container that this sensor monitors.

Container Identification

Define how the sensor identifies the Docker container that it monitors:

• By container ID (default): Use the ID of the Docker container for identification.
• By container name: Use the name of the Docker container for identification.
  Use this option if the IDs of your containers regularly change, for example, because of nightly deployments of your Docker containers.

Result Handling

Define what PRTG does with the sensor result:

• Discard result: Do not store the sensor result.

• Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].Data.txt, Result of Sensor [ID]_1.json, and Result of Sensor [ID]_2.json. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.

This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

In a cluster, PRTG stores the result in the PRTG data directory of the master node.

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

You can set a different primary channel later by clicking below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

• Show channels independently (default): Show a graph for each channel.
• Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
  You cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you select Stack channels on top of each other above.

Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Available Memory

The available memory

Available Memory %

The available memory (%)

This channel has default limits

• Lower error limit: 5%
• Lower warning limit: 10%

CPU Usage

The CPU usage

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status

Eth0 Packets In

The number of ingoing packets

Eth0 Packets Out

The number of outgoing packets

Eth0 Traffic In

The incoming traffic

Eth0 Traffic Out

The outgoing traffic

Exit Code

The exit code

Status

The overall status

• Up status: Create, Running
• Warning status: Paused, Restarting
• Down status: Exited

This channel is the primary channel by default.

Uptime

The uptime