e2e_appmon IM 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_IM
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 on IM
configuring e2e_appmon on IM
2
Verify Prerequisites
Review the following prerequisites in E2E Application Response Monitoring?(e2e_appmon) Release Notes before you configure the probe:
  • Verify that required hardware, software, and related information is available.
  • Before you deploy the probe version 2.30, you mustEnable FIPS Encryption  on the system where the probe is configured.
Configure General Properties
You can configure the following properties of the probe:
  • User properties
  • Log settings
  • Execution properties
Follow these steps:
  1. Open the
    Setup
    tab.
  2. 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.
  3. Update the following information 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.
    • Log Size:
      specifies a maximum size of the probe log file. When this size is reached, the contents of the file are cleared.
      Default: 100
  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 executions.
    • 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 the Browse
       (...)
       button 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 the Browse
       (...)
       button to navigate to the executable file.
      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
    to suspend the execution of currently executing NimRecorder scripts. However, you can retrieve the last execution status and view the screenshots of the script.
  6. Click
    Apply
    .
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. Open the 
    Status
     tab.
  2. Right-click in the tab and select 
    Add profile
    .
  3. Specify a 
    Name
     for the profile.
  4. Select 
    Active 
    to activate the profile, on creation.
  5. Complete the following information in the 
    Run properties 
    section to specify the execution properties of the probe:
    • 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 
      Setup
       tab > 
      .ROB File Directory
       field.
    • Arguments: 
      defines the parameter required to execute the script, as applicable.
    • Max. run time: 
      defines the maximum time that the NimRecorder script can execute. This value overrides the default value that is specified in the
      Setup
      tab >
      Default max run time (seconds)
       field.
    • Expected return value = 0:
      verifies the return value from the NimRecorder script and determine whether the script is executed successfully or not. The probe also enables the
      On error return
      section for configuration. 
  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. Right-click the profile under the 
      Status 
      tab and select the 
      View screendumps...
       to view the screen dump for the profile.
    • 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. This section is enabled after selecting the 
    Expect return value = 0
     option.
    • Dump screen on error: 
      saves a snapshot when the script does not return an expected result. Right-click the profile under the 
      Status 
      tab and select the 
      View screendumps...
       to view the screen dump for the profile.
    • Alarm message:
      allows you to enable and 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 script times out or returns an error. This script is used to clean up the actions from the previous script.
  9. Select 
    Send QoS on total run time
     to generate QoS data for the script execution time.
  10. Select from the following options in the
    Advanced
    tab >
    Source used for Quality of Service and Alarm messages
    field:
    • Local machine: 
      specifies the probe to use the hostname of the system where the probe is deployed as the source in QoS and alarm messages.
    • Override with:
      defines a custom hostname, which appears as the source in QoS and alarm messages.
  11. Click
    OK
    .
Configure Schedules
You can schedule monitoring profiles in the probe to execute at specified instances. For example, you can schedule a script to execute only between 10 and 12 A.M. every weekday.
Follow these steps:
  1. Open the 
    Status
     tab.
  2. Right-click a profile and select 
    Edit profile
    .
  3. Navigate to the
    Scheduling
    tab.
  4. Select from the following options in the
    Run interval
    section to configure the scheduling interval:
    • On every probe interval: 
      schedules the profile to execute on each monitoring interval of the probe.
    • Time between script execution:
       schedules the profile to execute in the specified interval. You can specify the value in seconds, minutes, hours, days, and weeks.
  5. Update the following information in the
    Only run on
    section to configure scheduling restrictions for the probe:
    • In time ranges: 
      specifies a comma-separated list of time ranges. For example, 
      10:05-11:30
      12:34-16:00
    • Weekdays: 
      specifies a comma-separated list of weekdays or range of weekdays. For example, 
      mon, thu-sat
    • Days of month: 
      specifies a comma-separated list of month dates. For example, 
      2-5,14-16,21
    The probe matches all conditions for the profile. So, if you specify mon in
    Weekdays
    and 3 in
    Days of month
    , the profile will execute only if the 3rd of a month falls on a Monday.
  6. In the
    Do not run on
    section, specify a comma-separated list of dates (in 
    day.month
     format) when the script does not execute in the
    These dates
     field. For example, 
    5.1, 9.1.
  7. Click
    OK
    .
