PRTG Manual: WMI Custom String Sensor

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

i_round_blueThe sensor can also show the retrieved string value in the sensor message.

i_round_blueIf the WQL query returns numeric values, use the WMI Custom sensor.

WMI Custom String Sensor

WMI Custom String Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

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

Remarks

i_podYou cannot add this sensor to the hosted probe of a PRTG Hosted Monitor instance. If you want to use this sensor, add it to a remote probe device.

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.

Custom Query Specific

Setting

Description

WQL File

Select a .wql file. The sensor executes it with every scanning interval.

The list contains WQL scripts that are available in the \Custom Sensors\WMI WQL scripts subfolder of the PRTG program directory on the probe system. Store your script there. If used on a cluster probe, you must store the file on all cluster nodes.

i_round_blueIf the 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 channel.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

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.

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

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

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

  • wmicustomsensor

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

i_round_blueUsually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.

Custom Query Specific

Custom Query Specific

Custom Query Specific

Setting

Description

Namespace

Enter the WMI namespace for the query.

.

WQL File

Shows the .wql file that this sensor executes with every scanning interval.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

i_round_blueIf the 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 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 the sensor receives from 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 (Down Status if Not Included)

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.

i_round_redThe search string must be case sensitive.

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

Response Must Not Include (Down Status if Included)

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.

i_round_redThe search string must be case sensitive.

i_round_blueIf the data does include the search pattern, the sensor shows the 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.

i_round_blueThe characters * and ? work as placeholders. * stands for no number or any number of characters and ? stands for exactly one character. You cannot change this behavior. The literal search for these characters is only possible with a regex.

  • Regular expression: Search with a regular expression (regex).

i_round_bluePRTG supports Perl Compatible Regular Expression (PCRE) regex. For more details, see section Regular Expressions.

Maximum String Length

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 the Down status. Enter an integer or leave the field empty.

Numeric Value Extraction 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.

  • Do not use extraction: Do not extract a float value. Use the result as a string value.
  • Use a regular expression for extraction: Use a regex to identify a numeric value in the string and convert it to a float value. Define below.
    i_square_cyanSee also the example.

Regular Expression

This setting is only visible if you select Use a regular expression for extraction above. Enter a regex to identify the numeric value you want to extract from the string returned by the WMI object. You can use capturing groups here.

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

i_round_bluePRTG supports Perl Compatible Regular Expression (PCRE) regex. For more details, see section Regular Expressions.

Index of Capturing Group

This setting is only visible if you select Use a regular expression for extraction above. If your regex uses capturing groups, specify which one captures the number. Enter an integer or leave the field empty.

Decimal Separator

This setting is only visible if you select Use a regular expression for extraction above. Define the character for the decimal separator of the number. Enter a string or leave the field empty.

Thousands Separator

This setting is only visible if you select Use a regular expression for extraction above. Define the character for the thousands separator of the number. Enter a string or leave the field empty.

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.

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

Sensor Display

Sensor Display

Sensor Display

Setting

Description

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.

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

Inherited Settings

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 b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou 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 schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Number Extraction with Regular Expression

i_speechIf you want to extract a number in the response string via a 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 must 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 this note about index and capturing groups in mind when using number extraction.

i_round_redIt is not possible to match an empty string with the PRTG regex sensor search.

i_round_bluePRTG supports Perl Compatible Regular Expression (PCRE) regex. For more details, see section Regular Expressions.

Channel List

i_round_blueWhich 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 in percent.

Response Time

The response time in msec

i_round_blueThis channel is the primary channel by default.

More

i_square_blueKnowledge Base

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

How do I create a WMI Custom sensor?

What security features does PRTG include?

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