PRTG Manual: HTTP Transaction Sensor

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 round parentheses (()) or angle brackets (<>).

Priority

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

Timeout (Sec.)

Enter a timeout in seconds for all HTTP requests. If the complete transaction takes longer than this value defines, the sensor cancels the request and shows an according error message. Please enter an integer value. The maximum value is 900 seconds (15 minutes).

Single URL Timeout (Sec.)

Enter a timeout in seconds for one single HTTP request. If the reply of any single request takes longer than this value defines, the sensor cancels the transaction and shows an according error message. Please enter an integer value. The maximum value is 900 seconds (15 minutes).

Monitoring Engine

If you encounter unexpected errors with the standard method that is used to monitor a URL, try to use the compatibility mode, which is based on .NET. Choose between:

• Default/High Performance (recommended): This is the default monitoring method for this sensor type.
• Alternate/Compatibility Mode: Try this method as an alternative for websites that do not work with the default approach. Using the compatibility mode, this sensor executes an external exe. Because of this, this method needs more resources, but it can be helpful in particular cases.
  If you select the compatibility mode, the options for the SSL method will be slightly different. You can also check for trusted certificates. Please see below.
  When using the Compatibility Mode, Smart URL Replacement will not work, so this sensor will not use the IP Address/DNS value of the parent device automatically then.

SSL Method

When using the compatibility mode, the SSL specific settings are a bit different to the default (automatically used) SSL settings. You can choose from:

• SSL 3.0
• TLS 1.0, TLS 1.1, TLS 1.2
• SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2 This is the default setting.

Check SSL Certificates

Specify if the sensor will check the certificate of the monitored URL. Choose between:

• Do not check used certificates: Do not consider the certificates of the monitored web pages. This the default setting.
• Check if the used certificates are trusted: Inspect the certificates. If the certificate of the server is not trusted, the sensor shows a Down status and displays a corresponding message.

Download Limit (KB)

Enter a number that defines the maximum amount of data (in kilobytes) that is transferred per request.

If you set content checks, be aware that they may be incomplete, because only the content downloaded up to this limit will be checked for search expressions.

Cookie Management

Select if cookies are used for the transaction. Choose between:

• Use cookies (recommended): Allow cookies to be set and read during the transaction cycle.
• Ignore cookies: Do not allow cookies. Use this option if you want to test the transaction without the use of cookies.

We recommend that you use the default value.

User Agent

Choose which user agent string the sensor sends when connecting to the defined URLs. Choose between:

• Use PRTG's default string: Do not enter a specific user agent, use the default setting. Usually, this is: Mozilla/5.0 (compatible; PRTG Network Monitor (www.paessler.com); Windows)
• Use a custom string: Use a custom user agent. Define below.

Custom User Agent

This field is only visible if you enable Use a custom string above. Enter a string that the sensor uses as user agent when connecting to the URL specified above.

Result Handling

Define what PRTG will do with the web page loaded at the given URL. Choose between:

• Discard HTML result: Do not store the requested web page.
• Store latest HTML result: Store the last result of the requested web page to the Logs (Sensors) directory in the PRTG data folder on the probe system the sensor is running on (on the Master node if in a cluster). File name: Result of Sensor [ID].txt. This is for debugging purposes, especially in combination with content checks. The file will be overwritten with each scanning interval.
  For information on how to find the folder used for storage, see section Data Storage.

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

Authentication

Define if the web page at the configured URL needs authentication. Choose between:

• No authentication needed
• Web page needs authentication

User

This field is only visible if you enable Web page needs authentication above. Enter a username. Please enter a string.

Password

This field is only visible if you enable Web page needs authentication above. Enter a password. Please enter a string.

Authentication Method

This field is only visible if you enable Web page needs authentication above. Select the authentication method the given URL is protected with. Choose from:

• Basic access authentication (HTTP): Use simple HTTP authentication. This is the default setting and suitable for most cases.
  This authentication method transmits credentials as plain text.
• Windows NT LAN Manager (NTLM): Use the Microsoft NTLM protocol for authentication. This is sometimes used in intranets for single sign-on.
• Digest Access Authentication: Use digest access authentication that applies a hash function to the password, which is safer than basic access authentication.

We recommend that you use the default value.

You can define up to 10 different transaction URLs, which will all be called in a row. Only if the complete transaction can be completed, the sensor will show an Up status. Using this mechanism, you can set up an extended monitoring with multiple URLs.

Enter settings for at least one transaction URL. You can use as many steps as needed and disable the other steps.

Transaction Step #x

This setting is available for URL #2 through #10. Define if you want to use this step for your transaction check. Choose between:

• Disable step #x: Do not use this step. Choose this option if you do not need all 10 steps for your transaction check.
• Enable step #x: Enable this step. Further options will be viewed, as described below.

URL

Enter the URL the sensor will connect to. It has to be URL encoded!

If you enter an absolute URL, this address will be independent of the IP Address/DNS Name setting of the device this sensor is created on. PRTG uses a smart URL replacement that allows you to use the parent device's IP address/DNS name setting as part of the URL. For more information, see section Smart URL Replacement below.

Request Method

The request method determines how the given URL is requested.

