PRTG Manual: Docker Container Status Sensor
This sensor is in beta status. The operating methods and the available settings can change at any time. Do not expect that all functions work properly, or that this sensor works as expected at all. Be aware that this sensor can be removed from PRTG at any time.
The Docker Container Status sensor monitors the status of a Docker container.
The sensor can show the following:
- Overall status of the container (create, running, paused, restarting, exited)
- Uptime
- Exit code
- CPU usage
- Available memory in bytes and percent
- Dutch: Docker Container Status
- French: État de conteneur Docker
- German: Docker-Container-Zustand
- Japanese: Docker コンテナーの状態
- Portuguese: Status do Container Docker
- Russian: Статус контейнера Docker
- Simplified Chinese: Docker 容器状态
- Spanish: Estado de contenedor de 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 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 setting fields that are required for creating the sensor. Therefore, you do not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.
PRTG requires an authentication with certificate and private key before you can actually add this sensor. Provide Port (usually 2376), Private Key, and Certificate in the appearing dialog window and click OK. PRTG can now scan Docker for containers.
Select the Docker containers that you want to monitor. PRTG creates one sensor for each container that you select in the Add Sensor dialog.
The settings you select are valid for all sensors that you create when you finish this dialog.
The following settings in the Add Sensor dialog differ in comparison to the sensor's Settings tab.
Docker Specific
Setting |
Description |
---|---|
Container |
Select the containers that you want to add a sensor for. You see a list with the names of all items that you can monitor. Add check marks in front of the respective lines to select the desired items. You can also use the check box in the table header to select all items or cancel the selection.
To better find what you want to monitor, especially in large tables, use the search function in the upper-right corner. |
Click the Settings tab of a sensor to change its settings.
Usually, a sensor connects to the IP Address or DNS Name of the parent device on which you created the sensor. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings. See below for details on available settings.
Setting |
Description |
---|---|
Sensor Name |
Enter a meaningful 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.
|
Parent Tags |
Shows tags that the sensor inherits from its parent device, parent group, and parent probe. This setting is shown for your information only and cannot be changed here. |
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 ( |
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
Setting |
Description |
---|---|
Container ID |
Shows the ID of the container that this sensor monitors. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew. |
Container Name |
Shows the name of the container that this sensor monitors. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew. |
Image |
Shows the name of the image that was used to create the monitored Docker container. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew. |
Container Identification |
Define how the sensor identifies the Docker container that it monitors:
|
Result Handling |
Define what PRTG does with the sensor result:
|
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 the following settings are inherited from objects that are higher in the hierarchy. You should 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. You then see the options described below.
For more information, see section Inheritance of Settings.
Click to interrupt the inheritance.
Setting |
Description |
---|---|
Scanning Interval |
Select a scanning interval from the dropdown list. The scanning interval determines the amount of time that the sensor waits between two scans. Choose from:
|
If a Sensor Query Fails |
Select the number of scanning intervals that the sensor has time to reach and to check a device again if a sensor query fails. Depending on the option that you select, the sensor can try to reach and to check a device again several times before the sensor shows the Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows the Warning status. Choose from:
|
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.
Setting |
Description |
---|---|
Schedule |
Select a schedule from the list. You can use schedules to monitor during a certain time span (days or hours) every week. Choose from:
|
Maintenance Window |
Select if you want to set up a one-time maintenance window. During a maintenance window, monitoring stops for the selected object and all child objects. They show the Paused status instead. Choose between:
|
Maintenance Begins |
This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the one-time maintenance window. |
Maintenance Ends |
This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the one-time maintenance window. |
Dependency Type |
Select a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:
|
Dependency |
This setting is only visible if you enable Select a sensor above. Click |
Dependency Delay (Sec.) |
This setting is only visible if you enable Select a sensor above. Define a time span in seconds for the dependency delay. After the master sensor for this dependency returns to the Up status, PRTG additionally delays the monitoring of the dependent objects by the time span you define. This can prevent false alarms, for example, after a server restart or to give systems more time for all services to start. Enter an integer value.
|
Click to interrupt the inheritance.
Setting |
Description |
---|---|
User Group Access |
Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:
|
Click to interrupt the inheritance.
Setting |
Description |
---|---|
Channel Unit Types |
For each type of channel, select the unit in which PRTG displays the data. If you define this setting on probe, group, or device level, these settings can be inherited to all sensors underneath. You can set units for the following channel types (if available):
|
KNOWLEDGE BASE
How can I create private key and certificate for the Docker sensor?
For more information about sensor settings, see the following sections: