e2e_appmon Custom Metrics

This article describes how to generate custom metrics and TOT alarms in the E2E Application Response Monitoring (e2e_appmon) probe.
uimpga-ga
This article describes how to generate custom metrics and TOT alarms in the E2E Application Response Monitoring (e2e_appmon) probe.
Contents
How to Create Custom Metrics
This section describes the functions that must be added to your script file to generate custom metrics. Refer
e2e_appmon API
article for the description.
  1. nimLogin("username$","password$")
  2. nimInit2()
    The nimInit2() function is used when generating custom QoS. Refer nimInit() function in the
    e2e_appmon API
    article for the description.
  3. nimQoSStart()
  4. Start a web based application to monitor the execution time. For example, StartBrowser("IE", "about:blank",3)
  5. nimQoSStop()
  6. nimQoSSendTimer(qos$(step))
  7. nimAlarm(severity$,qos$(step) +
    "user-defined message"
    ,
    "user-defined script",
    "e2e_appmon")
How to Generate TOT Alarms for Custom Metrics
This section describes the steps to generate TOT alarms for custom metrics in the probe from your script.
Follow these steps:
  1. Create a monitoring profile in the probe.
  2. Create a script that executes the NimBus-functions, nimSetCi, and nimActivateTotRule functions and put this file in the same location as defined in the
    Setup
    section of the probe.
    A sample of the script file is as follows:
    include "NimBUS-functions" nimSetCi("3.21","e2eappmon_test","","3.21:6") nimActivateTotRule(120,600,0,0)
  3. Link this script to the monitoring profile created above.
  4. Run the script to activate TOT rule in the probe.
  5. Deactivate the monitoring profile created above.
    This is a necessary step otherwise the TOT alarm interval will reset everytime the script is run.
  6. In another script that generates custom QoS and alarms, ensure that the nimLogin() function is executed in the beginning.
    Ensure that the parameters provided in the nimSetCi() function is same in both the scripts so that same metric ids are generated for a custom metric.
  7. From the probe GUI, create and set APPMON_RUN_TOT = 1 in the
    Variables
    section.
    If this variable is set to or edited to 0, the probe does not generate TOT alarms.