Overview

 

This plugin allows you to gather single server WebSphere metrics via the SOAP interface.

Plug-In Files

com.dynatrace.diagnostics.plugins.jmx.websphere_1.0.0.jar

Author

Todd Ellis 

Versions

Dynatrace 6.0+, WebSphere 7.0+

License

dynaTrace BSD

Support Level

Not Supported

Release History05/XX/15 - v1.0.0 Initial Release


Collector Configuration:

You need to ensure the collector host is not marked as unknown. If it is, when running the plugin, you will get a local host related error. To resolve the issue for Linux:

  1. Type hostname (on the collector box in order to get the host name)
  2. In /ect/hosts define the hostname from above command)

On Windows, the host file is located: c:\windows\system32\drivers\etc\hosts

Installation and Configuration

  1. Import the Plugin into the dynaTrace Server via the dynaTrace Server Settings menu -> Plugins -> Install Plugin. For details how to do this please refer to the dynaTrace documentation: Plugin Management - Dynatrace Community
  2. Navigate to the appropriate System Profile Preferences and create a new WebSphere Application Server Monitor.
  3. i. Enter the name for the monitor (eg. environment name).
    ii. Fill out the Settings



    1. WebSphere Monitoring Thread Count - Number of threads to be used when monitoring the server (1-10)
    2. Metric Timeout - Amount of time (ms) to wait for data

    3. Environment - Name of the Environment

    4. WebSphere Server - WebSphere Server DNS or IP

    5. WebSphere SOAP Port - Port for the Server

    6. Security Enabled - Is security turned on?

    7. Key Store - E.g. C:/test/DummyClientKeyFile.jks - Needs to be on the Collector running the plugin. (.jks or .p12 supported)

    8. Key Password - Default WebAS

    9. Trust Store - E.g. C:/test/DummyClientTrustFile.jks - Needs to be on the Collector running the plugin. Trust file must be in JKS format, instructions available below.

    10. Trust Password - Default WebAS

    11. WebSphere User Name - WebSphere User

    12. WebSphere Password - Password for the WebSphere User

    13. Monitor X - Enable X Monitoring with checkmarks

    14. Application Data - List the Applications you do not want session data (separate with newline)

    15. Thread Pool Ignore - List the Thread Pools you do not want to monitor (separate with newline)

    16. Servlet Ignore - List the Servlets you do not want to monitor (separate with newline)

    17. JDBC Ignore - List the JDBC resources you do not want to monitor (separate with newline)

    18. DataSource Ignore - List the DataSource you do not want to monitor (separate with newline)

  4. Add a host for the monitor (WebSphere Server DNS or IP)
  5. Under the Schedule tab, configure the monitoring interval and dynaTrace Collector
  6. Under the Measures tab, configure the Thresholds. NOTE: For Dynamic Thresholds (different thresholds per server), refer to the Extended EMail Action Plugin.
  7. Confirm data collection by right clicking the server name under Monitors, then navigating to details.

How to convert from PKCS12 to JKS format

NOTE: If a different key/trust store is being added to the plugin configuration, the Dynatrace Collector executing the WebSphere Application Server Monitor must be restarted.

  1. Open IBM Key Management
  2. Select Key Database File from the main UI, then select Open.
  3. In the Open dialog box, select PKCS12 for the Key database type, then Browse... to select a file. Click OK.
  4. In the Password Prompt dialog box, input the key/trust store password. Click OK.
  5. Select Key Database File from the main UI, then select Save As...
  6. In the New dialog box, select JKS for the Key database type, then Browse... to select the file name and location. Click OK.
  7. In the Password Prompt dialog box, input the key/trust store password for the new file. Click OK.

Updating the Plugin

NOTE: The following steps should be taken to ensure that the Collector is running the correct plugin revision. A restart of the Collector is highly recommended.

  1. Open the System Profile Preferences
    1. Navigate to the Monitors tab in the left pane. 
    2. Select the plugin Monitor and click on the Suspend button. 
    3. Click OK to confirm the changes.
  2. Open the dynatrace Server Settings
    1. Navigate to the Plugins tab in the left pane. 
    2. Select the old version of the plugin under Installed Plugins and click on the Delete button.
    3. Click on the Install Plugin... button and upload the new revision of the plugin. Click Open, then Apply.
    4. Navigate to the Collectors tab in the left pane.
    5. Select the Collector executing the plugin and click on the Restart button.
    6. Click OK to confirm the changes.
  3. Open the System Profile Preferences
    1. Navigate to the Monitors tab in the left pane. 
    2. Select the plugin Monitor and click on the Resume button. 
    3. Click OK to confirm the changes.

Usage

The out-of-the-box WebSphere Monitoring dashboard can be modified with the WebSphere Single Server Plugin metrics to provide details of each server instead of aggregated metrics of the environment.

Measures Available:

WebSphere Application Data Group

WebSphere Connection Group

WebSphere DataSource Group

WebSphere JDBC Group

WebSphere JVM Group

WebSphere Server Group

WebSphere Servlet Group

WebSphere Thread Group

WebSphere Transaction Group