websphere IM Configuration

The following diagram outlines the process to configure the probe. 
uimpga-ga
websphere_IM
This article describes the configuration concepts and procedures to set up the WebSphere Monitoring (websphere) probe. The probe is configured to monitor entities such as Java Virtual Machine, Enterprise Java Beans, Servlets, and Java Server Pages. You can create profiles and configure monitors to generate QoS and alarms once the probe establishes a connection with the IBM WebSphere Application Server (WAS).
The following diagram outlines the process to configure the probe. 
websphere_IM_Config
websphere_IM_Config
 
Contents
 
 
 
2
 
 
Verify Prerequisites
Verify that required hardware and software is available, and other prerequisites are met before you configure the probe. For more information, see websphere (Websphere Monitoring) Release Notes.
Set Up Environment Libraries
The probe requires prior configuration of the required WebSphere and Java libraries. 
 
Follow these steps:
 
  1. Launch the probe in your 
    Infrastructure Manager
    .
    The WebSphere Probe Installation Wizard appears.
     This installation wizard appears only when you initially launch the probe in IM.
  2. Read the provided instructions and select your 
    WebSphere
     version.
  3. Click 
    Next
    .
  4. Specify the folders for the following libraries:
    •  
      Library folder: 
      defines the WebSphere libraries path.
    •  
      Java home folder: 
      defines the Java runtime environment path.
  5. Click 
    Next
    .
    The probe validates the specified paths. If the paths are incorrect, the wizard displays 
    Requirements not met!
     
  6. (Optional) Click 
    Back
     to specify the library paths.
  7. Click 
    Finish
     to close the wizard and 
    Yes
     to restart the probe.
Configure General Properties
You can configure the log properties to define the amount of log information to maintain. You can also configure the security properties for the probe environment.
 
Follow these steps:
 
  1. Click the 
    General Setup
     button to open the 
    Setup
     dialog.
  2. Set or modify the following information under the 
    General
     tab, as required.
    •  
      Log Level
      : specifies the level of information that is written in the log file.
      Default: Less 
      Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging.
    •  
      Log Size
      : specifies the maximum size of the probe log file in kilobytes.
      Default: 100 
  3. If your client security files on the WAS are password-protected, specify the following passwords under the 
    Advanced Security 
    tab.
    •  
      Client Trust Password
      : defines the trust password to read client security files.
    •  
      Client Key Password
      : defines the key password to read client security files.
  4. Set or modify the following memory threshold under the 
    Memory Threshold
     tab, as required.
    •  
      Low threshold:
       generates an alarm when the utilized JVM memory exceeds the specified threshold.
      Default: warning alarm at 125 MB
    •  
      High threshold:
       generates an alarm and restarts the probe when the utilized JVM memory exceeds the specified threshold.
      Default: critical alarm at 250 MB
 You can use groups to manage large configurations monitoring. To create a group, click 
Create A New Group
 button on the toolbar, and add resources and profiles to it.
Create a Resource
A resource is a WAS instance to be monitored, and is identified with either the host name or the IP address. You can also add a cluster of the WAS as a resource to monitor. 
 
