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. 



    • Related Articles

    • Plugins

      A plugin is a piece of software that acts as an add-on. Plugins are a great way to customize and measure attributes and keep track of data that matters the most. Check out our out of the box plugins and custom plugins for both Windows and Linux. Know ...

    • How to increase the Script Execution Timeout value for plugins

      If a plugin's script execution time exceeds the Script Execution Timeout value configured in Site24x7, it could result in errors during plugin installation or disrupt the polling for existing plugin monitors. In such cases, you need to extend the ...

    • Troubleshoot "[Errno 111] Connection refused" error when installing Tomcat plugins

      When installing Tomcat plugins, you may encounter the following error: We failed to reach a server. Reason: [Errno 111] Connection refused: This error indicates that your client is unable to establish a connection to the Tomcat Manager URL, but the ...

    • Install the Net-SNMP package in Windows for SNMP-based plugins (iDRAC and HP iLO)

      Installing the Net-SNMP package is an essential prerequisite for configuring SNMP-based plugins like Dell iDRAC and HP iLO. Follow the steps below to install the Net-SNMP package, set the path of Net-SNMP, and test SNMP walk. Download and install the ...

    • Prerequisites to add plugins

      Check out the prerequisites before you add a plugin: Linux Windows Languages Supported Python or Shell VB, Batch, PowerShell, DLL Plugins Directory /opt/site24x7/monagent/plugins C:\Program Files (x86)\Site24x7\WinAgent\monitoring\Plugins  Condition ...