CustomSensors Extension

Introduction

The CustomSensors extension is a restartable extension that provides the Custom Script sensor in the Health section in Studio.

Access Information

Access the Extensions section via System Configuration > Extensions.

Access the Health section via System Maintenance > System Overview > Health.

For more information, see System Administration: System Health.

Custom Script Sensor

Each instance of this sensor runs a custom Appway script to determine its state.

The script must return a string in the format STATE;MESSAGE, where:

  • STATE := UNKNOWN|OK|WARN|ERROR
  • MESSAGE := Any string

Instances of this sensor can be added by adding two extension configuration lines each, one with the state script to be executed and one with the polling interval (in seconds):

  • extensions.CustomSensors.sensors.customscript.XYZ.script
  • extensions.CustomSensors.sensors.customscript.XYZ.pollinginterval

XYZ has to be replaced with a unique sensor ID for each added script sensor and is used as the display name in the System Health panel.