PRTG Manual: HTTP XML/REST Value Sensor

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.

Parent Tags

Shows tags that this sensor inherits from its parent device, group, and probe. This setting is shown for your information only and cannot be changed here.

Tags

Enter one or more tags, separated by spaces or commas. You can use tags to group sensors and use tag–filtered views later on. Tags are not case sensitive. We recommend that you use the default value.

There are default tags that are automatically predefined in a sensor's settings when you add a sensor. See section Default Tags below.

You can add additional tags to the sensor if you like. Other tags are automatically inherited from objects further up in the device tree. These are visible above as Parent Tags.

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

Priority

Select a priority for the sensor. This setting determines where the sensor is placed in sensor lists. A sensor with a top priority is at the top of a list. Choose from one star (low priority) to five stars (top 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 including possibly existing 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 field 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 field 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. This unit string is used for display purposes and is shown in graphs, data tables, and gauges.

If you want to change the Unit after having created the sensor, you can change it in the sensor's channel settings.

Sensor Result

Define what PRTG does with the sensor results:

• Discard sensor result: Do not store the sensor result.
• Write sensor result to disk (file name: Result of Sensor [ID].txt): Store the last result received from the sensor to the \Logs\sensors subfolder of the PRTG data directory on the probe system (master node, if in a cluster). File names: Result of Sensor [ID].txt and Result of Sensor [ID].Data.txt. This 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.

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 the pin symbol of a channel 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.
  This option cannot be used in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This field 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.

Click to interrupt the inheritance. See section Inheritance of Settings for more information.

Scanning Interval

Select a scanning interval (seconds, minutes, or hours). The scanning interval determines the amount of time that the sensor waits between two scans. You can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Define the number of scanning intervals that the sensor has time to reach and check a device again in case a sensor query fails. Depending on the option that you select, the sensor can try to reach and check a device again several times before the sensor shows a 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 a Warning status. Choose from:

• Set sensor to down immediately: Set the sensor to a Down status immediately after the first failed request.
• Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to a Warning status after the first failed request. If the following request also fails, the sensor shows an error.
• Set sensor to warning for 2 intervals, then set to down: Set the sensor to a Down status only after three consecutively failed requests.
• Set sensor to warning for 3 intervals, then set to down: Set the sensor to a Down status only after four consecutively failed requests.
• Set sensor to warning for 4 intervals, then set to down: Set the sensor to a Down status only after five consecutively failed requests.
• Set sensor to warning for 5 intervals, then set to down: Set the sensor to a Down status only after six consecutively failed requests.

Sensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show a Down status. It is not possible to immediately set a WMI sensor to a 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 a Down status. No "wait" option applies.

If a channel uses lookup values, the sensor immediately shows a Down status. No "wait" options apply.

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 settings here. They are active at the same time as the parent objects' settings.

Schedule

Select a schedule from the list. Schedules can be used to monitor for a certain time span (days or hours) every week.

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

Schedules are generally inherited. New schedules are added to existing schedules, so all schedules are active at the same time.

Maintenance Window

Specify if you want to set up a one-time maintenance window. During a maintenance window, the current object and all child objects are not monitored. They are in a Paused status instead. Choose between:

• Not set (monitor continuously): No maintenance window is set and monitoring is always active.
• Set up a one-time maintenance window: Pause monitoring within a maintenance window. You can define a time span for a monitoring pause below and change it even for a currently running maintenance window.

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

Maintenance Begins

This field 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 maintenance window.

Maintenance Ends

This field 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 maintenance window.

Dependency Type

Define 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 a Down status or in a Paused status caused by 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 a 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 field is only visible if you enable Select a sensor above. Click the Search button and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

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

After the master sensor for this dependency comes back to an Up status, monitoring of the dependent objects is 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. 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.

Click to interrupt the inheritance. See section Inheritance of Settings for more information.

User Group Access

Define the user groups that have access to the selected object. A table with user groups and types of access rights 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 access rights settings of the parent object.
• None: Users in this group cannot see or edit the object. The object neither shows up in lists nor in the device tree. Exception: If a child object is visible to the user, the object is visible in the device tree but it cannot be accessed.
• 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 its settings. They cannot edit access rights settings.
• Full: Users in this group can see the object, review its monitoring results, edit its 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 on access rights, see section User Access Rights.

Click to interrupt the inheritance. See section Inheritance of Settings for more information.

Channel Unit Types

For each type of channel, define the unit in which data is displayed. If defined 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 can be set on sensor level only.

Example

A JSON notated section may 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 may look like the following:

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