Setting the thresholds for a gauge

A gauge has three display levels: low, medium, and high. This task shows how to set the thresholds for each display level.

Before you begin

First note the following for each gauge you want to modify:

  • The name of the gauge

    The name appears beneath each gauge on the Gauges page.

  • The value of the thresholds for transitions from low to medium and from medium to high.

You express each threshold as a percentage of the gauge's range (maximum value minus minimum value). Use the following method to determine the percentage value of each threshold:

  1. Decide on the actual values on the gauge that are to be the threshold points.
  2. Calculate the percentage equivalent of each point as follows:

    threshold(%) = (threshold - Gmin) / (Gmax - Gmin) * 100

    where:
    threshold(%)
    is the threshold expressed as a percentage.
    threshold
    is the threshold point on the gauge.
    Gmin
    is the minimum value of the gauge.
    Gmax
    is the maximum value of the gauge.

About this task

To change the thresholds for one or more gauges:

Procedure

  1. Log in to the Web GUI server using a command-line interface.
  2. Go to the directory: WEBGUI_HOME/etc/configstore/ncwMetrics.
  3. Open the XML file for a gauge using a text editor.
    The name of the file is based on the name of the gauge on the Web GUI.
  4. Locate the <metric> element and:
    1. Set the value of the threshold1 attribute to the percentage value for the low to medium transition.
    2. Set the value of the threshold2 attribute to the percentage value for the medium to high transition.
  5. Save the file.
  6. Repeat steps 3 to 5 for the other gauges you want to change.
  7. Exit from the text editor.
  8. Depending on the configuration of your site, you might need to restart the server.

Example

The characteristics and requirements for a gauge are:

  • The gauge has a minimum value of 5 and a maximum of 55.
  • The threshold points are 10 and 50.

The thresholds, expressed as percentages, are:

  • Lower threshold:

    (10 - 5)/(55 - 5) * 100 = 10%

  • Upper threshold:

    (50 - 5)/(55 - 5) * 100 = 90%

The <metric> element for this gauge is:

<metric name="adminconnections"
	displayName="Administrator" 
	displayNameKey="ncw.metric.adminconnections.displayname"
	description="Number of Administration client connections"
	descriptionKey="ncw.metric.adminconnections.description" 
	units="clients" 
	unitsKey="ncw.metric.adminconnections.units"
	maxValue="55"
	minValue="5"
	threshold1="10"
	threshold2="90">