Skip to Content
Information
Unsupported content The version 2.1.00 is in limited support, while versions 2.1.01, 2.1.02, 2.1.03, 2.1.04, and 2.1.05 are fully supported. This documentation includes content for all versions. You will not be able to leave comments for version 2.1.00.

Configuring metadata for script outputs

You can assign units to script outputs and configure them as key performance indicator (KPI).

To define the parameters settings, have the following line as the first or second line in the script output section:

<parameters>AttributeName1,kpi:true,units:seconds|AttributeName2,units:%|AttributeName3,kpi:false</parameters>

Here,

  • The pipe character ('|') is used to separate multiple attributes.
  • Comma (',') is used to separate different settings of an attribute.
  • Colon (':') is used to separate metadata name and value. 
Warning

The pipe character ('|'), Comma (',') and Colon (':') can not be used for units.


For example, 

<metadata>I2D=true</metadata>
<parameters>ResponseTime,kpi:true,units:seconds|ProcessingTime,kpi:true,units:ms</parameters>
WebServer=finance.domain.com/10.10.10.11*FinanceApp,ResponseTime=2,ResponseCode=200,LoginUsers=10,ProcessingTime=20
WebServer=callCenter.domain.com/10.10.10.12*CallCenterApp,ResponseTime=3,ResponseCode=200,LoginUsers=20,ProcessingTime=20

In this example, the ResponseTime and ProcessingTime attributes are defined as KPI parameters with units as seconds and ms.

Warning

Note

If you change the metadata of an attribute while the monitoring is happening, the PATROL Agent is reinitialized.



 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC PATROL for Scripting 2.1