PRTG Manual: HTTP Push Data Sensor
The HTTP Push Data sensor displays numeric values from received messages that are pushed via an HTTP request to PRTG. It provides a URL that you can use to push messages to the probe system via HTTP (secured with TLS 1.2 or not secure).
For more information about the sensor usage, see section How to Use.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: HTTP Push Data
- French: Données (HTTP Push)
- German: HTTP Push-Daten
- Japanese: HTTP プッシュデータ
- Portuguese: Dados de push HTTP
- Russian: Данные push-объекта HTTP
- Simplified Chinese: HTTP 推送数据
- Spanish: Datos push (HTTP)
Consider the following remarks and requirements for this sensor:
Remark |
Description |
---|---|
Remote probe |
If you want to add this sensor to a remote probe and use an HTTPS connection to send push notifications, you must import a Secure Sockets Layer (SSL) certificate into the \cert subfolder of the PRTG program directory on the remote probe. However, this certificate does not have to match the certificate that you use on the PRTG core server. For more information about SSL certificates, see the Paessler website: How to use your own SSL certificate with the PRTG web server |
IPv6 |
This sensor supports IPv6. |
Performance impact |
This sensor has a low performance impact. |
False alerts |
This sensor might result in false alerts if the parent probe disconnects from the PRTG core server. In this case, the sensor shows the error message: The latest push message that the sensor received is older than the specified time threshold allows. (code: PE222). |
Hosted probe |
You cannot add this sensor to the hosted probe of a PRTG Hosted Monitor instance. If you want to use this sensor, add it to a remote probe device. |
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
- HttpPushSensor
- PushData
- PushSensor
For more information about basic sensor settings, see section Sensor Settings.
Setting |
Description |
---|---|
TLS Settings |
Define the security of the incoming HTTP push requests:
You cannot change this value after sensor creation. |
Port |
This setting is only visible if you select HTTP (unsecure) above. Enter the number of the port on which this sensor listens for incoming HTTP requests. The default port is 5050. You cannot change this value after sensor creation. |
TLS Port |
This setting is only visible if you select HTTPS low security (TLS 1.0 to 1.3 and weak ciphers) or HTTPS high security (TLS 1.2 to 1.3 and strong ciphers) above. Enter the number of the port on which this sensor listens for incoming HTTPS requests. The default port is 5051. You cannot change this value after sensor creation. |
Request Method |
Select the request method of the webhook:
|
Identification Token |
This is the token that PRTG uses to find the matching sensor for the incoming message. When you create the sensor, this token is {__guid__}. PRTG replaces this token with an automatically generated token after sensor creation. If you want to use a different identification token, you can edit it during or after sensor creation. PRTG does not automatically replace the token if you change it already during sensor creation. |
Request Handling |
Define what PRTG does with the incoming messages:
|
Setting |
Description |
No Incoming Data |
Define which status the sensor shows if it does not receive a push message for at least two scanning intervals:
|
Time Threshold (Minutes) |
This setting is only visible if you select Switch to down status after x minutes above. Enter a time threshold in minutes. If this time elapses, the sensor shows the Down status if it does not receive a push message within this time span. Enter an integer. The maximum threshold is 1440 minutes. |
Value Type |
Define the type of the value of the received data:
If this setting does not match, the sensor shows the Down status. |
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.
This function is known as webhook. Basically, a webhook works like a push notification. Webhooks are usually triggered by an event (for example, a new comment on a blog post) and send according information to a specified URL. The HTTP Push Data sensor then displays the data of pushed and received messages.
The HTTP Push Data sensor uses the following URL:
http://<probe_ip>:<port_number>/<token>?value=<integer_or_float>&text=<text message>
Replace the parameters <probe_ip>, <port_number>, <token>, and <integer_or_float> with the corresponding values. The &text parameter is optional: You can omit it.
- You can define the port number and identification token in the sensor settings.
- The probe IP is the IP address of the probe system with this sensor.
- The value can be an integer or a float value depending on the data of your application. You must set the value type accordingly in the sensor settings. This parameter is the sensor value.
If this parameter is missing, the sensor shows a Down status. - You can optionally add a custom text message by replacing the parameter <text message> with your custom text. The text is shown as the sensor message. If there is no value but only a text, the text is shown as an error message.
This text message has to be URL encoded (for example, the whitespaces in the sample URL below). Most browsers do URL-encoding automatically.
Example:
http://192.0.2.0:5050/XYZ123?value=0&text=this%20is%20a%20message
You can use several sensors with the same port and identification token. In this case, the data of push messages is shown in each of these sensors.
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 received value and an optional message in one channel This channel is the primary channel by default. |
KNOWLEDGE BASE
What security features does PRTG include?
My HTTP sensors don't work. What can I do?