...
- the main distributable is in .ZIP format
- the plugin scripts and other contents are structured in subdirectories:
/files: contains all files commonly used across different platforms (required)/files-posix: contains Linux-specific files (optional)/files-win: contains Windows-specific files (optional)
- an XML file at the root of the distributable that defines the plugin
Be sure to check out the following series of topics that help you create unique service monitors in Uptime Infrastructure Monitor:
Understanding the Plugin's XML Definition
...
| Child element of <elements> | Description |
|---|
element hidden | Determines whether the plugin is hidden in the Uptime Infrastructure Monitor interface. Enabling this allows you to create hidden plugins. optional; default false |
class | The name of the plugin as displayed in the Uptime Infrastructure Monitor interface (for example, the Add Service Monitor page). |
exec | References to any support classes that are required to run the plugin. |
erdc_version | The version scheme supported is 0.0 (major and minor version). A minor-minor version (for example, 1.2.1) is not processed. |
category | The main category this plugin belongs to. This will help others find the plugin on the Grid, and this is where the plugin will be listed on the Add Monitors page. - Advanced and Script Monitors
- Applications - All Types
- Applications - Databases
- Applications - Email
- Applications - General
- Applications - Web Services
- Domain Services
- End User Experience Monitors
- Network Device Monitors
- Network Service Monitors
- Operating System Monitors
- Storage Monitors
- VMware Monitors
|
category_related | Other categories the plugin is related to, separated by commas. |
grid_info | This element wraps child elements that describe the plugin specifically for the Grid. |
| Child element of <grid_info> | Description |
|---|
supported_versions | The versions of the Uptime Infrastructure Monitor Monitoring Station supported by this plugin. The version scheme supported must match Uptime Infrastructure Monitor releases (in 0.0 format), and it needs to be a comma-separated list of every version supported. | supported_platforms | possible values: - linux
- windows
- linux, windows
| requires_agent_scripts | If "true," indicates that the administrator is also going to have to install or deploy agent-side scripts as a follow-up step to installing the plugin on the Monitoring Station. If this is enabled, the user will see a related message on the Extension Manager, directing them to the plugin's Grid page for more information. optional; default false | upgrade_in_place | If "true," indicates this version will overwrite previous versions of the plugin as part of an automatic upgrade. optional; default false |
|
help | Help text for the plugin that is displayed when the user screams "help!" as loud as they can. lol j/k – it's what appears as a tool tip for the plugin on the Add Service Monitor page. |
elements | Describes what the plugin processes and inputs and outputs, and how these are presented to, and configured by, Uptime Infrastructure Monitor users. |
| Attributes of <elements> | Description |
|---|
name | The label of the input or output field in the Uptime Infrastructure Monitor interface, during plugin configuration. | parameter_type | Determines whether this child element is taking data from the Uptime Infrastructure Monitor user and passing it to the plugin script, or taking data output by the plugin script for use in Uptime Infrastructure Monitor. Possible values:
| data_type | The expected data type that will be sent to, or returned by, the plugin script. - boolean
- datetime
- decimal
- integer
- ranged (output only)
- string
| gui_basic | Determines whether the element appears in a standard or advanced view in the configuration screen. default enabled (1) | range_type | default is disabled (0) | units | adds a label in the GUI to help the user determine what to input | | Child elements of <element> | Description |
|---|
control_options | Determines the size of the text input field during plugin configuration. | default_value | Populates the field with a default value. | short_description | The name of the configuration field in the Uptime Infrastructure Monitor interface. | long_description | The description that appears as a tool tip. | validation_rule | Optionally use a child element (for example, <integer/> or <alphanumeric/>) to indicate how to validate the input data. | error_message | Message provided to the user if the validation rule fails. | gui_type | Indicates how the element is presented and configured in the UI. Use one of the following child elements: - boolean
- decimal
- integer
- password
- single_select
- string
The single_select child element uses a type attribute (for example, dropdown or radio) that indicates the type of GUI selection widget that will be used. A value child element then defines each of the selector options. For example: <gui_type>
<single_select type="dropdown">
<value>1</value>
<value>2</value>
<value>3</value>
</single_select>
</gui_type> |
|
Save
