Enabling metrics collection for Sametime Gateway

Enable the IBM® WebSphere® PMI (Performance Monitoring Infrastructure) tool and begin collecting performance metrics on WebSphere Application Server.

Before you begin

Before enabling metrics collection, make sure that the Sametime® Gateway server is running. In a cluster, the deployment manager and nodes agents must be running.

About this task

The PMI tool collects and displays general WebSphere Application Server performance metrics on servers hosting Sametime Gateway. You can enable metrics collection for Sametime Gateway by creating a custom property that specifies the level of metrics that you want to collect. If you do not specify a custom level, the ServerHealth level is used by default. There are three levels of metrics collection:

  • Server Health

    This lightweight metrics set is guaranteed not to cause any server performance degradation. When you enable metrics collection, this level is used by default.

  • Problem Determination

    This extended set of application metrics can be enabled to assist in a problem determination scenario. This level should only be turned on if instructed by IBM Support. All metrics that are part of the Server Health set are also included of the Problem Determination set.

  • Off

    Metrics collection is disabled.

Procedure

  1. Log in to the Integrated Solutions Console as the WebSphere administrator.
  2. Open the Custom properties page:
    1. On a single server, click Servers > Server Types > WebSphere application servers > Gateway_server_name > Server Infrastructure > Administration > Custom Properties.
    2. On a clustered server, click System administration > Cell > Custom Properties.
  3. In the custom properties table, click New.
  4. In the Name field, type com.ibm.rtc.gateway.pmi.mode as the property's name.
  5. In the Value field, type the value representing the level of metrics collection that you want to enable: ServerHealth, ProblemDetermination, or Off.
  6. Click OK to save the new custom property.
  7. Save the change to the master configuration by clicking the Save link in the "Messages" box at the beginning of the page.
  8. Restart the Sametime Gateway server. In a cluster, synchronize the nodes and restart the cluster as follows:
    1. In the navigation tree, click System Administration > Nodes.
    2. Select all nodes in the cluster, and then click the Full Resynchronize button at the beginning of the table.
    3. In the navigation tree, click System Administration > Node Agents.
    4. Select all nodes in the cluster, and then click the Restart button at the beginning of the table.

Results

Metrics collection is automatically enabled (or disabled) and set to the specified level after the server or cluster has started.