View Profile Status
You can view the execution statistics of profiles in the probe.
Follow these steps:
  1. Open the 
    Status
     tab.
  2. View the following information in the
    Profiles
    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 execution state of the NimRecorder script. 
      Yes 
      means currently executing and blank means not executing.
    • Time used (last run): 
      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 executing a profile.
  3. Right click a profile for the following options:
    • Add profile...: 
      allows you to add a profile to the probe.
    • Edit profile...: 
      allows you to modify the selected profile.
    • Delete profile: 
      allows you to delete the selected profile.
    • View screendumps...:
      allows you to view snapshots of the script if
      Dump screen on timeout
       or
      Dump screen on error
       fields are selected in the profile.
    • Start at once:
      executes the selected profile once, immediately.
    • Refresh:
      retrieves the current execution statistics of all profiles. You can use F5 as a shortcut. 
    • Automatically refresh:
      automatically retrieves the current execution statistics of all profiles.
  4. Click
    Apply
    .
Create and Configure Alarm Messages
You can configure the alarm messages that the probe generates for the specified condition. For example, you can configure the probe to generate an alarm when a script fails to start.
Follow these steps:
  1. Open the 
    Messages
     tab.
  2. Right-click in the
    Messages
    section and select
    Add message...
    .
  3. Complete the following information in the 
    Message properties
     window to specify the properties:
    • Name: 
      defines a unique name of the message. This name is used to refer to the message from the profiles.
    • Default for: 
      specifies the alarm situations to be selected as the default alarm message for a specific type of alarm message.
    • Text: 
      defines the alarm message text. You can use the following variables:
      • $profile:
         indicates the profile name.
      • $failed: 
        indicates the number of consecutive failures.
      • $sec: 
        indicates the seconds delay on interval breach
      • $error: 
        indicates the error message on start error.
      • $return: 
        indicates the actual return code from last execution
      • $expected_return: 
        indicates the expected return code after successful execution of the script.
    • Level: 
      specifies the severity level assigned to the alarm messages.
    • Subsystem: 
      defines the 
      subsystem_ID
       of the alarms.
  4. Click
    OK
    to create the message.
  5. Update the following information in the
    Alarm message setup
    section to specify the alarm messages that the probe uses:
    • Alarm on start error:
      specifies the alarm message to generate when the script fails to start.
    • Alarm on interval breach: 
      specifies the alarm message to generate when the script execution duration is longer than the threshold value.
    • Alarm on process kill: 
      specifies the alarm message to generate when the script terminates a process.
    • Disable after (...) errors and send message:
      specifies the number of errors from the profile before the probe disables the profile. You can also specify the alarm message to generate when the profile is disabled.
  6. Click
    Apply
    .
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, to use an encrypted password in the script, define the password as a variable and select the 
Crypted 
option.
Follow these steps:
  1. Open the 
    Variables
     tab.
  2. Right-click in the
    Variables
    section and select
    Add variable...
    .
  3. Complete the following information in the
    Variable properties
    window:
    • Variable name: 
      defines the variable name, which is unique for each variable.
    • Crypted:
      allows you to encrypt the variable value and prevents the same being displayed in the human readable format.
    • Variable value: 
      defines a value to be assigned to the variable.
  4. Click
    OK
    .
  5. Update the following information in the 
    Quality of Service variables 
    section to configure default QoS properties:
    • Group name: 
      defines the default QoS group.
    • Name: 
      defines the default QoS name.
  6. Click
    Apply
    .
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. Open the 
    Scripts
     tab.
  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. The probe displays the list of scripts present in the path that is specified in the 
    ROB file directory 
    field of the 
    Setup
     tab.
    The probe inherits the script execution properties from an associated profile. If more than one profile is associated to a script, double-click the script name and select the required profile. If a profile is not associated with a script, then the probe displays the script in red color and uses the default settings for execution. You can double-click the script name to define or modify the script execution properties.
  4. Update the following information to add dependent files, such as .bmp files, that are required to execute the script:
    • Path/Dependent Files: 
      specifies the path of the dependent files.
      The script uses an absolute path of the dependent files.
    • ...
      : allows you to browse for dependent files. You can select more than one file from the same directory in one attempt. The field remembers the last navigation path.
    • Add Files:
       allows you to add the path of the selected dependent files in the 
      Paths
       list. You can select files in different directories and click
      Add Files
      to add more files to the package.
    • Paths: 
      displays the list of dependent files that are included in the script package. You can right-click any file from the list and select
      Delete
       to remove it. 
  5. Select 
    Publish to Archive
    to publish the script package to the 
    Archive
     directory of the primary hub.
  6. Deploy the package from the archive to the required robot to execute the script on that system.