Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Custom with Retained Data

Custom monitors with Retained Data return the following information:

You can specify whether the monitor writes any returned data to the Uptime Infrastructure Monitor DataStore. You can use the retained data to later generate a Service Metrics report (see Service Monitor Metrics Report) or a Service Metrics graph (see Viewing System and Service Information).

You can also specify whether the monitor uses retained values as arguments in the custom monitor script. The values used are from the last instance the monitor was run. This most recent data sample can be used in cases where you would like to set alerts based on value comparisons.

When you wish to refer to retained values in a script, use the following environment variable as an argument:

%UPTIME_PREV_CUSTOM#%

Replace “ # ” with the ordered value the custom monitor is configured to save (i.e., 1 - 10 ).

For example, running a sample script called application.exe with the following arguments would make use of retained values for Variable 1 and Variable 5 as retained by the monitor:

%UPTIME_PREV_CUSTOM1% %UPTIME_PREV_CUSTOM5%

Configuring Custom Monitors with Retained Data

To configure Custom monitors with Retained Data, do the following:
  1. In the Custom with Retained Data monitor template, complete the monitor information fields.
    To learn how to configure monitor information fields, see
    Monitor Identification.
  2. Complete the following fields:
    • Script Name
      The name of, and path to, the script or program on the Monitoring Station that collects metrics on the system.

      Info
      The script or program that you specify must be executable by the uptime user account on the Uptime Infrastructure Monitor Monitoring Station. Ensure that the permissions are set correctly.
    • Arguments (Optional)
      Specify any arguments required by the script or program.
    • Pass retained variables from previous collection as environment variables
      Select this checkbox if you would like the monitor to be able to use the most recently collected variables as arguments in the script.
    • Variable 1 to Variable 10 (Optional)
      Specify up to 10 variables that your custom script returns to the Uptime Infrastructure Monitor Monitoring Station. If you click the Save for Graphing checkbox, these variables are saved to the DataStore.
    • Response Time
      Enter the Warning and Critical Response Time thresholds. For more information, see Configuring Warning and Critical Thresholds.
  3. Complete the following settings:
  4. Click Finish.

...

Plugin Monitors

Plugins are custom service monitors that are not part of the standard Uptime Infrastructure Monitor distribution, but can be integrated with it to augment the type of metrics collected. They are typically created by IDERA Client Support Engineers or Solutions Architects to address specific customer needs. Whether created by IDERA or other customers, plugins are hosted on the Grid, the community repository for custom monitors, gadgets, dashboards, and other enhancements. Each plugin on the Grid includes the main distributable archive, any applicable auxiliary files, and essential installation steps.

Installing and maintaining plugins can also be managed from within Uptime Infrastructure Monitor. Users can browse, install, and update plugins using the Extension Manager if their User Role permits plugin management (see Working with User Roles for more information).

Users who are allowed to manage plugins can access this option by clicking the Search for monitors link at the top of the Add Service Monitor pop-up window (accessed by clicking Services > Add Service Monitor). Clicking this link opens the Extension Manager, and displays the following:

  • INSTALL: the plugin is available on the Grid, but is not installed on your Uptime Infrastructure Monitor deployment
  • INSTALLED: the plugin is installed, and is available to be configured and linked to monitored Elements
  • UPGRADE: the plugin is installed, but there is an update available on the Grid

Installing and Upgrading Plugins

When you install a plugin through the Extension Manager, the plugin is downloaded from the Grid and installed automatically. A confirmation dialog indicates that the plugin is installed and is now available to be selected in the Add Service Monitor pop-up window. (The categories the plugin appears in depend on its service monitor definition; see Plugin Guide for more information.) The confirmation dialog also instructs you on follow-up steps, if applicable:

  • requires additional steps: some manual installation steps need to be performed
  • requires agent-side scripts: the plugin interfaces with an agent-side script, which needs to be installed on monitored Elements
  • restart the Data Collector service: the plugin introduces changes that require the Uptime Infrastructure Monitor Core (or Data Collector service) to be restarted

When upgrading a plugin, typically, all the necessary follow-up steps are already performed.

For additional information regarding the creation of custom and plugin service monitors, see: