PRTG Manual: MQTT Subscribe Custom Sensor
The MQTT Subscribe Custom sensor subscribes to a Message Queue Telemetry Transport (MQTT) topic and monitors up to ten numeric values from the received JavaScript Object Notation (JSON) data.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: MQTT Subscribe Custom
- French: MQTT Subscribe Custom
- German: MQTT Subscribe (Benutzerdefiniert)
- Japanese: MQTT Subscribe Custom
- Portuguese: MQTT Subscribe Custom
- Russian: MQTT Subscribe Custom
- Simplified Chinese: MQTT Subscribe Custom
- Spanish: MQTT Subscribe Custom
- This sensor requires credentials for MQTT in settings that are higher in the object hierarchy.
- This sensor supports IPv6.
- This sensor has a medium performance impact.
Setting |
Description |
---|---|
Channel #1 Name |
Enter a name for the channel.
|
Channel #1 Unit |
Enter the unit for the numeric value that this sensor monitors.
|
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.
|
Parent Tags |
The 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 ( |
Setting |
Description |
---|---|
Topic |
Enter the topic that you want to monitor.
|
Sensor Message JSONPath |
Optionally enter the path to the value in the JSON data that the sensor shows as sensor message.
|
Channel #x JSONPath |
Enter the path to the numeric value in the received JSON structure that you want to monitor.
{ To query temperature, enter the following JSONPath: $.Sensor1.Temp To query humidity, enter the following JSONPath: $.Sensor2.Humidity |
Channel #x Value Type |
Select the value type that the channel displays:
|
Channel #2 - #10 |
You can define up to 10 channels. You must define at least one data channel, so you see all available settings for Channel #1. Specify how to handle all other possible channels:
If the channel is enabled or disabled. You can select Disable (default) if you no longer need the according channels. You can still see the channels, but they do not receive data anymore. |
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. |
Setting |
Description |
---|---|
Result Handling |
Define what PRTG does with the sensor result:
|
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.
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.
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.
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.
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 |
---|---|
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 |
[Value] |
The returned numeric values in up to ten channels |
KNOWLEDGE BASE
What security features does PRTG include?