WebSphere Application Status Test

Sometimes, a web application deployed on a WebSphere Application Server may be stopped for maintenance or for debugging activity. During such times, users will not be able to access the application. To proactively figure out the web applications that are stopped in a target environment and ensure better user experience, administrators need to constantly keep a vigil on the status of the web applications deployed on the target IBM WebSphere Application server. The WebSphere Application Status test helps administrators in this regard!

This test auto-discovers the web applications deployed on the target WebSphere application server and for each web application, this test reports the current status. Using this test, administrators can easily isolate the applications that are currently stopped and initiate remedial steps to start the applications before end users start complaining.

Note:

For this test to report metrics, the eG agent installed user/USER (specified in the Test configuration) should be within the WebSphere installed user group.

Target of the test : A WebSphere application server

Agent deploying the test : An internal agent

Outputs of the test : One set of results for each web application deployed on the target WebSphere application server being monitored

Configurable parameters for the test
Parameters	Description
Test period	How often should the test be executed .
Host	The IP address of the WebSphere application server
Port	The port number of the WebSphere application server
ServerHostName	Specify the host name of the application server instance being monitored.
AppPort	Specify the port number to be used for accessing the egurkha application that has been deployed on the server.
NodeName	eG Enterprise can auto-discover and auto-manage the target application server that is hosted on a container. In such containerized environments, this test can auto-discover the node name corresponding to the target server instance and report the metrics. To this effect, this parameter is set to EG_ENV_WAS_NODE. On the other hand, if the IBM WebSphere Application Server is directly installed in the target environment, you should specify the node name of the server instance being monitored. To know the node name, do the following: Login to the WebSphere Administrative Console. Expand the Servers node in the tree structure in the left pane of the console, and click on the Application Servers link within. A list of application server instances and their corresponding node names will then appear in the right pane of the console. From this list, you can figure out the Node that corresponds to the application server instance being monitored, and specify that name against the NodeName parameter.
ServerName	eG Enterprise can auto-discover and auto-manage the target application server that is hosted on a container. In such containerized environments, this test can auto-discover the name of target server instance and report the metrics. To this effect, this parameter is set to EG_ENV_SERVER_NAME. On the other hand, if the IBM WebSphere Application Server is directly installed in the target environment, you should provide the name of the server instance being monitored in the SERVERNAME text box. To know the server name, do the following: Login to the WebSphere Administrative Console. Expand the Servers node in the tree structure in the left pane of the console, and click on the Application Servers link within. A list of application server instances and their corresponding node names will then appear in the right pane of the console. From this list, you can figure out the Name of the monitored server instance, and specify that name against the ServerName parameter. If the server instance being monitored is part of a WebSphere cluster, then you need to provide the host name that corresponds to the connector port of the Deployment Manager of the cluster as the ServerName. To determine the ServerName in this case, do the following: Connect to the WebSphere Administrative console using the URL: http://<IP address of the WebSphere server:Port number of the WebSphere server>\adminor https://<IP address of the WebSphere server:Port number of the WebSphere server>\admin. Login to the WebSphere Administrative console Expand the System Administration node in the tree-structure in the left pane of the console and click on the Deployment Manager sub-node within. In the right panel, click on the Configuration tab page to view the configuration of the Deployment Manager. In the Additional Properties section of the Configuration tab page, expand the Ports node. A list of ports will then appear. Click on the Details button alongside the ports list. If the SOAP port has been set as the connector port in your environment, then scroll down the page that appears next until you view the Port Name, SOAP_CONNECTOR_ADDRESS. Make note of the Host name that corresponds to this port name. If the RMI port is the connector port in your environment, then make note of the Host name that corresponds to the Port name, BOOTSTRAP_ADDRESS. Specify this Host name as the ServerName.
ConnectorPort	The applications that are deployed on a server instance use the ConnectorPort for all internal communications with the application server. The connector port can be a SOAP port or an RMI port. The default connector port however, is the SOAP port. To know the connector port number, do the following: Login to the WebSphere Administrative Console. Expand the Servers node in the tree structure in the left pane of the console, and click on Application Servers within. A list of application server instances and their corresponding node names will then appear in the right pane of the console. In the right pane, click on the server name link that corresponds to the server instance that is being monitored. Doing so invokes the Configuration of the application server instance clicked on. Scroll down the Configuration tab page to view the Communications section. Expand the Ports link in this section to view a list of ports. If the default connector port is in use, then the port number displayed against SOAP_CONNECTOR_ADDRESS should be specified as the ConnectorPort. If an RMI port has been explicitly set as the connector port, then specify the port number displayed against BOOTSTRAP_ADDRESS as the ConnectorPort. If the server instance being monitored is part of a WebSphere cluster, then you need to provide the SOAP/RMI port of the Deployment Manager of the cluster as the ConnectorPort. To determine the ConnectorPort in this case, do the following: Connect to the WebSphere Administrative console using the URL: http://<IP address of the WebSphere server:Port number of the WebSphere server>\adminor https://<IP address of the WebSphere server:Port number of the WebSphere server>\admin. Login to the WebSphere Administrative console. Expand the System Administration node in the tree-structure in the left pane of the console and click on the Deployment Manager sub-node within. In the right panel, click on the Configuration tab page to view the configuration of the Deployment Manager. In the Additional Properties section of the Configuration tab page, expand the Ports node. A list of ports will then appear. If the default connector port is in use, then the port number displayed against SOAP_CONNECTOR_ADDRESS should be specified as the ConnectorPort. If an RMI port has been explicitly set as the connector port, then specify the port number displayed against BOOTSTRAP_ADDRESS as the ConnectorPort.
SSL	Select Yes if SSL (Secured Socket Layer) is to be used to connect to the WebSphere server, and No if it is not.
User	If security has been enabled for the WebSphere server being monitored, then provide a valid USER name to login to the WebSphere server. While monitoring IBM Websphere Application server 8.x and above, if the user belongs to an external LDAP directory, then, ensure that the User is assigned the Monitor role. If the WebSphere server does not require any authentication, then the USER text box should contain the default value 'none'.
Password	If security has been enabled for the WebSphere server being monitored, then provide the Password that corresponds to the specified User name. If the WebSphere server does not require any authentication, then leave the Password text box with its default setting.
Confirm Password	If security has been enabled, confirm the specified Password by retyping it in the Confirm Password text box. If the WebSphere server does not require any authentication, then leave the Confirm Password text box with its default setting.
WSAdmin Location	By default, the eG agent launches the WSAdmin tool to execute the WSAdmin script in order to auto-discover the applications deployed on the target IBM WebSphere Application Server. For the eG agent to successfully launch the tool and execute the WSAdmin script, you need to specify the exact location of the WSAdmin tool. For example, a sample location of the WSAdmin tool is: C:\Program Files\IBM\WebSphere\AppServer\profiles\Dmgr01\bin.
CellName	For the eG agent to execute the WSAdmin script and collect the required metrics, the eG agent should be configured with the cell name of the server instance being monitored. To know the cell name, do the following: Login to the WebSphere Administrative Console. Expand the Servers node in the tree structure in the left pane of the console, and click on the Application Servers link within. In the right panel that appears, the Cell name and the Profile name of the Application Servers will be displayed. Specify this cell name against the CellName parameter.

Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

Application status

Indicates the current state of this web application.

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure Value	Numeric Value
Running	100
Stopped	1

Note:

By default, this measure reports the above-mentioned Measure Values to indicate the current state of this web application. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 100.