Follow these steps:
 
  1. Right-click on a group and select the 
    New Resource
     option.
    The 
    WebSphere Probe Configuration Wizard
     opens.
  2. Click 
    Next
    .
  3. Specify the following information of the monitored WAS:
    •  
      Hostname or IP Address
      : specifies the host name or the IP address of the server.
    •  
      Port
      : specifies the port number that the probe uses to connect to the server.
      Default: 8880
       Specify 8879 for clustered environments.
  4. Click
     Next
     and specify the following information:
    •  
      Username
      : specifies the user with administrative privileges to connect to the server.
    •  
      Password
      : specifies the password of the defined 
      Username
      .
    •  
      Use SSL
      : allows the probe to use HTTPS to connect to the server.
      Default: Selected
  5. Click 
    Next
    .
    The probe searches for entities and lists the node and server combinations of the specified host.
  6. Select the node and server combination that you want to monitor. 
    Create separate resources for each cluster node to achieve a systematic monitoring environment.
  7. Click 
    Finish
     to complete the wizard and 
    Apply
     to activate the new resource.
    The new resource appears in the left pane of the probe GUI. All node and server combinations that are detected during the Resource wizard are listed as child nodes under the Profile node.
     When you select a profile, a tree structure appears on the probe GUI listing all the monitors within. When you select a folder in the left pane, the related monitors are displayed in the right pane.
  8. Right-click on your 
    resource name
     node and select 
    Edit
    .
  9. Set or modify the following fields of the monitored WAS, as required:
    •  
      Hostname or IP address
      : specifies the hostname or IP address of the monitored server.
    •  
      Port
      : specifies the port number that the probe uses to connect to the server. 
    •  
      Active
      : activates the resource for monitoring, on saving.
      Default: Selected
    •  
      Group:
       specifies the group of the resource.
    •  
      Check Interval
      : specifies the interval, in minutes, after which the probe again retrieves data from the server.
      Default: 5 minutes
       Reduce this interval to generate alarms and QoS frequently. A shorter interval can also increase the system load.
    •  
      Alarm Message
      : specifies the message that is generated when the resource does not respond.
      Default: ResourceCritical
       You can edit the message or create a message using the Message Pool.
  10. Set or modify the following fields under 
    Host Configuration
    , as required:
    •  
      Username
      : specifies the user to connect to the server.
    •  
      Password
      : specifies the password of the defined 
      Username
      .
    •  
      Activate Statistic Set Automatically on PMI
      : sets the Performance Monitoring Infrastructure (PMI) to a level so that the probe can access all the monitors. By default, the PMI level that the WebSphere server administrator defines might deny the probe access to some monitors.
      Default: Not selected
      CA recommends that you ensure that PMI level settings do not affect the WebSphere server performance.
       
      Check with the WebSphere system administrator first.
  11. Specify the minimum number of profiles in the 
    Advanced Alarming
     field when the same monitor exceeds the defined alarm threshold before an alarm is sent.
    Default: 1
    • The probe generates only one alarm when the same monitor exceeds threshold for the configured minimum number of profiles.
    • A monitor does not send any alarm if the monitor does not exceed threshold for the configured minimum number of profiles.
    • If 
      Always alarm
      option
       
      is enabled for a monitor, this parameter is overridden and alarm is always sent if the threshold is breached.
    • If the value is configured as 
      1
      , individual alarms from all the profiles are sent if the threshold is breached (similar to configuring 
      Always alarm
       for all the monitors).
  12. Click
     Test 
    to verify the Resource response.
  13. Click
     OK
    .
To delete a resource, right-click the resource and select 
Delete
.
The following icons denote the resource status:
  •  Ok icon.png indicates that the system is available.
  •  Unavailable-icon.png indicates that the system is unavailable.
  •  Try-icon.png indicates that the system is trying to connect.
Create a Profile
All node and server combinations (profiles) are detected and added when the resource wizard launches. One profile is automatically created under the resource that is created in the previous section. You can create more profiles, as required.
 
Follow these steps:
 
  1. Right-click a profile and select 
    New profile
    .
    The 
    Profile
     dialog opens.
  2. Set or modify the following information, as required:
    •  
      Active: 
      activates the profile for monitoring, on creation.
    •  
      Name: 
      defines a unique name for the profile. For example, use the format <node>.<server>
    •  
      Node: 
      defines the node name in the cluster.
    •  
      Server: 
      defines the server name in the cluster.
    •  
      Resource: 
      defines the resource to which the node belongs.
    •  
      Alarm Message: 
      specifies the alarm message that is sent if the profile does not respond.
      Default: ProfileCritical 
  3. Click 
    OK
    .
  • If the new node is not recognized, a Unavailable-icon.png symbol occurs on the node name.
  • To edit a profile, right-click the profile in the probe GUI and select 
    Edit
    .
  • To delete a profile, right-click the profile in the probe GUI and select 
    Delete
    .
Apply Monitors to Profile
You can configure monitors for the probe in the following ways:
  •  Manually select monitors from the available list.
  •  Use monitoring templates to apply consistent monitoring patterns across resources. Templates are also used with auto configurations.
  •  Auto-configure monitors to apply monitor templates to all components of a resource and automatically add monitors for new devices.
Manually Select Monitors 
You can manually select a monitor when the requirement is limited to few elements of the server.
 
Follow these steps:
 
  1. Select a resource in the contents pane. The available monitors for the selected resource are listed in the navigation pane.
  2. Select the corresponding checkbox to activate the monitor.
  3. Double-click a monitor to open the Monitor Properties dialog.
  4. Configure the monitor properties, as required.
  5. Click 
    Apply
     and 
    Yes
    , when prompted to restart the probe.
  • To edit a monitor, right-click the monitor and select 
    Edit
    .
  • To delete a monitor, right-click the monitor and select 
    Delete
    .
  • To display the current value for the monitor, right-click the monitor and select 
    Refresh
    .
  • Select 
    Browse
     to navigate to the monitor folder location in the WebSphere browser.
  • To view a graph of the measured values of the monitor, right-click the monitor and select 
    Monitor
  • To add a monitor to the template, right-click the monitor and select 
    Add to Template
    , and specify the 
    template name
     where you want to add.
