Windows plugin using DLL

Requirements to write a Windows plugin using DLL

Please make sure the following requirements are met to successfully write a Windows plugin using DLL:
  • Plugin must be written in C# (.NET framework 3.0 and above)
  • The output of the script should be in JSON format
  • Mandatory variables to be present in a class:
    • Version:  When there is any change in the version, the Site24x7 data center updates the template and creates a new template for that version. The default value is 1. If any change is done in the plugin, user must increment the version by 1. version should be whole numbers only. E.g. 1,2,3
    • Heartbeat: Alerts the plugin as down, when no data is received from the plugin by the Site24x7 data center. Value for heartbeat should be either true or false. By default, the value for heartbeat is true
    • The properties Version, DisplayName and Heartbeat will return a string object
  • Mandatory functions to be present in a class:
    • The class file must have DataCollect() method which will return a Directory<string, object>
  • Optional variables to be present in a class:
    • DisplayName: name of the monitor as displayed in the web client. For eg: if you create a plugin called "Site24x7 user", your plugin class should have a display name whose return value must be "Site24x7 user"
    • The class file can also have a Units() method, a key value pair with keys as the name of the attributes monitored in the plugin and the values as their respective units. This will return a Directory<string, object>
    • msg : The configured error message would show up in the Site24x7 web client if the monitor is down. This attribute should be placed parallel to the data attribute
To know more on how to write a Windows plugin using DLL and view a sample plugin file, refer here.
    • Related Articles

    • Install and configure an Oracle plugin in Windows

      Prerequisites Ensure that the Site24x7 Windows server monitoring agent is installed in the system where the Oracle instance is running. Ensure python3 is installed in the system and add it to the Windows path. Refer to the link below for adding ...
    • How to troubleshoot my Windows PowerShell Plugin?

      By default, the Site24x7 monitoring Windows agent will run as a SYSTEM user. In case, if you would like to verify if the plugin script is giving the output properly as SYSTEM user, follow these steps: Download PsExec from this link and extract the ...
    • Add a new Windows plugin

      Our open eco system for plugins give you the flexibility to create your own plugins and monitor data that you need, the way you want. You can also set thresholds to individual attributes and choose to get alerted if the set values exceed.  10 plugins ...
    • Troubleshoot connection errors in the MySQL plugin

      When configuring the MySQL plugin, you may encounter the following errors: Error : Connection Error - This error typically indicates that there is a problem establishing a connection to the database. Sometimes, this message is supplemented with an ...
    • How to view perfmon counters in Windows?

      To monitor specific Windows performance (perfmon) counters with Site24x7's plugin integration, you need to get the names of the performance counters from the Windows Performance Monitor on your server. Follow the steps below to get the names of the ...