PRTG Manual: Docker Container Status Sensor
The Docker Container Status sensor monitors the status of a Docker container.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: Docker Container Status
- French: Statut 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.
Consider the following remarks and requirements for this sensor:
Remark |
Description |
---|---|
Certificate and private key |
This sensor requires certificates and private keys to monitor Docker. 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? |
Parent device |
This sensor requires that the parent device is the Docker machine on which the container that you want to monitor runs. |
Authentication |
This sensor requires an authentication with a certificate and a private key before you can add it. Provide the Port (usually 2376), Private Key, and Certificate and click OK. |
IPv4 |
This sensor only supports IPv4. |
Performance impact |
This sensor has a low performance impact. |
Lookups |
This sensor uses lookups to determine the status values of one or more channels. |
Limits |
This sensor has predefined limits for several metrics. |
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
- docker
- dockercontainer
For more information about basic sensor settings, see section Sensor Settings.
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 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? |
Docker Specific
Setting |
Description |
---|---|
Container ID |
The ID of the Docker container that this sensor monitors. |
Container Name |
The name of the Docker 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:
|
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. In a cluster, PRTG stores the result in the PRTG data directory of the master node. |
Setting |
Description |
---|---|
Primary Channel |
Select a channel from the list to define it as the primary channel. In the device tree, PRTG displays the last value of the primary channel 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 this sensor shows different channels:
|
Stack Unit |
This setting is only visible if you select Stack channels on top of each other above. Select a unit from the list. PRTG stacks all channels with this unit 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.
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 |
Available Memory % |
The available memory (%) This channel has default limits:
|
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
This channel is the primary channel by default. |
Uptime |
The uptime |
KNOWLEDGE BASE
How can I create private key and certificate for the Docker sensor?
What security features does PRTG include?