e2e_appmon AC Configuration

This article describes the configuration concepts and procedures to set up the E2E Application Response Monitoring (e2e_appmon) probe. You can create monitoring profiles to execute precompiled NimRecorder scripts and monitor response time. You can generate QoS messages on the execution time of the scripts. You can also define thresholds to generate alarms when the script execution time exceeds the specified limit. Each monitoring profile can execute multiple scripts.
uimpga-ga
e2e_appmon_AC
This article describes the configuration concepts and procedures to set up the E2E Application Response Monitoring (e2e_appmon) probe. You can create monitoring profiles to execute precompiled NimRecorder scripts and monitor response time. You can generate QoS messages on the execution time of the scripts. You can also define thresholds to generate alarms when the script execution time exceeds the specified limit. Each monitoring profile can execute multiple scripts.
This article is for probe versions 2.2 or later.
The following diagram outlines the process to configure the probe.
configuring e2e_appmon 2.2 AC
configuring e2e_appmon 2.2 AC
Contents
2
Verify Prerequisites
Verify that required hardware and software is available and any installation and upgrade considerations are met before you configure the probe. For more information, see E2E Application Response Monitoring?(e2e_appmon) Release Notes.
Configure General Properties
You can configure the following properties of the probe:
  • User properties
  • Log settings
  • Execution properties
Follow these steps:
  1. Select the 
    e2e_appmon
     node.
    The
     Probe Information 
    section provides information about the probe name, probe version, start time of the probe, and the probe vendor. 
  2. Update the following information in the
    Log Level Configuration
    section to specify the logging properties of the probe:
    • Log Level: 
      specifies the level of details that are written to the log file. You can select the following log levels:
      • 0 - Logs only severe information
      • 1 - Logs error information
      • 2 - Logs warning information
      • 3 - Logs general information
      • 4 - Logs debugging messages
      • 5 - Logs tracing/low-level debugging information (default)
       Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging.
    • Logfile Size (KB):
       specifies a maximum size of the probe log file. When this size is reached, the contents of the file are cleared.
      Default: 100
  3. Update the following information in the 
    Run As User
     section to specify the user properties:
    • Name:
       defines the username with administrative permissions or a vaild e-mail account to execute scripts. The username also includes a domain name, if applicable in the 
      domainname\username
       format. The script has the same access level as the user.
      The probe automatically assumes the following points:
      • If you do not specify any credential, the probe uses the credentials of the logged in CA UIM user.
      • If you specify a credential, the probe assumes that the user credentials are valid.
    • Password:
       defines the password for the specified 
      Name
      .
    • User Check to Prevent Scripts to be Run From the Wrong User: 
      allows you to prevent the NimRecorder script from being executed on the target system by unauthorized users.
      If you select this option, the probe does not verify the domain name of the user. For example, if the specified user is
      Windows022\administrator
      , the probe only verifies if
      administrator
      is a valid user account and ignores the domain,
      Windows022
      .
    • Reset Registry Settings Right After the User is Logged on: 
      allows you to reset the registry settings after successful login of the user. Enable this option to make the target system less vulnerable to malicious attacks over a network. Ensure that automatic logon settings are available in the system registry.
      CA does not recommend you to select this option on a slow processing system, as it can abort the login process.
  4. Update the following information in the 
    Run Properties 
    section to specify the script execution properties of the probe:
    • Default Run Interval (Seconds): 
      defines the frequency at which the script runs.
    • Default Max. Run Time (Seconds): 
      defines the maximum duration that the script can execute for each instance. You can override this value for each profile. For more information, see
      Create a Profile
      .
    • Command: 
      defines the path of the directory where the 
      TaskExec.exe
       file is located. The 
      TaskExec.exe
       file executes the compiled NimRecorder scripts. You can also click e2eBrowse.png  to navigate to the executable file.
      Default: <CA UIM Installation Directory>\e2e_scripting\bin\TaskExec.exe
      Upgrade to NimRecorder 5.2 or later to execute scripts on 64-bit systems.
    • .ROB File Directory: 
      defines the path of the directory where the compiled NimRecorder script files are stored. You can also click e2eBrowse.png  to navigate to the directory.
      Default: <CA UIM Installation Directory>\e2e_scripting\scripts
      The default relative paths of the
      Command
      and
      .ROB File Directory
      fields do not work. Remove these default paths and configure the absolute paths manually.
  5. (Optional)
     Select 
    Suspend All Scripts 
    to suspend the execution of currently executing NimRecorder scripts.
  6. (Optional)
     Select 
    Resume All Scripts 
    to resume the execution of currently suspended NimRecorder scripts.
  7. Click 
    Save
    .
