PRTG Manual: Docker Container Status Sensor
The Docker Container Status sensor monitors the status of a Docker container.
Docker Container Status Sensor
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: Docker Container Status
- French: État de conteneur Docker
- German: Docker-Container-Zustand
- Japanese: Docker コンテナーの状態
- Portuguese: Status do contêiner Docker
- Russian: Статус контейнера Docker
- Simplified Chinese: Docker 容器状态
- Spanish: Estado de contenedor Docker.
- The parent device of this sensor must be the Docker machine on which the container that you want to monitor runs.
- You need to provide certificates and private keys to monitor Docker with this sensor. For details, see the Knowledge Base: How can I create private key and certificate for the Docker sensor?
- This sensor supports the IPv6 protocol.
- This sensor has a low performance impact.
- This sensor only supports the IPv4 protocol.
- This sensor uses lookups to determine the status values of one or more channels. This means that possible states are defined in a lookup file. You can change the behavior of a channel by editing the lookup file that the channel uses. For details, see section Define Lookups.
The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.
PRTG requires an authentication with a certificate and a private key before you can add this sensor. Provide Port (usually 2376), Private Key, and Certificate in the dialog box that appears and click OK. PRTG can now scan Docker for containers.
The settings that you select in the Add Sensor dialog are valid for all sensors that you create when you finish the dialog.
Docker Specific
Setting |
Description |
|---|---|
Container |
Select the Docker containers that you want to monitor. PRTG creates one sensor for each container that you select.
|
Click the Settings tab of a sensor to change its settings.
Basic Sensor Settings
Setting |
Description |
|---|---|
Sensor Name |
Enter a name to identify the sensor. |
Parent Tags |
Shows tags that the sensor inherits from its parent device, parent group, and parent probe.
|
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.
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
|
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 ( |
Usually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.
Docker Credentials
Docker Credentials
Setting |
Description |
|---|---|
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 certificate 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-----
|
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-----
|
Docker Specific
Docker Specific
Setting |
Description |
|---|---|
Container ID |
Shows the ID of the container that this sensor monitors.
|
Container Name |
Shows the name of the container that this sensor monitors.
|
Image |
Shows 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:
|
Result Handling |
Define what PRTG does with the sensor result:
|
This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.
Sensor Display
Setting |
Description |
|---|---|
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.
|
Graph Type |
Define how different channels are shown for this sensor:
|
Stack Unit |
This setting is only visible if you enable Stack channels on top of each other as Graph Type. 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. |
By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click 
under the corresponding setting name to disable the inheritance and to display its options.
For more information, see section Inheritance of Settings.
Scanning Interval
For more information, see section Root Group Settings, section Scanning Interval.
Schedules, Dependencies, and Maintenance Window
You cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.
Schedules, Dependencies, and Maintenance Window
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.
Access Rights
For more information, see section Root Group Settings, section Access Rights.
Which channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.
Channel Unit Configuration
For more information, see section Root Group Settings, section Channel Unit Configuration.
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
Channel |
Description |
|---|---|
Available Memory |
The available memory in bytes |
Available Memory % |
The available memory in percent |
CPU Usage |
The CPU usage in percent |
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 in percent. |
Eth0 Packets In |
The number of ingoing packets per second |
Eth0 Packets Out |
The number of outgoing packets per second |
Eth0 Traffic In |
The incoming traffic in bytes per second |
Eth0 Traffic Out |
The outgoing traffic in bytes per second |
Exit Code |
The exit code |
Status |
The overall status
|
Uptime |
The uptime |
Knowledge Base
How can I create private key and certificate for the Docker sensor?
What security features does PRTG include?
