<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: WMI Custom String Sensor

The WMI Custom String sensor performs a custom string query via Windows Management Instrumentation (WMI).

The sensor can show the following:

  • Retrieved string value in the sensor message
  • Response time

icon-i-round-redYour Windows Management Instrumentation Query Language (WQL) query code must be stored in a file on the system of the probe the sensor is created on. If used on a remote probe, the file must be stored on the system running the remote probe. In a cluster setup, copy the file to every cluster node. Save the file with the query into the \Custom Sensors\WMI WQL scripts subfolder of your PRTG installation.

icon-i-roundIf your WQL query returns numerical values, use the WMI Custom sensor.

WMI Custom String Sensor

WMI Custom String Sensor

Sensor in Other Languages

Dutch: WM Aangepaste Tekenreeks, French: Chaîne personnalisée WMI, German: WMI Text (benutzerdef.), Japanese: WMI カスタム文字列, Portuguese: Sequência de caracteres personalizada WMI, Russian: Нестандартная строка WMI, Simplified Chinese: WMI 自定义字符串, Spanish: WMI cadena personalizada

Remarks

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the setting fields that are required for creating the sensor. Therefore, you do not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.

The following settings in the Add Sensor dialog differ in comparison to the sensor's Settings tab.

Custom Query Specific

WQL File

Select a file that is used for this sensor from the list. The sensor executes it with every scanning interval.

The list contains WQL scripts from the \Custom Sensors\WMI WQL scripts subfolder of your PRTG installation. Store your script there. If used on a remote probe, the file must be stored on the system running the remote probe. If used on a cluster probe, you must store the file on all servers running a cluster node. For more information on how to find this path, see section Data Storage.

icon-i-roundIf your WQL query returns integers or floats, use the WMI Custom sensor to not only show the returned value in the sensor message, but to also monitor the value in a sensor channel.

Sensor Settings

On the details page of a sensor, click the Settings tab to change its settings.

icon-i-roundUsually, a sensor connects to the IP Address or DNS Name of the parent device on which you created the sensor. See the Device Settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings. See below for details on available settings.

Basic Sensor Settings

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.

icon-i-roundIt 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).

Default Tags

wmicustomsensor

Custom Query Specific

Namespace

Enter the namespace for the query.

WQL File

Shows the name of the file that this sensor uses. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.

icon-i-roundIf your WQL query returns integers or floats, use the WMI Custom sensor to not only show the returned value in the sensor message, but also monitor the value in a sensor channel.

Placeholder <#PH1>

In your WQL script, you can use up to three placeholders to which you can assign a value in this field. Enter a string for variable <#PH1> or leave the field empty.

Placeholder <#PH2>

In your WQL script, you can use up to three placeholders to which you can assign a value in this field. Enter a string for variable <#PH2> or leave the field empty.

Placeholder <#PH3>

In your WQL script, you can use up to three placeholders to which you can assign a value in this field. Enter a string for variable <#PH3> or leave the field empty.

Unit String

Enter a unit for the data that is received by your script. This is for display purposes only. The unit is displayed in graphs and tables. Enter a string.

If 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.

Response Must Include

Define the search string that must be part of the data that is received from the WMI object. You can enter a simple string in plain text or a regular expression.

icon-i-round-redThe search string must be case sensitive.

If the data does not include the search pattern, the sensor shows a Down status.

Response Must Not Include

Define the search string that must not be part of the data that is received from the WMI object. You can enter a simple string in plain text or a regular expression.

icon-i-round-redThe search string must be case sensitive.

If the data does include the search pattern, the sensor shows a Down status.

Search Method

Define the method with which you want to provide the search string:

  • Simple string search: Search for a simple string in plain text.
    icon-i-roundThe characters * and ? work as placeholders. * stands for no number or any number of characters and ? stands for exactly one character (as known from the Windows search). This behavior cannot be disabled, so the literal search for these characters is only possible using a regular expression.
  • Regular expression: Search using a regular expression (regex).

icon-i-bluePRTG supports Perl Compatible Regular Expression (PCRE) regex. You cannot use regex options or flags. For more details, see section Regular Expressions.

Maximum Length of String

Define the maximum allowed length of the string that is received from the WMI object. If it is longer than this value, the sensor shows a Down status. Enter an integer value or leave the field empty.

Extract Number Using Regular Expression

