<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: HTTP Push Data Advanced Sensor

The HTTP Push Data Advanced sensor displays data from received messages which are pushed via an Hypertext Transfer Protocol (HTTP) request to the PRTG server. It provides a URL that can be used to push messages to the PRTG server using HTTP. It can show pushed values in multiple channels.

This function is known as webhook. Basically, a webhook works like a push notification: Webhooks are usually triggered by some event (for example, a new comment to a blog post) and send according information to a specified URL. The HTTP Push Data Advanced sensor then displays the data of pushed and received messages.

The data which is pushed to this sensor must be valid XML. For details about the return value format please see the Application Programming Interface (API) Definition.

 
Use the following URLs to receive the HTTP requests of the webhook:

  • GET requests: http://<probe_ip>:<port_number>/<token>?content=<valid XML>
     
    The XML encoded value of the content parameter has to match the format as defined in the API documentation in section Custom Sensors—Advanced EXE/Script Sensor, Advanced SSH Script Sensor, and Advanced HTTP Push Data Sensor.
     
  • POST requests: http://<probe_ip>:<port_number>/<token>
     
    This HTTP request method sends the XML encoded HTTP body as POST data. The body has to match the format as defined in the API documentation in section Custom Sensors—Advanced EXE/Script Sensor, Advanced SSH Script Sensor, and Advanced HTTP Push Data Sensor. We strongly recommend the HTTP content type application/xml.
     

Replace the parameters <probe_ip>, <port_number>, <token> and <valid XML> (for GET requests) with the corresponding values:

  • You can define port number and identification token in the sensor settings.
  • The probe IP is the IP address of the system on which your PRTG probe with this sensor is running on.
  • The content of GET requests has to be valid XML in the PRTG API format.
    Note: The content has to be URL encoded (for example, the whitespaces in the sample URL below); most browsers achieve this automatically.
     

Minimum example for the GET method which returns one static channel value:

http://127.0.0.1:5050/XYZ123?content=<prtg><result><channel>MyChannel</channel><value>10</value></result><text>this%20is%20a%20message</text></prtg>

 
 
Note: You can use several sensors with the same port and identification token. In this case, the data of push messages will be shown in each of these sensors.

Important notice: Currently, this sensor type is in beta status. The methods of operating can change at any time, as well as the available settings. Do not expect that all functions will work properly, or that this sensor works as expected at all. Be aware that this type of sensor can be removed again from PRTG at any time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually. It only shows the setting fields that are imperative for creating the sensor. Therefore, you will not see all setting fields in this dialog. You can change all settings in the sensor's Settings tab later.

On the sensor's details page, click on the Settings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name defined in the settings of the parent device the sensor is created on.

Basic Sensor Settings

Sensor Name

Enter a meaningful name to identify the sensor. The name will be shown by default in the device tree and in all alarms.

Tags

Enter one or more tags, separated by space or comma. You can use tags to group sensors and use tag-filtered views later on. Tags are not case sensitive. We recommend using the default value. You can add additional tags to it, if you like. Other tags are automatically inherited from objects further up in the device tree. Those are not visible here.

Priority

Select a priority for the sensor. This setting determines where the sensor will be placed in sensor lists. Top priority will be at the top of a list. You can choose from one star (low priority) to five stars (top priority).

HTTP Push

Request Method

Select the request method of your webhook:

  • ANY: Do not use any filter for the request method.
  • GET: Choose this method if your webhook uses GET.
  • POST: Choose this method if your webhook sends post form data. Postdata has to be application/x-www-form-urlencoded with the same parameters as for GET requests.

Port

Enter the port number on which this sensor listens for incoming HTTP requests. Default is 5050.

Identification Token

This is the token that is used to find the matching sensor for the incoming message. While you create the sensor, this token is {__guid__}. It will be replaced with an automatically generated token after you have completed the sensor creation. If you want to use another identification token, you can edit it while or after sensor creation. Note: The token will not be replaced automatically if you change it already during sensor creation.

HTTP Push Data

No Incoming Data

Define which status the sensor will attain if no push message has been received for at least two sensor scans. Choose between:

  • Ignore and keep last status (default): The sensor will remain in the status as defined by the last message received.
  • Switch to "Unknown" status: The sensor will turn into the Unknown status if there has not been received any message for at least two sensor scans.
  • Switch to "Error" after x minutes: The sensor will turn into the Error status if it has not received any message within a defined time span. Define the time threshold below.

Threshold (Minutes)

This field will only be visible if you selected the error option above. Enter the time threshold in minutes after which the sensor status will switch into an Error status if no push message has been received within this time span. Please enter an integer value.

Sensor Display

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 will always be displayed underneath the sensor's name. The available options depend on what channels are available for this sensor. Note: You can set another primary channel later by clicking on the pin symbol of a channel in the sensor's overview tab.

Chart Type

Define how different channels will be shown for this sensor.

  • Show channels independently (default): Show an own 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 will generate an easy-to-read graph which visualizes the different components of your total traffic. Note: This option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channels Settings settings).

Stack Unit

This setting is only available if stacked graphs are selected above. Choose a unit from the list. All channels with this unit will be 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 following settings are inherited from objects higher in the hierarchy and should be changed there, if necessary. Often, best practice is to change them centrally in the Root group's settings. To change a setting for this object, disable inheritance by clicking on the check mark symbol in front of the respective setting name. You will then see the options described below.

