PRTG Manual: MQTT Round Trip Sensor
The MQTT Round Trip sensor monitors the availability of a Message Queue Telemetry Transport (MQTT) broker (server), connects to the broker as a publishing and subscribing client, and sends the data packets using a predefined topic.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: MQTT Heen en Terug
- French: MQTT aller-retour
- German: MQTT Round Trip
- Japanese: MQTT ラウンドトリップ
- Portuguese: Ida e volta MQTT
- Russian: Цикл MQTT
- Simplified Chinese: MQTT 往返
- Spanish: Ida y vuelta MQTT
Consider the following remarks and requirements for this sensor:
Remark |
Description |
---|---|
Credentials |
This sensor requires credentials for MQTT. |
IPv6 |
This sensor supports IPv6. |
Performance impact |
This sensor has a low performance impact. |
New framework |
This sensor was converted to a new framework. MQTT Round Trip sensors that were added before PRTG 20.2.59 do not work anymore. We recommend that you pause existing sensors to keep their historic data. To continue monitoring, please add a new MQTT Round Trip sensor. |
Lookups |
This sensor uses lookups to determine the status values of one or more channels. |
Multi-platform probe |
You can add this sensor to a multi-platform probe. |
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
- mqtt
- mqttroundtrip
- roundtrip
For more information about basic sensor settings, see section Sensor Settings.
Setting |
Description |
---|---|
Topic |
Enter the topic for the round trip. The default is PRTG/roundtrip/%sensorid. PRTG replaces %sensorid with the sensor's ID. |
Connection Settings |
Define the connection settings for the connection to the MQTT broker:
|
ClientID |
This setting is only visible if you select Use custom settings above. Enter the ClientID for the connection to the MQTT broker. The default is PRTG_%sensorid. PRTG replaces %sensorid with the sensor's ID. For the subscribing client, PRTG automatically adds _subscriber to the ClientID. For the publishing client, PRTG automatically adds _publisher to the ClientID. |
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. |
Setting |
Description |
---|---|
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. |
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 |
---|---|
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. |
Publisher Connection Time |
The time it takes the publisher to connect |
Round Trip Time |
The RTT of the message (after both publisher and subscriber connect) This channel is the primary channel by default. |
Status |
The round trip status
|
Subscriber Connection Time |
The time it takes the subscriber to connect |
KNOWLEDGE BASE
What security features does PRTG include?