Use Templates
You can create templates to define a set of monitors. These template monitors can be applied to multiple components of a resource. You can also drag-and-drop them to the Auto Configurations 
 
node. The template monitors are applied to all the relevant components of a resource. 
 
Follow these steps:
 
  1. Right-click the 
    Templates
     node in the navigation pane and select the 
    New Template
     option.
    The 
    Template Properties
     dialog appears. 
  2. Define a template 
    Name
     and a 
    Description
    .
  3. Click 
    Ok
    .
  4. Add monitors to the template using any of the following options:
    • Select monitors from other templates and drag-and-drop them to the created template.
    • Select a monitor from the list of available monitors in the probe. Drag-and-drop it from the navigation pane to the template in the contents pane.
    • Right-click on the monitor and select the 
      Add to Template
       option.
  5. Configure the monitor properties, as required.
     Select the 
    Active 
    and 
    Enable Monitoring 
    options in the 
    Monitor Properties
     dialog to enable the monitor to collect data.
  6. Drag-and-drop the template on the 
    Auto Configurations
     node and apply the template monitors to the resource. You can also drag-and-drop the template on individual component of resource.
  7. Click 
    Apply 
    and
     Yes
    , when prompted to restart the probe. 
  • If you want to edit a template, right-click on the template and select 
    Edit
    .
  • If you do not want to use a template, right-click on the template and select 
    Delete
    .
Use Auto Configurations
The auto configurations feature automatically applies monitors to all components of a resource. Add monitors and templates to the 
Auto Configurations
 node of a resource to apply them to the resource. As new devices are detected, these auto monitors are applied automatically to the devices. When you modify a monitor using Auto Configurations, the probe automatically applies the updates to all the monitoring instances.
To add a monitor to the 
Auto Configurations
 node, drag the monitor to the node.
The 
Auto Monitors
 node displays a list of all monitors that are configured using the monitor configurations in the Auto Configurations node.
Add a Template to Auto Configurations
You can add a template to the 
Auto Configurations
 node of a resource to apply all template monitors to all components of the resource. The configuration is automatically applied to new devices for the resource.
 
Follow these steps:
 
  1. Click the 
    Templates
     node in the navigation pane.
    The list of templates is displayed in the content pane.
  2. Drag-and-drop the template from the content pane onto the 
    Auto Configurations
     node.
  3. Click the 
    Auto Configurations
     node and verify that the template is listed in the content pane.
  4. Click 
    Apply
     and 
    Yes
    , when prompted to restart the probe. 
The monitors of the template are applied to all components of the resource.
Add a Monitor to Auto Configurations
You can add a single monitor to the 
Auto Configurations
 node of a resource to apply the monitor to all components of a resource.
 
Follow these steps:
 
  1. Expand the 
    All Resources
     node in the navigation pane and select a component.
    The list of available monitors for the selected component is displayed in the contents pane.
  2. Drag-and-drop the required monitor on the 
    Auto Configurations
     node.
  3. Click the 
    Auto Configurations
     node to verify that the monitor is listed in the navigation pane.
  4. Right-click on the monitor and select the 
    Edit
     option.
    The 
    Auto Configuration Properties
     appears.
  5. Specify the field information, as required.
  6. Click 
    Apply
     and 
    Yes
    , when prompted to restart the probe.
The selected monitor is applied to all components of the resource.
Configure Monitor Properties
You can define the thresholds to generate alarms and configure the QoS messages.
 
