PRTG Manual: Script v2 Sensor
The Script v2 sensor runs a python script (.py) on the probe system.
The return result of this sensor must comply with the provided JavaScript Object Notation (JSON) schema. For more information, see the Remarks below.
This sensor is in beta status. The operating methods and the available settings are still subject to change. Do not expect that all functions work properly, or that this sensor works as expected at all.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: Script v2
- French: Script v2
- German: Script v2
- Japanese: Script v2
- Portuguese: Script v2
- Russian: Script v2
- Simplified Chinese: Script v2
- Spanish: Script v2
- This sensor requires that the Beta Sensors experimental feature is enabled.
- This sensor requires that Python is installed on the probe system.
- This sensor requires that you store the script file on the probe system. In a cluster, copy the file to every cluster node.
- This sensor supports the channel IDs 10 to 2,147,483,647.
- This sensor supports IPv6.
- This sensor supports up to 50 channels.
- You can define placeholders in credentials for script sensors settings that are higher in the object hierarchy.
- This sensor has a medium performance impact.
- This sensor uses lookups to determine the status values of one or more channels.
- This sensor comes with example scripts. For more information, see the Knowledge Base: I want to use the Script v2 sensor example scripts. What do I need to know?
- For more information about the JSON schema that this sensor uses, see the Knowledge Base: Where can I find the JSON schema against which the Script v2 sensor validates my script output?
You 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.
Requirement |
Description |
---|---|
This sensor requires that the Beta Sensors experimental feature of PRTG is enabled.
|
|
This sensor requires that Python is installed for the Windows user account that the probe runs under. |
|
This sensor requires that the script file is stored in the \Custom Sensors\scripts subfolder of the PRTG program directory of the probe system on Windows systems or in the /var/local/prtg/scripts directory of the probe system on Linux systems. |
Setting |
Description |
---|---|
Sensor Name |
Enter a 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 |
The tags that the sensor inherits from its parent device, parent group, and parent probe.
|
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.
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
|
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 ( |
Setting |
Description |
---|---|
Name |
Select one or more Python scripts from the list. PRTG creates one sensor for each script that you select. The sensor executes it with every scanning interval. This list shows all Python script files that are available in the \Custom Sensors\scripts subfolder of the PRTG program directory of the probe system on Windows systems or in the /var/local/prtg/scripts directory of the probe system on Linux systems. For the files to appear in this list, store the files in this subfolder with the extension .py.
|
Type |
The type of the script file. |
Setting |
Description |
---|---|
Timeout (Sec.) |
Enter a timeout in seconds for the request. Enter an integer. The maximum timeout value is 900 seconds (15 minutes).
|
Parameters |
If your script file uses parameters, you can enter them here. You can use placeholders as well. Enter a string or leave the field empty.
|
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.
|
Graph Type |
Define how different channels are shown for this sensor:
|
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. |
Setting |
Description |
---|---|
Result Handling |
Define what PRTG does with the sensor result:
|
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.
For more information, see section Root Group Settings, section Scanning Interval.
Schedules, Dependencies, and Maintenance Window
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 schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.
For more information, see section Root Group Settings, section Access Rights.
Which channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.
For more information, see section Root Group Settings, section Channel Unit Configuration.
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 |
Execution Time |
The execution time of the script |
Status |
The status that the script returns
|
[Value] |
The values that the script file returns in several channels |
KNOWLEDGE BASE
What security features does PRTG include?
I want to use the Script v2 sensor example scripts. What do I need to know?
Where can I find the JSON schema against which the Script v2 sensor validates my script output?