Skip to content
DevTest Solutions - 10.3
Documentation powered by DocOps

Staging Document Editor - Metrics Tab

Last update January 14, 2016

The Metrics tab of the Staging Document Editor lets you select the test metrics to record.


You can also set the sampling specifications for the collection of the metrics and set an email alert on any metric that you have selected.

Metrics tab of the Staging Document Editor

The Metrics tab is divided into two sections. The top panel lists the default metrics, differentiated by color code. The bottom panel has the sampling parameters.

You can change the color that is used to represent any metric in the staging document. Click the color and select a new color and then save the staging doc. Change the color before staging the test.

You can add or delete metrics and set email alerts in the top panel.

The following types of metrics are available:

  • DevTest Whole-Test Metrics
  • DevTest Test Event Metrics
  • SNMP Metrics
  • JMX Attribute Reader (JMX metrics)
  • TIBCO Hawk
  • Windows Perfmon Metrics
  • UNIX Metrics through SSH

For more information about each metric, see Metrics Descriptions.

Add a Metric

Follow these steps:

  1. Click Add on the toolbar.
    A dialog to add metrics opens with a list of metrics that can be added.
  2. Select the target metric type and click OK.
    The Metric Selection dialog opens.
  3. Select the target subcategory for the metric and click OK.
    Subcategories are different for each metric. The newly added metric appears in the list of existing metrics in a different color.

For the descriptions of all the metrics in all categories, and details on how to configure them to include in reports, see Generating Metrics.

Set an Email Alert

To set an email alert on a specific metric:

  1. Click the Set Alert button corresponding to the metric.
    The Edit Alert dialog opens.
  2. You can set the acceptable limits for the metric (low and high value), and the details to be sent in an email. Provide the name of your email server and a list of email addresses.
    The email alerts that are added to staging documents store the SMTP password as an encrypted value. Also, if you open an existing staging document and then you resave it, the SMTP password is saved as an encrypted value.
    To add and remove email addresses, use the Add and Delete buttons at the bottom of the window.
  3. When you are finished, click Close.
    Notice that the Set Alert button is now an Edit Alert button on the Metrics tab.
Note: For the email alert to work, you also must set the SMTP server-related paths in the file.

Sampling Parameters

The bottom panel has two slider bars that let you set sampling parameters:

  • Sample rate: This parameter specifies how often to take a sample, or record the value of a metric. The sample rate is specified as a time period, and is the reciprocal of the sampling rate.
  • Samples per interval: This parameter specifies how many samples are used to create an interval for calculating summary values for the metric.

Taking sample values every minute (Sample rate=1 minute) and averaging every 60 samples (Samples per interval=60) produces a metric value every minute and a summary value (average) every hour.

For example, the default is a 1-second sample rate, and 10 samples per interval (making an interval 10 seconds).

Staging Document sampling parameters slider

The preceding example uses 5 seconds per sample and 25 samples per interval. Those values produce a metric value every 5 seconds and a summary value every 125 seconds.

The metric values are stored in XML files or database tables to include in reports (see reports).

Was this helpful?

Please log in to post comments.