Define if you want to filter out a numeric value from the string received from the WMI object. You can convert this into a float value to use it with channel limits (see Sensor Channel Settings).

  • No extraction: Do not extract a float value. Use the result as a string value.
  • Extract a numeric value using a regular expression: Use a regex to identify a numeric value in the string and convert it to a float value. Define below.
    icon-book-arrowsSee also the example below.

Regular Expression

This setting is only visible if Extract Number Using Regular Expression is enabled above. Enter a regular expression to identify the numeric value you want to extract from the string returned by the WMI object. You can use capturing groups here.

Make sure that the expression returns numbers only (including decimal and thousands separators). The result is further refined by the settings below.

icon-i-bluePRTG supports Perl Compatible Regular Expression (PCRE) regex. You cannot use regex options or flags. For more details, see section Regular Expressions.

Index of Capturing Group

This setting is only visible if Extract Number Using Regular Expression is enabled above. If your regex uses capturing groups, specify which group is used to capture the number. Enter an integer value or leave the field empty.

Decimal Separator

This setting is only visible if Extract Number Using Regular Expression is enabled above. Define which character should be used as decimal separator for the number extracted above. Enter a string or leave the field empty.

Thousands Separator

This setting is only visible if Extract Number Using Regular Expression is enabled above. Define which character should be used as thousands separator for the number extracted above. Enter a string or leave the field empty.

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 that the sensor runs on (on the 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.
    For more information on how to find the folder used for storage, see section Data Storage.

icon-prtg-on-demandThis option is not available when the sensor runs on the Hosted Probe of a PRTG hosted by Paessler instance.

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

icon-i-roundYou 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.
    icon-i-roundThis option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channel Settings 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.

Inherited Settings

By default, all of the following settings are inherited from objects that are 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. For more information, see section Inheritance of Settings. To change a setting for this object only, disable inheritance by clicking the button next to inherit from under the corresponding setting name. You then see the options described below.

Scanning Interval

Click inherited_settings_button 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.

icon-i-roundSensors 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.

icon-i-roundIf you define error limits for a sensor's channels, the sensor immediately shows a Down status. No "wait" option applies.

icon-i-roundIf a channel uses lookup values, the sensor immediately shows a Down status. No "wait" options apply.

Schedules, Dependencies, and Maintenance Window

icon-i-roundYou 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.

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

icon-i-roundSchedules 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.

icon-i-roundTo 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 another 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 another 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.

icon-i-roundTo 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.

icon-i-round-redThis 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.

Access Rights

Click inherited_settings_button 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.

icon-book-arrowsFor more details on access rights, see section User Access Rights.

Example: Number Extraction with Regular Expression

icon-speechIf you want to extract a number in the response string using a regular expression (regex), note that the index for captures in this sensor is based on 1 (not on 0). Furthermore, capturing groups are not automatically created. The example below illustrates this issue.

Consider the following string as returned by a request for CPU usage:

 5 Sec (3.49%), 1 Min (3.555%), 5 Min (3.90%)

Assuming you would like to filter for the number 3.555, this is the percentage in the second parentheses. Enter the following regex in the Regular Expression field:

(\d+\.\d+).*?(\d+\.\d+).*?(\d+\.\d+) 

As Index of Capturing Group, enter 3. This extracts the desired number 3.555.

The index has to be 3 in this case because the capturing groups here are the following:

  • Group 1 contains 3.49%), 1 Min (3.555), 5 Min (3.90
  • Group 2 contains 3.49
  • Group 3 contains 3.555
  • Group 4 contains 3.90

Keep in mind this note about index and capturing groups when using number extraction.

icon-i-round-redIt is not possible to match an empty string with the PRTG regex sensor search.

icon-i-bluePRTG supports Perl Compatible Regular Expression (PCRE) regex. You cannot use regex options or flags. For more details, see section Regular Expressions.

More

Knowledge Base: My WMI sensors don't work. What can I do?

Knowledge Base: How do I create a WMI Custom Sensor?

Knowledge Base: Why do I have to store SQL sensor queries and custom scripts in files on the probe computer?

Edit Sensor Channels

To change display settings, spike filtering, and limits, switch to the sensor's Overview tab and click the gear icon of a specific channel. For detailed information, see section Sensor Channel Settings.

Notification Triggers

Click the Notification Triggers tab to change notification triggers. For detailed information, see section Sensor Notification Triggers Settings.

Others

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

Sensor Settings Overview

For information about sensor settings, see the following sections:

Keywords: