PRTG Manual: HTTP XML/REST Value Sensor

.NET Framework

This sensor requires the Microsoft .NET Framework. .NET 4.7.2 or later must be installed on the probe system (on every cluster node, if on a cluster probe). If the framework is missing, you cannot create this sensor.

For more information, see the Knowledge Base: Which .NET version does PRTG require?

Channel Name

Enter a name for the channel that displays the value at the URL.

Sensor Name

Enter a meaningful 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.

If 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. This setting is shown for your information only and cannot be changed here.

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.

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

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

• ptfsensor

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

URL

Enter the URL that returns the .xml file.

The URL must be URL encoded.

If you enter an absolute URL, the sensor uses this address independently of the IP Address/DNS Name setting of the parent device. PRTG uses a smart URL replacement that lets you use the parent device's IP address/DNS name setting as part of the URL.

For more information, see section Smart URL Replacement.

XML Node (and optional property)

Enter the name of the node that this sensor checks, or enter a node name and a property name to check a property value. To obtain a value from nested tags, enter the tag names separated by a forward slash (/), for example, use myTag/myTagInside as XML node value.

You can also check values in JavaScript Object Notation (JSON). See section Checking JSON.

You can try to use XPath syntax here but it does not work in all cases and we do not provide any technical support for XPath issues. For further documentation about XPath, see the Knowledge Base: How can I use XPath with the HTTP XML/REST Value Sensor?

HTTP Username

If the URL requires authentication, enter the username. Enter a string or leave the field empty.

HTTP Password

If the URL requires authentication, enter the password. Enter a string or leave the field empty.

Sensor Value

Define what value the sensor shows:

• Use the value of the selected XML node: Return the value that the sensor finds at the specified XML node. If this is a non-numerical value, the sensor shows 0.
• Use the number of occurrences of the selected XML node or its children/siblings: Return the number of occurrences found. Define further below.

Count XML Nodes

This setting is only visible if you enable the return number option above. Define which count the sensor shows:

• Occurrences of the selected XML node: Return how often the defined XML node occurs at the URL.
• Child nodes of the selected XML node: Return the number of child nodes that exist below the node at the URL.
• Sibling nodes of the selected XML node: Return the number of sibling nodes that exist next to the node at the URL.

Namespaces

Define whether namespaces in the .xml document are used or not:

• Use namespaces: Process the value you enter in the XML Node (and optional property) field, possibly including namespace information.
• Remove namespaces: Ignore namespace information in the .xml document and process the value you enter in the XML Node (and optional property) field as node names only.

For more information see section About Namespaces.

Content Type in Header

Define what to include in the header of the request sent to the URL:

• Enable (recommended): This works for most web servers and is the recommended setting.
• Disable: Only very few web servers cannot handle this content type and need this setting. Try this if you get an error message with the enabled option.
• Custom: You can use a custom content type.

Custom Content Type

This setting is only visible if you enable Custom above. Enter a custom content type like text/xml or text/html.

HTTP Headers

Optionally enter a list of custom HTTP headers with their respective values that you want to transmit to the URL. The syntax of a list with header-value pairs is header1:value1|header2:value2|...|headerx:valuex

The sensor does not accept header field names that include a dash (–) character. If you want to use such an HTTP header, leave out the dash in the name. For example, enter ContentType:value instead of Content-Type:value. Example: From:[email protected]|AcceptLanguage:en-us

Ensure that the HTTP header statement is valid. Otherwise, the sensor request cannot be successful.

Characters to Remove

This setting is only visible if you enable Use the value of the selected XML node above. Optionally enter a string that the sensor removes from the returned XML value.

Use this to remove any unwanted characters from the result, for example to remove a thousands separator from numeric values. Enter a string or leave the field empty.

Decimal Delimiter

This setting is only visible if you enable Use the value of the selected XML node above. If the sensor value of the selected XML node is of the type float, you can define any character here, which is then handled as the decimal delimiter. Enter one character or leave the field empty.

Custom Message

Optionally enter a custom sensor message. Use %1 as a placeholder to automatically fill in the returned XML value. Enter a string or leave the field empty.

If Channel Value Changes

Define what the sensor does when the sensor value changes:

• Ignore changes (default): Take no action on change.
• Trigger 'change' notification: Send an internal message indicating that the sensor value has changed. In combination with a change trigger, you can use this mechanism to trigger a notification whenever the sensor value changes.

The notification for this sensor can only be triggered if the returned value is a numerical value. This option does not support strings.

Unit String

Enter the unit for the values that this sensor returns. Enter a string. PRTG uses the unit string for display purposes and shows it in graphs, data tables, and gauges.

If you want to change the unit after sensor creation, you can change it in the sensor's channel settings.

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].txt and Result of Sensor [ID].Data.txt. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.

This option is not available when the sensor runs on the hosted probe of a PRTG hosted by Paessler instance.

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

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.

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

Scanning Interval

Select a scanning interval from the dropdown list. The scanning interval determines the amount of time that the sensor waits between two scans. Choose from:

• 30 seconds
• 60 seconds
• 5 minutes
• 10 minutes
• 15 minutes
• 30 minutes
• 1 hour
• 4 hours
• 6 hours
• 12 hours
• 1 day

You can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Select the number of scanning intervals that the sensor has time to reach and to check a device again if a sensor query fails. Depending on the option that you select, the sensor can try to reach and to check a device again several times before the sensor shows the Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows the Warning status. Choose from:

• Set sensor to down immediately: Set the sensor to the Down status immediately after the first request fails.
• Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to the Warning status after the first request fails. If the second request also fails, the sensor shows the Down status.
• Set sensor to warning for 2 intervals, then set to down: Set the sensor to the Down status only after the third request fails.
• Set sensor to warning for 3 intervals, then set to down: Set the sensor to the Down status only after the fourth request fails.
• Set sensor to warning for 4 intervals, then set to down: Set the sensor to the Down status only after the fifth request fails.
• Set sensor to warning for 5 intervals, then set to down: Set the sensor to the Down status only after the sixth request fails.

Sensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show the Down status. It is not possible to immediately set a WMI sensor to the Down status, so the first option does not apply to these sensors. All other options can apply.

If you define error limits for a sensor's channels, the sensor immediately shows the Down status. None of the interval options apply.

If a channel uses lookup values, the sensor immediately shows the Down status. None of the interval options apply.

Schedule

Select a schedule from the list. You can use schedules to monitor during a certain time span (days or hours) every week. Choose from:

• None
• Saturdays
• Sundays
• Weekdays
• Weekdays Eight-To-Eight (08:00 - 20:00)
• Weekdays Nights (17:00 - 09:00)
• Weekdays Nights (20:00 - 08:00)
• Weekdays Nine-To-Five (09:00 - 17:00)
• Weekends

You can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Schedules.

Maintenance Window

Select if you want to set up a one-time maintenance window. During a maintenance window, monitoring stops for the selected object and all child objects. They show the Paused status instead. Choose between:

• Not set (monitor continuously): Do not set up a one-time maintenance window. Monitoring is always active.
• Set up a one-time maintenance window: Set up a one-time maintenance window and pause monitoring. You can define a time span for a the pause below.

To terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.

Maintenance Begins

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the one-time maintenance window.

Maintenance Ends

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the one-time maintenance window.

Dependency Type

Select a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:

• Use parent: Use the dependency type of the parent object.
• Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in the Down status or in the Paused status because of another dependency.

• Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in the Down status, the device is 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 is paused if the parent group is paused by another dependency.

To test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar.

Dependency

This setting is only visible if you enable Select a sensor above. Click and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

This setting is only visible if you enable Select a sensor above. Define a time span in seconds for the dependency delay.

After the master sensor for this dependency returns to the Up status, PRTG additionally delays the monitoring of the dependent objects by the time span you define. This can prevent false alarms, for example, after a server restart or to give systems more time for all services to start. Enter an integer value.

This setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings.

User Group Access

Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:

• Inherited: Inherit the access rights settings of the parent object.
• No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
• Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
• Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
• Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.

For more details on access rights, see section Access Rights Management.

Channel Unit Types

For each type of channel, select the unit in which PRTG displays the data. If you define this setting on probe, group, or device level, these settings can be inherited to all sensors underneath. You can set units for the following channel types (if available):

• Bandwidth
• Memory
• Disk
• File
• Custom

Custom channel types are only available on sensor level.

Example

A JSON notated section might look like the following:

{
 "test": "Hello World",
 "object": {
   "value": "content",
   "AnotherValue": "AnotherContent"
 },
 "arraytest": [
   "one",
   "two"
 ]
}

Depending on your entries in the XML Node field, the sensor processes the respective values:

Example

A namespace notated section might look like the following:

<myNamespace:myNode>
 some information
</myNamespace:myNode>