Scanning Interval

Scanning Interval

The scanning interval determines the time the sensor waits between two scans. Select a scanning interval (seconds, minutes, or hours) from the list. You can change the available intervals in the system administration.

When a Sensor Reports an Error

With this setting, you can define the number of scanning intervals a sensor has to report an error until the sensor will be set to a Down status. The sensor can try reaching a device several times, depending on your setup you can specify here, to help avoid false alarms if the monitored device has only temporary issues. For previous scanning intervals with failed requests, the sensor will show a Warning status. Choose between:

  • Set sensor to "down" immediately: The sensor will show an error after the first failed request.
  • Set sensor to "warning" for 1 interval, then set to "down" (recommended): After the first failed request, the sensor will show a yellow warning status. If the following request also fails, the sensor will show an error.
  • Set sensor to "warning" for 2 intervals, then set to "down": The sensor will only show an error status after three failed requests in a row.
  • Set sensor to "warning" for 3 intervals, then set to "down": The sensor will only show an error status after four failed requests in a row.
  • Set sensor to "warning" for 4 intervals, then set to "down": The sensor will only show an error status after five failed requests in a row.
  • Set sensor to "warning" for 5 intervals, then set to "down": The sensor will only show an error status after six failed requests in a row.

Note: Sensors that monitor via Windows Management Instrumentation (WMI) will always wait at least one scanning interval until an error is shown. It is not possible to set a WMI sensor "down" immediately, so the first option will not apply to these sensor types (all other options can apply).

Note: If a sensor has defined error limits for channels, this sensor will always be set to a Down status immediately, so no "wait" option will apply.

Schedules, Dependencies, and Maintenance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be interrupted; the according settings from the parent objects will always be active. However, you can define additional settings here. They will be active in parallel to the parent objects' settings.

Schedule

Select a schedule from the list. Schedules can be used to monitor for a certain time span (days, hours) throughout the week. With the period list option it is also possible to pause monitoring for a specific time span. You can create new schedules and edit existing ones in the account settings. Note: Schedules are generally inherited. New schedules will be added to existing ones, so all schedules are active.

Maintenance Window

Specify if you want to set-up a one-time maintenance window. During a maintenance window this object and all child objects will not be monitored. They will enter a paused state then. Choose between:

  • Not set (monitor continuously): No maintenance window will be set.
  • Set up a one-time maintenance window: Pause monitoring within a maintenance window.

Maintenance Begins At

This field is only visible if maintenance window is enabled above. Use the date time picker to enter the start date and time of the maintenance window.

Maintenance End At

This field is only visible if maintenance window is enabled above. Use the date time picker to enter the end date and time of the maintenance window.

Dependency Type

Define a dependency type. Dependencies can be used to pause monitoring for an object depending on the status of another. You can choose between:

  • Use parent: Pause the current sensor if the device it is created on is in a Down status, or if it is paused by another dependency.
  • Select object: Pause the current sensor if the device it is created on is in an Down status, or if it is paused by another dependency. Additionally, pause the current sensor if a specific other object in the device tree is in a Down status, or if it is paused by another dependency. Select below.
  • Master object for parent: Make this sensor the master object for its parent device. The sensor will influence the behavior of the device it is created on: If the sensor is in a Down status, the device will be paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor will be paused if the parent group of its parent device is in a Down status, or if it is paused by another dependency.

Note: Testing your dependencies is easy! Simply choose Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later all dependent objects should be paused. You can check all dependencies in your PRTG installation by selecting Devices | Dependencies from the main menu bar.

Dependency

This field is only visible if the select object option is enabled above. Click on the reading-glass symbol and use the object selector to choose an object on which the current sensor will be dependent on.

Delay (Seconds)

Define a time span. After the master object for this dependency comes back to an Up status, monitoring of the depending objects will be additionally delayed by the defined time span. This can help avoid false alarms, for example, after a server restart, by giving systems more time for all services to start up. Please enter an integer value in seconds. Note: This setting is not available if you choose this sensor to be the Master object for parent. In this case, please define delays in the parent Device Settings or the superior Group Settings.

Access Rights

User Group Access

Define which user group(s) will have access to the object you're editing. A table with user groups and right is shown; it contains all user groups from your setup. For each user group you can choose from the following access rights:

  • Inherited: Use the settings of the parent object.
  • None: Users in this group cannot see or edit the object. The object does not show up in lists and in the device tree. Exception: If a child object is visible to the user, the object is visible in the device tree, though not accessible.
  • Read: Users in this group can see the object and review its monitoring results.
  • Write: Users in this group can see the object, review its monitoring results, and edit the object's settings. They cannot edit access rights settings.
  • Full: Users in this group can see the object, review its monitoring results, edit the object's settings, and edit access rights settings.

You can create new user groups in the System Administration—User Groups settings. To automatically set all objects further down in the hierarchy to inherit this object's access rights, set a check mark for the Revert children's access rights to inherited option.

For more details about access rights, please see section User Access Rights.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's Overview tab and click on the gear icon of a specific channel. For detailed information, please see Sensor Channels Settings section.

Notifications

Click on the Notifications tab to change notification triggers. For detailed information, please see Sensor Notifications Settings section.

Others

For more general information about settings, please see Object Settings section.

Sensor Settings Overview

For information about sensor settings, please see the following sections:

Keywords: