Reserved keys in plugins

Reserved keys in plugins

Reserved keys are attributes used in plugin scripts by Site24x7. Ensure they are not used again in the plugin script(s), which could alter the behavior of the plugin. 

For example, consider a custom plugin where the 'status' attribute is used and its value is found to be 0. Since the 'status' attribute is a plugin reserved key in Site24x7 to determine the status of the plugin monitor, the monitor will be marked as Down. To avoid this, use some other attribute name to denote the actual metric.

The following are the reserved keys used for Windows and Linux plugins:
  1. plugin_version
  2. version
  3. displayname
  4. message
  5. msg
  6. heartbeat_required
  7. units
  8. status
  9. data
  10. running
  11. St
  12. ST
  13. Re
  14. EC
Know how to get alerted for an exception in a custom plugin.