Follow these steps:
 
  1. Double-click a monitor to open the 
    Monitor Properties 
    dialog. 
  2. Set or modify the following fields, as required:
    •  
      Name
      : defines the monitor name.
    •  
      Key
      : defines the component type and component property.
    •  
      Description
      : specifies additional information
       
      about the monitor.
    •  
      Value Definition
      : specifies the type of value for comparison with the threshold value and generate alarms. This value type is also used in the QoS messages.
      •  
        The current value:
         uses the current (last measured) value to compare it with the threshold value.
      •  
        The delta value (current - previous):
         uses the delta value for comparison with the threshold value. The delta value is the difference between the current and the previous measured value.
      •  
        Delta per second: 
        uses the delta value that is calculated from the samples, per second.
      •  
        The average value ((current+previous)/2):
         uses the average value for comparison with the threshold value. The average value is the sum of current and previous measured value that is divided by 2.
    •  
      Active
      : enables the 
      Enable Monitoring 
      and 
      Publish Quality of Service (QoS) 
      fields to configure alarms and QoS.
    •  
      Enable Monitoring
      : enables the probe to configure alarms. Select the checkbox to activate the following fields:
      •  
        Operator
        : specifies the operator to be used when setting the alarm threshold for the measured value. Exact equals are not useful for values that vary with time.
        Examples:
        => 90 means alarm condition if the measured value is 90 or above.
        = 90 means alarm condition if the measured value is exactly 90.
      •  
        Threshold
        : defines the alarm threshold value. An alarm message is sent when this threshold is breached. You can configure both 
        high 
        and 
        low 
        thresholds. The low threshold usually generates a warning alarm and the high threshold generates an error alarm.
        Initially, you can set the high threshold to a default value or the current value and disable the low threshold.
      •  
        Unit
        : defines the unit of the threshold value.
      •  
        Message Token
        : selects the alarm message that is generated when the specified threshold is breached. These messages are kept in the message pool. The messages can be modified from the Message Pool Manager.
      •  
        Key not found alarm:
         sends an alarm if no key is detected. For example, this might happen after the WebSphere server restarts and it takes time to restore all the monitors.
      •  
        Always alarm (Send alarm message regardless of alarm state on other profiles):
         overrides the Advance Alarming option on the 
        Resource properties
         dialog. If you select this option, a threshold breach for this monitor results in an error message, independent of this monitor value on other profiles in the cluster. 
    •  
      Publish Quality of Service (QoS)
      : defines the probe to publish QoS data on the monitor. 
    •  
      QoS Name
      : defines the name in the QoS message.
  3. Click 
    Ok
    .
The monitor configuration properties take effect to enable the probe to generate alarms and QoS.
Configure Alarm Messages
The probe contains a pool of alarm messages that are configured in the monitors. You can add, and delete the messages in this pool, as required. You can also edit message properties such as text, and severity. 
 
Follow these steps:
 
  1. Click the 
    Message Pool Manager
     button on the toolbar.
    The 
    Message Pool
     dialog displays the list of all configured alarm messages.
  2. Click 
    Add
     or 
    Edit
     from the toolbar in this dialog.
    The 
    Message Properties
     dialog appears. 
  3. Set or modify the following values, as required:
    •  
      Identification Name
      : define a unique name for the alarm message. This name is used to select the message while configuring the profile.
    •  
      Token
      : indicates the message token.
    •  
      Error Alarm Text
      : indicates the error message text.
    •  
      Clear Alarm Text
      : indicates the clear message content.
       Use the
       Alarm Message Variables
       to provide real-time information in the 
      Error Alarm Text
       and 
      Clear Alarm Text
       fields.
      You can use the following variables in the 
      Error Alarm Text
       and 
      Clear Alarm Text
       fields:
      • $resource: name of the monitored resource.
      • $host: name of the host computer where the alarm condition occurs.
      • $port: defines the communication port on the host.
      • $profile: name of the monitored profile.
      • $monitor: name of the monitor.
      • $descr: description of the monitor.
      • $key: monitor key, usually the same as the name of the monitor.
      • $value: current value of the monitor.
      • $oper: operand to be combined with the value and the threshold in the alarm message.
      • $thr: threshold value of the alarm.
      • $unit: unit to be combined with the value in the alarm message (for example, Boolean).
    •  
      Error Severity
      : indicates the alarm messages severity level.
    •  
      Subsystem String/Id
      : indicates the alarm subsystem ID that defines the alarm source.
       These messages are configured under all monitoring profiles of the probe.
  4. Click 
    Ok 
    on the 
    Message Properties
     dialog.
  5. Close the 
    Message Pool
     dialog.
  6. Click 
    Apply
     and 
    Yes
    , when prompted to restart the probe.
Rescan for Host
The probe automatically scans the profiles in the host server after a preconfigured interval (15 minutes). The probe loads any profiles available in the host server under the respective Resources nodes in the probe GUI.
 
Follow these steps:
 
  1. Click the 
    Rescan for host
     button from the toolbar. A message appears informing the scan in progress.
     
  2. Any profile available in the host servers that has not been added to the probe, is added to the probe GUI. If all the profiles available in the host server are already loaded under the respective resources, the following message appears:websphere-rescanWarning.png 
View Log File for Error Codes
The following error codes can occur in the probe log file. You can view the log file by right-clicking the probe in the Infrastructure Manager and selecting 
View Log
. Error code 1500 and 1503 might also appear in the WebSphere browser window.
 
1500 
 
Lost connection to the WebSphere server.
Not able to connect to the WebSphere server.
Subtext: The reason for the connection problem.
 
1501 
and
 1502
 
The given key (measurepoint) is not found on the server.
 
1503
 
 WEBSPH--Error Codes 
The statistic information is not available on the server.
Subtext: Why the information is not available (too low PMI level).
 WEBSPH--Error Codes (2) 
When this message appears in the WebSphere browser window, it means that the key is not available now.