Versions Compared

Key

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

...

Full details about what the various attributes of the XML file's element tag control are available here: 'Integration Guide > in the UIM Plugin Guide'. But for now, we'll just cover the most important details from the example above:

  • name. This is the name of variable itself. In the examples above, you can see this is either set to process_windows or process_linux. You need to have at least one of these defined for every plugin.
  • parameter_type. This can be either input or output. Input parameters will be are set as an environment variable at run time. We'll talk more about output type parameters below.
  • data_type. This can be either string or integer. This usually more important on the output variable side of things, as it also controls what WARN/CRIT threshold comparisons can made against it.
  • hidden. This can either be true or false . This controls whether or not a parameter is displayed on the Edit Service Monitor Screen. A hidden variable can not cannot be edited by a user in the GUI, but can still be updated in the database directly.
  • <default_value>. This provides the default value for a variable. Which , which is especially important for the examples above, as both are set as hidden and are not editable from the GUI.

Now that we've looked at the process_windows or process_linux fields, let's take a look at some 'input' variables for this monitor. If your you are familiar with the ' Custom Remote Monitor ' in Uptime Infrastructure MonitorUIM, you've likely seen this combination of Agent Port, Agent Password, and Remote Script fields before, as these are commonly used to trigger custom agent scripts.

  • We can see the ' Agent Port ' parameter is setup set up as type integer, and has the default port 9998 already set for us.
  • The password parameter is setup as a data_type of string, but also has the gui_type set to <password /> which as mentioned above, tells Uptime Infrastructure Monitor UIM to encrypt this value when it's stored in the database, as well as blank out the field itself when displayed in the GUI.
  • The remote_script & and args fields are both set up as basic string fields with nothing special about them. 

...