PRTG Manual: Additional Sensor Types (Custom Sensors)

\Custom Sensors\EXE

The following custom sensors are available by default:

• Demo Batchfile - Returns 200.bat
• Demo Batchfile - Set sensorstate to error.bat
• Demo Batchfile - Set sensorstate to warning.bat
• Demo Cmd - Returns 200.cmd
• Demo EXE - Returns a random integer.exe
• Demo EXE - Returns number of files in folder (parameter).exe
• Demo EXE - Returns user of process.exe
• Demo Powershell Script - Available MB via WMI.ps1
• Demo Powershell Script - InterruptsPerSec via WMI.ps1
• Demo Powershell Script - Powershell Version.ps1
• Demo Powershell Script - Returns a fixed integer.ps1
• Demo Powershell Script - Returns a random integer.ps1
• Demo Powershell Script - Returns Random Integer and Warnings.ps1
• Demo VBScript - InterruptsPerSec via WMI.vbs
• Demo VBScript - Multiplies two integers(2 parameters).vbs
• Demo VBScript - Returns a fixed float value.vbs
• Demo VBScript - Returns a fixed integer.vbs
• Demo VBScript - Returns a random value.vbs
• Demo VBScript - Returns number of svchost processes.vbs
• Demo VBScript - Returns user of process.vbs
• Demo VBScript - Returns warning depending on number of svchost processes.vbs
• Demo VBScript - Timezone via WMI.vbs
• Demo VBScript - UTCTime via WMI.vbs
• Load_Test_CPU_1_Mio_Primes.exe
• Load_Test_CPU_10_Mio_Primes.exe
• Load_Test_Disk_Write_Read_1000_files.exe
• Load_Test_Disk_Write_Read_10000_files.exe
• Load_Test_Memory_Allocate_And_Free_400MB.exe

To create a new sensor based on one of these files, create a new EXE/Script sensor and choose the respective file from the EXE/Script list in the sensor settings.

We recommend that you not edit the demo files. Create your own new files and make sure to give them unique names that do not start with Demo, for example.

\Custom Sensors\EXEXML

The following custom sensor is available by default:

• Demo Batchfile - Returns static values in four channels.bat

To create a new sensor based on one of these files, create a new EXE/Script Advanced sensor and choose the respective file from the EXE/Script list in the sensor settings.

\Custom Sensors\hl7

The following custom sensors are available by default:

• ADT_A08.hl7
• ORM_O01.hl7

Each file contains an HL7 message that is conform to the HL7 message format. To create a new sensor based on one of these files, create a new HL7 sensor and choose the respective file from the HL7 Messages list in the sensor settings. You can override certain message headers in the files via the sensor settings.

\Custom Sensors\python

The following custom sensor is available by default:

• sensor_example.py

This Python example script only returns fixed values in two channels to demonstrate the usage. To create a new sensor based on this file, create a new Python Script Advanced sensor and choose the file from the Script list in the sensor settings.

\Custom Sensors\rest

The following custom sensors are available by default:

• kemp.loadbalancer.template: maps values returned by the RESTful API of a KEMP load balancer to channels, for example, CPU usage, memory usage, traffic
• prtg-sensor-stats.template: maps values returned by the PRTG API to channels that show the count of each sensor status on the local probe
• windows.docker.container.stats.template: maps values returned by the Docker Engine API to channels, for example, CPU usage, memory usage, traffic, input/output (I/O)
• wunderground.template: maps values returned by the Weather Underground API to channels, for example, temperature, dew point, pressure, wind speed, wind direction

To create a new sensor based on one of these files, create a new REST Custom sensor on the device that provides the REST API and choose the file from the REST Configuration list in the sensor settings.

\Custom Sensors\scripts\examples\python

The following example scripts are available by default:

• dice_roll.py
• dropbox_space_free.py
• hybrid_parameters_ping.py
• remote_ssh_linux_network.py
• remote_ssh_linux_system_load.py

To use the example scripts, copy them to the \Custom Sensors\scripts subfolder of the PRTG program directory. To create a new sensor based on one of these files, create a new Script v2 sensor and choose one or more Python scripts from the list in the script specific settings. PRTG creates one sensor for each script that you select.

\Custom Sensors\sql\[dbms]

The following custom sensor is available by default:

• Demo Serveruptime.sql

You can find this demo SQL query script in each subfolder for each supported database management system (DBMS): \adosql, \mssql, \mysql, \oracle, \postgresql

To create a new sensor that uses one of the scripts in the dbms folders, create the according sensor (see above for supported sensors) and choose the respective file from the SQL Query File list in the sensor settings.

\Custom Sensors\WMI WQL scripts

The following custom sensors are available by default:

• Demo WQL Script - Get Win32LogicalDiscFreeMB.wql
• Demo WQL Script - Get Win32OsBuildnumber.wql
• Demo WQL Script - Get Win32PercentProcessorIdleTime.wql
• Demo WQL Script - Get Win32PercentProcessorTime.wql

To create a new sensor based on one of these files, create a new WMI Custom sensor and choose the respective file from the WQL File list in the sensor settings.