Configure Alarm Messages
You can configure the alarm messages that the probe generates for the applicable condition. For example, you can configure the probe to generate an alarm when a script fails to start.
Follow these steps:
  1. Select the 
    e2e_appmon
     node.
  2. In the
    Alarm on Start Error
    section, select
    Publish Alarm 
    to generate an alarm when the script fails to start and specify the alarm message at
    Alarm on Start Error.
  3. In the 
    Alarm on Interval Breach
     section, select 
    Publish Alarm 
    to generate an alarm when the script execution duration is longer than the threshold value. Specify the alarm message at 
    Alarm on Interval Breach
    .
  4. In the 
    Alarm on Process Kill
     section, select 
    Publish Alarm 
    to generate an alarm when the script terminates a process and specify the alarm message at 
    Alarm on Process Kill
    .
  5. In the 
    Alarm on Disable
     section, select 
    Publish Alarm 
    to generate an alarm when the probe disables a profile. Specify the number of errors from the profile in 
    Disable After 
    and specify the alarm message at 
    Alarm on Disable
    .
  6. Click 
    Save
    .
Create a Profile
You can create monitoring profiles for each NimRecorder script, specify the execution properties, and monitor the response time. The profile always generates an alarm when the script returns an error. The probe also includes sample scripts that you can directly execute and monitor.
Follow these steps:
  1. Click the 
    Options (icon
    ) next to the 
    Profiles 
    node and select
    Add Profile
    .
  2. Complete the following information in the
    Profiles
    dialog:
    • Name: 
      defines a unique name for the profile.
    • Active: 
      activates the profile, on creation.
  3. Click
    Submit
     to create the profile as a
    Profilename
    node under the
    Profiles
    node.
  4. Select the 
    Profilename
     node.
  5. Update the following information in the 
    Run Properties 
    section to specify the execution properties of the profile:
    • Compiled Script (.ROB File): 
      allows you to select a script that the probe executes. The available scripts are automatically loaded from the path specified in the 
      e2e_appmon
       node > 
      .ROB File Directory
       field.
    • Arguments: 
      defines the parameter required to run the script, as applicable.
    • Max. Run Time(Seconds): 
      defines the maximum time that the NimRecorder script can execute. This value overrides the default value that is specified in the 
      e2e_appmon
       node > 
      Default Max. Run Time (Seconds)
       field.
  6. Select the options in the 
    On Timeout
     section to configure the timeout properties of the probe. The probe executes the selected actions when the NimRecorder script execution time exceeds the limit.
    • Dump Screen on Timeout: 
      saves a snapshot of the application when the NimRecorder script execution time exceeds the limit.
    • Kill Processes on Timeout: 
      terminates the other processes with the NimRecorder script on timeout.
  7. (Optional)
     Complete the following information in the 
    On Error Return 
    section to configure the error properties of the script. The probe executes the selected actions when the NimRecorder script generates an error after execution.
    • Expected Return Values=0: 
      verifies the return value from the NimRecorder script and determine whether the script is executed successfully or not. Select this option to configure remaining fields in the section.
    • Dump Screen on Error: 
      saves a snapshot when the script does not return an expected result.
    • Publish Alarm: 
      allows the probe to generate an alarm when the NimRecorder script returns an error.
    • Alarm message: 
      allows you to specify the alarm message that the probe generates when the NimRecorder script returns an error.
  8. Select a script in the
     Cleanup on Timeout or Error return 
    section > 
    Run .ROB file
     field, that executes when the profile script times out or returns an error. This script is used to clean up the actions from the previous script.
  9. Click 
    Save
    .
Configure Alarm and QoS Properties
You can configure alarm and QoS messages that a profile generates. The probe automatically applies the configuration for the following alarms as configured in the e2e_appmon node.
  • Alarm on Start Error
  • Alarm on Interval Breach
  • Alarm on Process Kill
  • Alarm on Disable