• GET: Request the website directly, like browsing the web. We recommend that you use this setting for a simple check of a web page.
• POST: Send post form data to the URL. If this setting is chosen, you must enter the data that will be sent in the Postdata field below.
• HEAD: Only request the HTTP header from the server; without the actual web page. Although this saves bandwidth because less data is transferred, it is not recommended because the measured request time is not the one experienced by your users and you might not be notified for slow results or timeouts.

Postdata

This field is only active if you choose POST in the Request Method setting above. Enter the data part for the post request here.

No XML is allowed here!

Require Keyword

Define if the sensor will check the result at the configured URL for keywords. Choose from:

• Do not check for keyword (default): Do not search for keywords in the result returned at the URL.
• Set sensor to warning if keyword is missing: Check if a keyword exists in the result and set the sensor to a Warning status if yes.
• Set sensor to error if keyword is missing: Check if a keyword exists in the result and set the sensor to a Down status if yes.

The content check is only intended for HTML websites and might not work with other target URLs.

Response Must Include

Define which string must be part of the web at the given URL. If the data does not include this string, the sensor will show an error status and display this string along with the affected URL in the sensor message. Please enter a string.

Only simple text search is available here. The characters * and ? work here as placeholder, whereas * stands for no or any number of characters and ? stands for exactly one character (as known from Windows search). This behavior cannot be disabled, so the literal search for these characters is not possible.

Exclude Keyword

Define if the sensor will check the result at the configured URL for keywords. Choose from:

• Do not check for keyword (default): Do not search for keywords in the result returned at the URL.
• Set sensor to warning if keyword is found: Check if a keyword exists in the result and set the sensor to a Warning status if yes.
• Set sensor to error if keyword is found: Check if a keyword exists in the result and set the sensor to a Down status if yes.

The content check is only intended for HTML websites and might not work with other target URLs.

Response Must Not Include

Define which string must not be part of the web at the given URL. If the data does include this string, the sensor will show an error status and display this string along with the affected URL in the sensor message. Please enter a string.

Only simple text search is available here. The characters * and ? work here as placeholder, whereas * stands for no or any number of characters and ? stands for exactly one character (as known from Windows search). This behavior cannot be disabled, so the literal search for these characters is not possible.

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 below the sensor's name. The available options depend on what channels are available for this sensor.

You can set another primary channel later by clicking the pin symbol of a channel in the sensor's Overview tab.

Graph 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 that visualizes the different components of your total traffic.
  This option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channel 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.

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

The proxy settings determine how a sensor connects to a given URL. You can enter data for an HTTP proxy server that sensors will use when connecting via HTTP or HTTPS.

This setting affects monitoring only and determines the behavior of HTTP sensors. To change proxy settings for the core server, see section System Administration—Core & Probes.

The SSL Certificate sensor and the SSL Security Check sensor do not support HTTP proxies, but you can configure connections via SOCKS proxies in their sensor settings.  

Name

Enter the IP address or DNS name of the proxy server to use. If you leave this field empty, no proxy will be used.

Port

Enter the port number of the proxy. Often, port 8080 is used. Please enter an integer value.

User

If the proxy requires authentication, enter the username for the proxy login.

Only basic authentication is available! Please enter a string or leave the field empty.

Password

If the proxy requires authentication, enter the password for the proxy login.

Only basic authentication is available! Please enter a string or leave the field empty.

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

Scanning Interval

Select a scanning interval (seconds, minutes, or hours) from the list. The scanning interval determines the time 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 a sensor has time to reach and check a device again in case a sensor query fails. The sensor can try to re-reach and check a device several times, depending on the option you select here, before it will be set to a Down status. This helps you 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 from:

• Set sensor to down immediately: The sensor will show an error immediately 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 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: Show an error status only after three consecutively failed requests.
• Set sensor to warning for 3 intervals, then set to down: Show an error status only after four consecutively failed requests.
• Set sensor to warning for 4 intervals, then set to down: Show an error status only after five consecutively failed requests.
• Set sensor to warning for 5 intervals, then set to down: Show an error status only after six consecutively failed requests.

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

If a sensor has defined error limits for channels, it will always show a Down status immediately, so no "wait" option will apply.

If a channel uses lookup values, it will always show a Down status immediately, so no "wait" options will apply.

Inheritance for schedules, dependencies, and maintenance windows cannot be interrupted. The corresponding settings from the parent objects will always be active. However, you can define additional settings here. They will be 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, hours) every 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.

Schedules are generally inherited. New schedules will be added to existing ones, 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 sensor and all child objects will not be monitored. They will be in a Paused status instead. Choose between:

• Not set (monitor continuously): No maintenance window will be set and monitoring will always be 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 start 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 another object. You can choose from:

• Use parent: Use the dependency type of the parent device.
• Select a sensor: Use the dependency type of the parent device. Additionally, pause the current sensor if another specific sensor is in a Down status or in a Paused status caused by another dependency. Select below.
• Master sensor for parent: Make this sensor the master object for its parent device. The sensor will influence the behavior of its parent device: 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 is paused by another dependency.

Testing your dependencies is easy! Simply select 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 you enable Select a sensor above. Click the Search button and use the object selector to select a sensor on which the current sensor 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 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.

This setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, please define delays in the parent Device Settings or in its parent Group Settings.

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

User Group Access

Define which user group(s) will have access to the object you're editing. 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, 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 on access rights, see section User Access Rights.