<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: Docker Container Status Sensor

The Docker Container Status sensor monitors the status of a Docker container.

Docker Container Status Sensor

Docker Container Status Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • 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.

Remarks

  • This sensor only supports IPv4.
  • This sensor has a low performance impact.
  • This sensor uses lookups to determine the status values of one or more channels.

Add Sensor

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.

i_round_blueThe 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.

i_round_blueEnable check boxes in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

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.

i_round_blueIf 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

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

i_round_blueThis 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.

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

i_round_blueFor 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 (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, 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

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-----

i_square_cyanFor 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-----

i_square_cyanFor 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

Docker Specific

Docker Specific

Setting

Description

Container ID

Shows the ID of the container that this sensor monitors.

i_round_bluePRTG shows this value 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.

i_round_bluePRTG shows this value 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 Docker container that this sensor monitors.

i_round_bluePRTG shows this value 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:

  • 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.
    i_round_blueUse 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.

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

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

Sensor Display

Sensor Display

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.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary 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.
    i_round_redYou 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 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.

Inherited Settings

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 b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou 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

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel Unit Configuration

i_round_blueWhich 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

Channel Unit Configuration

i_square_cyanFor more information, see section Root Group Settings, section Channel Unit Configuration.

Channel List

i_round_blueWhich 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 (%)

i_round_blueThis 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

i_round_blueThis channel is the primary channel by default.

Uptime

The uptime

More

i_square_blueKNOWLEDGE BASE

How can I create private key and certificate for the Docker sensor?

What security features does PRTG include?