For more information, see the 
Configure Alarm Messages
section.
Follow these steps:
  1. Select the 
    Profilename
     node.
  2. Update the following information in the 
    Source Used for Quality of Service and Alarm Messages
     section:
    • Override:
      allows you to specify a custom hostname, which appears as the source in QoS and alarm messages.
    • Source:
       defines a custom hostname, which appears as the source in QoS and alarm messages.
    The probe uses the hostname of the system where the probe is deployed as the default source in QoS and alarm messages.
  3. Update the following information in the 
    Quality of Service Message
    section to configure alarm and QoS messages for response time:
    • Publish Data: 
      generates QoS messages for the response time of the script.
    • Publish Alarms: 
      generates alarm messages for the response time of the script.
    • Compute Baseline: 
      enables thresholds for alarms. This option might not be available depending on your CA Unified Infrastructure Management configuration. For more information, see Configuring Alarm Thresholds.
  4. Click 
    Save
    .
View Profile Status
You can view the execution statistics of profiles in the probe.
Follow these steps:
  1. Select the 
    e2e_appmon
     node.
  2. View the following information in the
    Profile Properties
     section for each profile:
    • Name: 
      displays the name of the profile.
    • ROB File: 
      displays the name of the NimRecorder script (a ROB file) executed by the profile.
    • Last Started: 
      displays the last time that the script was executed.
    • Running: 
      displays the running state of the NimRecorder script. 
      Yes 
      means running and blank means not running.
    • Time Used (Last Run in Seconds): 
      displays the time duration used in last execution of the NimRecorder script.
    • Return Code (Last Run): 
      displays the status code returned after last execution of the NimRecorder script.
    • Times Started: 
      displays the number of times the NimRecorder script is executed after the e2e_appmon probe is activated last time.
    • Times Killed: 
      displays the number of times the NimRecorder script is killed after the e2e_appmon probe is activated last time.
    • Times Failed to Start: 
      displays the number of times the NimRecorder script has failed to start after the e2e_appmon probe is activated last time.
    • Max Run Time: 
      displays the maximum time for running a profile.
Create Script Packages
You can create and deploy standalone NimRecorder script packages using the probe. These packages can be deployed on the target robot (similar to other probe packages) for monitoring. You can add more than one NimRecorder script and their dependent files to one deployable package.
Refer to the e2e_appmon Script Considerations article, which provides information to create and deploy the script packages.
Follow these steps:
  1. Select the 
    Script
     node.
  2. Update the following information in the
    Scripts
    section:
    • Name: 
      defines the name of the script package to be made.
    • Version: 
      specifies the version number of the script package to be created.
      Default: 1.0
    • Description: 
      defines a short description of the script package.
  3. Select the required scripts from the
    List of scripts
     section
    > Available
    field to move them to the
    Selected
    field. The probe displays the list of scripts present in the path that is specified in the 
    ROB file directory 
    field of the 
    e2e_appmon
     node.
    The probe inherits the script execution properties from an associated profile.
  4. (Optional)
    Click
    New
    in the 
    Path/Dependent Files
    section to add dependent files, such as .bmp files, that are required to execute the script.
  5. (Optional)
     Update the following information:
    • Rob File:
      specifies the script file to associate the dependant file.
    • Path/Dependent Files: 
      specifies the path of the dependent files. You can also click  e2eBrowse.png  to navigate to the directory.
      The script uses an absolute path of the dependent files.
  6. (Optional)
     Click
    Actions > Save
    to add the path of the selected dependent files in the list. You can select any file from the list and select 
    Delete
     to remove it.
  7. Navigate to the
    Scripts
    section.
  8. Select
    Actions > Validate Package Name
    to verify that an existing package of the same name isn't already available in the archive. You cannot create two or more packages with the same name.
  9. Select 
    Actions >  Publish to Archive 
    to publish the script package to the 
    Archive
     directory of the primary hub.
  10. Deploy the package from the archive to the required robot to execute the script on that system.
Create Variables
NimRecorder allows you to use custom variables in scripts. You can define variables in the probe to use in NimRecorder scripts. For example, create a variable called
filepath
 to use navigation path of files in scripts.
You cannot create a 
Crypted 
variable using the Admin Console interface.
Follow these steps:
  1. Click the 
    Options (icon
    ) next to the 
    Variables 
    node and select 
    Add Variable
    .
  2. Complete the following information in the
    Add Variable
    dialog:
    • Variable Name: 
      defines the variable name, which is unique for each variable.
    • Variable Value: 
      defines a value to be assigned to the variable.
  3. Click 
    Submit
    to add the variable to the list of variables in the
    Variables
    node.
  4. Update the following information in the 
    Quality of Service Variables 
    section to configure default QoS properties:
    • Group Name(Exported as APPMON_QOS_GROUP): 
      defines the default QoS group.
    • Name(Exported as APPMON_QOS_NAME): 
      defines the default QoS name.
  5. Click 
    Save
    .