Page History
| Table of Contents | ||||
|---|---|---|---|---|
|
Introduction
With the introduction of the Extension Manager in up.time 7.3, plugins and gadgets are now even easier to install. As part of this change, we have also posted the source code for all plugins on GitHub. Use these examples as starting templates for building your own plugins.
What's a plugin?
Plugins are custom service monitors that allow Uptime Infrastructure Monitor to monitor and collect metrics from a variety of different sources. In most cases they're a combination of XML which defines the input and output variables, and some simple shell scripts that handle the actual task of monitoring. These monitors usually consists of some sort of login or connectivity check, as well as exposing key metrics in a format that can be understood by UIM.
The specifics of the scripts themselves depend on what protocol and libraries are required to the talk to device/system/service on the other end. But this topic explains how to use element details from UIM to control where these scripts are targeted as well as how to define your own input variables that are stored as service monitor settings in UIM.
Input variables
UIM uses environment variables as the main way of exposing information to all custom scripts. The most important of these environment variables is UPTIME_HOSTNAME which provides the hostname of the element the service monitor is running against. Next comes the various input variables from the monitor's xml file, which provide the specific details needed for the script itself. The best way to understand how this works is to take a look at an example of the xml definition a monitor, how that looks as service monitor settings in the GUI, and finally how all this information ends up as environment variables in the script.
A good example is the Custom Remote Monitor as this plugin also provides a great starting point for custom monitors that also rely on an agent-side script. But for now we're just going to focus on the XML details and the script that runs directly on the monitoring station itself. The full contents of the xml file are available on GitHub at this link.
XML - Grid Info
The first section of the XML file contains details about the name of the plugin/service monitor and which category its shows up under on the Add Service Monitor screen.
...
Next comes the elements section of the XML file. This is a list of element tags which define the input and output variables you see when editing a service monitor in the Uptime Infrastructure Monitor GUI. The contents of these variables are stored in the Uptime Infrastructure Monitor datastore just like regular service monitors.
XML - Elements
The first of these elements are the process_linux & process_windows which control which script actually gets run on the monitoring station when a service monitor is triggered.
...
| Code Block | ||
|---|---|---|
| ||
<element name='port' parameter_type='input' data_type='integer'
gui_basic='1' range_type='0' units=''>
<control_options>size:8</control_options>
<default_value>9998</default_value>
<short_description>Agent Port</short_description>
<long_description>up.time Agent Port (default is 9998)</long_description>
<validation_rule/>
<error_message/>
<gui_type>
<integer/>
</gui_type>
</element>
<element name='password' parameter_type='input' data_type='string'
gui_basic='1' range_type='0' units=''>
<control_options>size:8</control_options>
<default_value></default_value>
<short_description>up.time Agent Password</short_description>
<long_description>Password setup on the agent system</long_description>
<validation_rule/>
<error_message/>
<gui_type>
<password/>
</gui_type>
</element>
<element name='remote_script' parameter_type='input' data_type='string'
gui_basic='1' range_type='0' units=''>
<control_options>size:8</control_options>
<default_value></default_value>
<short_description>Remote Script / Command</short_description>
<long_description>Script name (posix) or command (win) setup on the agent</long_description>
<validation_rule/>
<error_message/>
<gui_type>
<string/>
</gui_type>
</element>
<element name='args' parameter_type='input' data_type='string'
gui_basic='1' range_type='0' units=''>
<control_options>size:8</control_options>
<default_value></default_value>
<short_description>Arguments</short_description>
<long_description>Arguments that will be sent to the remote script</long_description>
<validation_rule/>
<error_message/>
<gui_type>
<string/>
</gui_type>
</element> |
Editing the Service Monitor view
Now that we've talked about the details that go into a plugin's XML file, let's take a look at how these input variables are displayed in the UIM GUI when creating an instance of the Custom Remote Monitor:
...
- The first thing you notice is that we don't see either the
process_windowsorprocess_linuxfields, but that's to be expected here, as those fields where set as hidden. - The contents of the password field are obscured, as expected.
- The Remote Script and Arguments fields are basic string fields.
- You can also see the two output values for this monitor, but we'll talk about those more later.
Environment variables
Next let's take a look at how all these parameters and input fields come together as the environment variables that are used by the script itself. Environment variables aren't normally displayed or retained by the service monitor when it runs, but they're easy to capture for testing and debugging purposes by adding the appropriate command to your shell/bat script:
...
- They all start with
UPTIME_and the contents of the name attribute from the element tag. - The
UPTIME_HOSTNAMEhas the hostname of the element the monitor is running against. - The remaining input variables show up as expected with the same contents as we set in the GUI example above.
Shell/Bat wrapper scripts
Now let's take a quick look at what the custom_remote.bat and custom_remote.sh scripts actually do with these environment variables. As mentioned above, most of the UIM-provided plugins rely on a common PHP script to perform the actual task of monitoring. As such, the bat and sh scripts are just responsible for telling UIM's bundled php executable to run the required script, and then pass along the environment variables in the correct order. The specifics of how this done obviously varies between both Windows and Linux, so let's take a look at both methods.
...
From the example here, you can see that windows allows you access environment variables by wrapping the name in % characters, i.e. %UPTIME_HOSTNAME%. So we've used that to arrange the input variables from xml into the order expected by the rcs.php script. You may also notice the ..\..\..\apache\php\php.exe path used to start php. Whenever a script monitor is triggered the current working directory is set to the location of the script itself, which is in this case is C:\Program Files\uptime software\uptime\plugins\scripts\monitor-custom-remote\monitor-custom-remote.bat. But the location of the UIM directory can vary depending on where it was initially installed. So we use a relative path from the plugin's location to find <uptime_dir>\apache\php\php.exe. When making your own plugins, you can usually simplify this by using the hard-coded path of your UIM directory.
...
We won't get into the details of the rcs.php script itself as this will typically change changes depending on the details of the plugin itself. But the full contents of this file on GitHub here if you are interested.
Output variables
We've looked at all the details that go into a plugin scripts input variables all the way from the xml file, the Edit Service Monitor Screen, and how they finally get exposed to the custom script as environment variables. Now let's take a look at how a custom monitor can return it's output back to UIM, and the different things we can do it with.
XML - Output variables
Just like input variables, output variables are also defined in the xml file via the same element tags. They're covered by the same basic rules outlined above, and full details for their XML definitions are available in the Plugin Guide.
...
When this is triggered via the 'Test Service Monitor' button, you would see something like this:
The first thing you'll likely notice here is that the Monitor monitor has set it's its Status to OK, which is the default state for a service monitor that's run successfully, as long as none of it's its threshold comparisons are triggered. The 'message' Message line shows use that the process returned a valid status, which is then followed by the output from the plugin monitor, i. iee. 'custom1 uptime_core is stopped MON Role'.
You may wonder where the 'custom1' string is coming from as it's not in the example output of the agent side script above. This is inserted by the rcs.php and used to mark that the output from the agent script should link up with the 'custom1' variable from the XML. Which you can see on the next line 'Output ' where 'custom1' has been is replaced with that variable's Short-Description also form short description also from the xml. The next line is an example of Uptime Infrastructure Monitor UIM attempting parse the second line of output from our agent script into a variable called 'MON' but because this isn't defined in our xml file, it won't be available for comparisons within the GUI. The final line here is the Response time value, which is the special timer mentioned above.
The general take-away takeaway from this test service monitor example is that when Uptime Infrastructure Monitor UIM is able to parse /and understand the output from a script, the matched up variables will be are listed line by line after the message. With the ' name ' of the variable replaced by it's its short description. If you don't see your output variable listed like this, then double check the names of your output variables and how the script itself is returning its output.
Installing plugins
Now that we've seen how plugin monitors are made of a combination an XML file that defines the various inputs/outputs and a script performs the actual task of monitoring, Letlet's take a look how these pieces are packaged together, and how Uptime Infrastructure Monitor UIM knows which plugins are available for installinstallation.
Packaging plugins
The best way to understand how Uptime Infrastructure Monitor UIM plugins are packaged is to take a look at the zip file for a plugin itself. We'll use the same Custom Remote Monitor from above as our example again. The actual zip file that is used when installing the plugin is located within this repo's 's dist' folder folder, along with some .upk files (The legacy plugin format used by older versions of Uptime Infrastructure Monitor).
You can easily download the 'the monitor-custom-remote.zip' yourself, and look at the contents directly, but the contents of that archive are just a zipped-up version of the repo's ' pkg ' directory, which you can easily view on GitHub here.
...
The contents of the zip/pkg folder are made up of the xml file that we've already discussed in detail above, and a mix of one or more 'files' foldersfolders. These files folders contain the actual scripts that will be extracted into place on the Uptime Infrastructure Monitor UIM monitoring station. The reason for the files-win & and files-posix folders are that plugins may require different files or scripts depending which OS (ie. Windows or Linux) the Uptime Infrastructure Monitor UIM monitoring station is running. As such, the contents of the 'files-win' folder will is extracted only be extracted on Windows monitoring station, and the 'files-posix' folder will is extracted only be extracted on a Linux monitoring station.
| Info |
|---|
As mentioned before, most of the plugins created by Uptime Infrastructure Monitor UIM are intended for cross-platform use. This is why is most of them they have all three of these 'files ' folders. When creating your own plugin monitor, you can focus just on the OS platform of your Uptime Infrastructure Monitor UIM monitoring station, and simplify the packaging of your plugin by placing all of the scripts within the 'files ' folder. |
The mechanism for how these 3 three folders are extracted during the plugin's installation are the same general process whether the monitoring station is running Windows or Linux. Which is that each of the 'files ' folders will be is extracted into the directory where Uptime Infrastructure Monitor UIM is installed on the monitoring station. Any sub-folders within the plguinplugin's 'files ' folders will be is created along the way if they don't already exist. Though in most cases, you'll want to place all your plugin's scripts/files within it's its own sub-folder in uptime_dir/plugins/scripts/.
| Info |
|---|
Another thing you may notice with some of the plugins created by uptime is that they have scripts that go in both the |
So in the case of the Custom Remote Monitor's 'files' folder, you'll notice it contains some sub folders (ie. plugins/scripts/monitor-custom-remote ) which eventually contain a single rcs.php file.
When installed on a Linux monitoring station, those files will end up in a location similar to below. ( In this example, Uptime Infrastructure Monitor UIM was installed in the default default /usruser/local/uptime_location). The 'monitor-custom-remote.sh' file comes from a similar sub-folder within the 'files-posix' folder.
Similarly, on a Windows monitoring station that file would end up in the location similar to below. ( In this example Uptime Infrastructure Monitor , UIM was installed into the default default C:\Program Files\uptime software\upUptime Softwarup.time\[location for Windows)]. The 'monitor-custom-remote.bat' file comes from a similar sub- folder within the plugin's 'files-win' folder.
Extension.json
Now that we've seen how a plugin monitor is packaged into it's own zip file, the last piece we need to look at the extension.json file that the monitoring station uses to know which plugins are available for install and where to get the associated zip files. By default Uptime Infrastructure Monitor will attempt , UIM attempts to get these details from our website at this location: http://the-grid.uptimesoftware.com/extension.json on our website.
In order to install your own plugins for testing, you'll need to create your own copy of this file that includes details about where to locate your own plugin files. The general process for that is outlined in this KB article: How To Install Plugins Without Direct Internet Accessin How to install plugins without direct internet access. Though that article focuses on how to internally mirror the currently available plugins for environments where the Uptime Infrastructure Monitor UIM server doesn't have direct access to the external internet. In our situation, we instead need to use the same general process to create our own extension.json file that lists details about our own plugins.
Each plugin listed will need needs a entry in the json file similar to the below example of the 'Custom Remote Monitor':
...
Most of these fields are pretty self explanatory and match up with similar fields from the monitor's XML file. The most important of these fields is is git_file_target which tells Uptime Infrastructure MonitorUIM's extension manager where to find the zip file it needs to download to install the plugin. Most of the plugins provided by Uptime Infrastructure Monitor UIM have this field pointing to a location on GitHub.com, though that isn't required, and you can place these files anywhere that is accessible from your monitoring station over http.
The next most important fields for a plugin are the 'name' & and 'version' as these are used to figure out which plugins are currently installed within Uptime Infrastructure Monitor UIM and if they're running the current version. A combination of these two fields controls whether a user will see sees the Installed/Install/Upgrade buttons within the extension manager. The contents of the name field in the JSON needs to exactly match the XML's class tag.
Contributing a plugin
By now you've hopefully been able to create your own plugin monitor for use with Uptime Infrastructure Monitor and are asking yourself how you can share your creation with other Uptime Infrastructure Monitor UIM users.
Choosing a license
One thing you may not of thought about much more when creating software/scripts for internal project is 'What Copyright License , "What copyright license should I release this under?'"
If your you are not aware, there's a variety of different copyright licensing models available for open source software that outlines what changes someone can make to your code and how can they share it among others. At Uptime Infrastructure Monitor we We recommend using one of the ' Creative Commons ' Licenses as they provide easy to understand descriptions of what the license covers. Details about these licenses are available at: https https://creativecommons.org/licenses/.
Of the licenses listed on the Creative Commons website, we recommend using the Attributionthe Attribution-ShareAlike with plugins as it provides the best fit for how plugins are typically created and expanded upon. Once you've chosen the appropriate license for your plugin, you'll need to mention it somewhere within the plugin itself, typically either as part of the readme itself or by adding a license.txt file to your plugin repo. See this page on GitHub for some common ways people handle this.
Putting your plugin on GitHub
If you haven't been using git or some other version control tool while creating your plugin then it's time to create a repository for it on GitHub, as that's the easiest way to share your creation with us and make it available for download via the Extension Manager. Here's some documentation on GitHub.com that covers the basics of howto create your own repository and a general introduction for working with git.
Once your plugin is available on GitHub it's time to contact uptimecontact uptime-support@idera.com and let us know about your creation. From there we'll take a look at what your plugin does, and how it works, and do some of the remaining tasks involved in making it available for download via Uptime Infrastructure Monitor's extension manager.