PRTG Manual: HTTP Data Advanced Sensor
The HTTP Data Advanced sensor accesses a web server and retrieves Extensible Markup Language (XML) encoded or JavaScript Object Notation (JSON) encoded data.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: HTTP Data Geavanceerd
- French: Données avancé (HTTP)
- German: HTTP Daten (Erweitert)
- Japanese: HTTP データアドバンスト
- Portuguese: Dados HTTP (avançado)
- Russian: HTTP: Данные (расширенный)
- Simplified Chinese: HTTP 数据高级
- Spanish: Datos HTTP (avanzado)
Consider the following remarks and requirements for this sensor:
Remark |
Description |
---|---|
Return data |
The requested web server must return XML-encoded or JSON-encoded data that matches the format as defined in the PRTG Manual: Custom Sensors. |
SRP ciphers |
This sensor does not support Secure Remote Password (SRP) ciphers. |
Smart URL replacement |
This sensor supports smart URL replacement. |
IPv6 |
This sensor supports IPv6. |
Performance impact |
This sensor has a medium performance impact. |
Performance |
For best sensor performance, we recommend that you specify the content type on the target system, which is application/xml or application/json. |
Knowledge Base |
Knowledge Base: Which HTTP status code leads to which HTTP sensor status? |
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
- httpsensor
For more information about basic sensor settings, see section Sensor Settings.
Setting |
Description |
---|---|
Timeout (Sec.) |
Enter a timeout in seconds for the request. Enter an integer. The maximum timeout value is 900 seconds (15 minutes). If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message. |
URL |
Enter the URL that the sensor connects to. If you enter an absolute URL, the sensor uses this address independently of the IP Address/DNS Name setting of the parent device. You can enter the URL of a web page (to measure the loading time of the page's source code), or enter the URL of an image or of a page asset to measure this element's availability and loading time. The URL must be URL encoded. If you monitor an image or a page asset, this can create a high amount of memory load. We recommend that the size of the elements that you want to monitor does not exceed 200 MB. PRTG uses a smart URL replacement with which you can use the parent device's IP address or Domain Name System (DNS) name setting as part of the URL. For more information, see section Smart URL Replacement. |
Request Method |
Select an HTTP request method to determine how the sensor requests the URL:
|
Postdata |
This setting is only visible if you select POST above. Enter the data part for the POST request. No Extensible Markup Language (XML) is allowed here. |
Content Type |
This setting is only visible if you select POST above. Define the content type of the POST request:
|
Custom Content Type |
This setting is only visible if you select Custom above. Define the custom content type, for example, XML, JavaScript Object Notation (JSON), or HTTP. |
Server Name Indication |
The Server Name Indication (SNI) that the sensor automatically determines from the host address of the parent device or from the target URL of the sensor. For more information, see the Knowledge Base: My HTTP sensors fail to monitor websites which use SNI. What can I do? You cannot change this value after sensor creation. |
SNI Inheritance |
Define if you want to inherit the SNI from the parent device:
|
Result Handling |
Define what the sensor does with the data loaded at the URL:
This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance. In a cluster, PRTG stores the result in the PRTG data directory of the master node. |
Setting |
Description |
---|---|
HTTP Version |
Define the HTTP version that the sensor uses when it connects to the target URL:
|
User Agent |
Choose which user agent string the sensor sends when it connects to the target URL:
|
Custom User Agent |
This setting is only visible if you select Use a custom string above. Enter the string that the sensor uses as the user agent when it connects to the target URL. |
HTTP Headers |
Define if you want to send custom HTTP headers to the target URL:
|
Custom HTTP Headers |
This setting is only visible if you select Use custom HTTP headers above. Enter a list of custom HTTP headers and values that you want to transmit to the URL, each pair in one line. The syntax of a header-value pair is header1:value1 The sensor does not support the header field names user-agent, content-length, and host. Make sure that the HTTP header statement is valid. Otherwise, the sensor request cannot be successful. |
Setting |
Description |
---|---|
Authentication |
Define if authentication is necessary on the web page:
|
User Name |
This setting is only visible if you select Web page needs authentication above. If the proxy requires authentication, enter the user name for the proxy login. Enter a string. |
Password |
This setting is only visible if you select Web page needs authentication above. Enter a password. |
Authentication Method |
This setting is only visible if you select Web page needs authentication above. Select the authentication method that the URL uses:
|
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.
Instead of entering a complete address in the URL field of an HTTP sensor, you can only enter the protocol followed by a colon and three forward slashes (this means that you can enter either http:/// or https:///, or even a simple forward slash / as the equivalent for http:///). PRTG automatically fills in the parent device's IP Address/DNS Name in front of the third forward slash.
Whether this results in a valid URL or not depends on the IP address or Domain Name System (DNS) name of the parent device. In combination with cloning devices, you can use smart URL replacement to create many similar devices.
For example, if you create a device with the DNS name www.example.com and you add an HTTP sensor to it, you can provide values in the following ways:
- If you enter https:/// in the URL field, PRTG automatically creates the URL https://www.example.com/
- If you enter /help in the URL field, PRTG automatically creates and monitor the URL http://www.example.com/help
- It is also possible to provide a port number in the URL field. It is taken over by the device's DNS name and is internally added, for example, http://:8080/
Smart URL replacement does not work for sensors that run on the probe device.
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 values that the web server returns in several channels This channel is the primary channel by default. For more information about the return value format, see section Custom Sensors. |
KNOWLEDGE BASE
Which HTTP status code leads to which HTTP sensor status?
What security features does PRTG include?
My HTTP sensors fail to monitor websites which use SNI. What can I do?
My HTTP sensors don't work. What can I do?