Chapter 72 Portal Server : Java Enterprise System Monitoring Framework Integration

This chapter contains the following sections to explain the integration of Portal Server product and Java Enterprise System Monitoring Framework (JESMF):

• JESMF

• JESMC

• Common Agent Container

• Portal Server:JESMF Detailed Mapping

• Portal Server:Desktop Detailed Mapping

• JESMF Extensions for Portal Server

• Installing and Configuring Portal Server:JESMF Integration

• Enabling or Disabling Portal Server:JESMF Integration

JESMF

JESMF is a Java Enterprise System (JES) common component that provides a single view of all the elements that compromise the JES stack. JESMF aims to simplify business by providing a single, consistent, qualified (Information relating to each component product is always equivalent. For example, a state of DEGRADED has the same meaning for every component product), relational (all the components in the monitored stack are interrelated) , and actionable (rather than simply regularly polling different monitored components to obtain information about them, it is sent by the component products only when action is required) service-oriented monitoring model for all JES components thereby providing information about the performance and status of the various JES component products in the stack.

JESMF follows a Common Information Model (CIM) - based monitoring model, improves usability, and adds support for existing CP metrics, and SNMP exposure of well known MIBs. It also implements Lockhart based JES Monitoring Console (JESMC) application on top of the infrastructure software that allows users to view monitored data.

JESMC

JES Monitoring Console helps visualizing JES component products monitored data exposed by JESMF. JESMC provides JES end users with a clear view of how their JES stack is performing and to provide them the means to take action appropriately. The data collected by JESMF is made available to such industry standard management applications as HP Open View, Tivoli or Solaris Management Agent.

The JESMC is a Lockhart based GUI. When the Monitoring Console and Lockhart are installed on your system, you can view the console by entering the following URL into the browser:

https://host_name:6789 where the host_name represents the name or IP address of the machine on which Lockhart and JESMF are running. Port number 6789 is the officially registered port reserved for Lockhart.

The Monitoring Console exposes the following through various data views:

• Hierarchy of the monitored objects implemented in the JES Core Information Base.

• Usage relationships (a component product may depend on other product services).

• Operational status and availability status of the monitored objects.

• Performance statistics of the monitored objects.

The JESMC operates within real-time (given the inherent refresh restrictions of a browser). As a host is added to the scope of the console, installed and running JES component products are automatically discovered. As Component Products are discovered, the monitored objects that represent these products are visualized within the console. When the user refreshes the browser, the current JES installation and associated statistics are reflected in the console.

The Monitoring Console allows the user to set threshold values on any monitored object by creating a Monitoring Rule. An alarm is generated when a threshold value is crossed.

The JESMC is not a management console. No administrative commands, other than creating monitoring rules are possible.

In particular, the Console does not:

• Permit administrative operations on the monitored products.

• Provide a link to the admin console of the product.

• Provide the ability to browse or analyze any of the gathered job results.

The Monitoring Console is composed of two elements:

• A web application integrated into the Lockhart console and based on the Lockhart components.

• The client API runs on the same host as the JESMF Master Agent and provides a simple and efficient way to access JESMF data. Both the elements communicate using the JMX technology. The client API is an internal API that is not exposed to users of the console or users of JESMF. The client API is a Mbean instantiated in the Mbean server in which the MA is running.

Users expect JES to deliver an integrated management and monitoring system, which deliver the services they need in a reliable and predictable manner. The JESMF is a major step toward achieving this.

The benefits expected from JESMF architecture are:

• Dynamic Adaptability: JMX monitoring agents can support new monitoring service types for dynamically created services.

• Easy to Integrate with legacy systems through protocol adapters and connectors.

• Low Cost: JMX manageability can be readily implemented in software products without having to pay the learning curve cost of complex system management technologies and information models.

For more information JESMF and JESMC, refer the Sun Java Enterprise System 5 Monitoring Guide in http://docs.sun.com.

Common Agent Container

Common agent container is a stand alone Java program that implements a container for Java management applications. Common agent container provides a management infrastructure designed for JMX and JDMK - based management functionality. Common agent container is designed to accept modules that extend an existing JMX or JDMK agent with new managed objects, connectors, or new functionality.

The Portal Server JESMF integration adds a common agent container module for itself.

Portal Server:JESMF Detailed Mapping

This section provides a list of attributes, which are used to map the Portal Server and JESMF.

CMM_InstalledProduct:PortalServer

<xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE module SYSTEM "urn:sun:n1:cacao:module:dtd:1_1">
<module name="com.sun.cmm.ps"
initial-administrative-state
="UNLOCKED">
	<description>
	PS:JESMF Integration Module
	</description>

	<module-dependencies>
		<instance-dependency dependency-type=
		"STRONG-DEPENDENCY">
			<name>
				com.sun.mfwk
			</name>
		</instance-dependency>
	</module-dependencies>

	<module-class>
			com.sun.mfwk.MfCPmodule
	</module-class>

	<cacao-version-supported>
			1.1
	</cacao-version-supported>

	<heap-requirements-kilobytes>
			100
	</heap-requirements-kilobytes>

		<parameters>
			<parameter>
				<param-name>ProductName</param-name>
				<param-value>Portal Server</param-value>
			</parameter>

					<parameter>
				<param-name>InstalledLocation</param-name>
				<param-value>/opt/SUNWportal</param-value>
			</parameter>

				<parameter>
				<param-name>BuildNumber</param-name>
				<param-value>7.1</param-value>
			</parameter>

			<parameter>
				<param-name>PatchID</param-name>
				<param-value>7.1</param-value>
			</parameter>

			<parameter>
				<param-name>RevisionNumber
				</param-name>
				<param-value>7.1</param-value>
			</parameter>

			<parameter>
				<param-name>InstallDate</param-name>
				<param-value>1160635803475
				</param-value>
			</parameter>

			<parameter>
				<param-name>Caption</param-name>
				<param-value>Portal Server
				</param-value>
			</parameter>

			<parameter>
				<param-name>Description</param-name>
				<param-value>Portal Server
				</param-value>
			</parameter>

			<parameter>
				<param-name>ProductIdentifyingNumber
				</param-name>
				<param-value>7.1</param-value>
			</parameter>

			<parameter>
				<param-name>ProductVendor
				</param-name>
				<param-value>SMI</param-value>
			</parameter>

			<parameter>
				<param-name>ProductVersion
				</param-name>
				<param-value>7.1</param-value>
			</parameter>
	</parameters>
</module>

CMM_ApplicationSystem:PortalServerInstance

Portal Server:Desktop Detailed Mapping

CMM_LogicalComponent:Desktop

CMM_Service:Desktop

CMM_ServiceAccessURI:DesktopServiceAccessURI

CMM_LogicalComponent:Provider

CMM_Service:- Content, Edit, Process, Logout, PreLogin, LocalAuth, Exception

CMM_Service:- Content, Edit, Process

CMM_ThreadPool:- GetterPool, CallerPool

JESMF Extensions for Portal Server

The JESMF extensions for Portal Server product are:

CMM_PSServiceStats

CMM_PSRollingAvgServiceStats extends CMM_ServiceStats with the following two additional metrics:

CMM_PSServiceSetting

CMM_PSRollingAvgServiceStats works with CMM_PSRollingAvgServiceSetting. CMM_PSRollingAvgServiceSetting extends CMM_ServiceSetting with the following two additional properties that help managing CMM_PSRollingAvgServiceStats:

Installing and Configuring Portal Server:JESMF Integration

In JES 5, the installation and configuration of Portal Server:JESMF integration occurs by default. If you need to upgrade the system to JES 5, then you require to install and configure. This section explains about how you can install and configure Portal Server:JESMF Integration.

PS:JESMF Integration depends on three JES shared components:

• Jdmk5.1-patch1

• Cacao2.0

• JESMF2.0

These shared components are part of JES 5. JES 4 supported earlier versions such as Jdmk5.1, Cacao1.1, and JESMF1.0. Use these components if you use JES 4. While upgrade, you need to first upgrade the shared components to JES 5 and then enable Portal Server:JESMF Integration.

For upgrade or migration, when Cacao2.0 or JESMF2.0 is not installed, then Portal Server:JESMF Integration should be disabled. This means that no configuration should happen for Portal Server:JESMF Integration.

These are high level requirements to configure Portal Server:JESMF Integration:

1. Copy /opt/SUNWportal/template/jesmf/com.sun.cmm.ps.xml to /tmp, and change the following tokens:

   • %ps.product.location%

   • %PRODUCT_VERSION%

   • %ps.install.datetime%

2. Register JESMF 2.0 module using com.sun.cmm.ps.xml from <baseDir>/template/jesmf/com.sun.cmm.ps.xml. Following tokens should be replaced with correct values at config time in this file:

3. InstallLocation should be set to install directory of portal. For example, on Solaris with default install location as /opt.

4. InstalledDate should be set to current system time of configuration. For example, System.currentTimeMillis() value should be dumped as token value.

   ---

   Note –

   You need to use “<jesmfInstallDir>/bin/mfwksetup -r <path_to_com.sun.cmm.ps.xml>” to register Portal Server:JESMF common agent container module. This should happen only for the first instance for any portal getting created on this Operating System (OS) node. There is only one Portal Server:JESMF common agent container 2.0 module on one OS node.

   ---

5. Check the web containers configuration to see if this jar (and jdmkrt.jar) is present in the server classpath. If it is not present, add it to web containers server classpath.

6. Copy desktopmfwk.properties to /var/opt/SUNWportal/portals/<portalid>config/<instanceId> form <baseDir>/template/jesmf/desktopmfwk.properties.

7. In the desktopmfwk.properties file, replace the %PS_DIR% token with install location. For example, /opt/SUNWportal on Solaris.

The Portal Server:JESMF Integration unconfiguration happens when a portal server instance is deleted from an OS-node. These are high level requirements to unconfigure Portal Server:JESMF Integration:

• Whenever a portal server instance (portal web-application) is deleted on an OS-node, delete /var/opt/SUNWportal/portals/<portalId>/config/<instanceId>/desktopmfwk.properties.

• If this is the last portal server instance of the last portal being deleted on this OS-node, unregister PS:JESMF Integration common agent container module using "<jesmfInstallDir>/bin/mfwksetup -u <path_to_com.sun.cmm.ps.xml>”.

Enabling or Disabling Portal Server:JESMF Integration

This section explains how to enable or disable Portal Server:JESMF integration.

To Enable Portal Server:JESMF Integration:

1. Set the com.sun.portal.mfwk.disable property in desktopmfwk.properties to “False”.

2. Restart Portal Server to make the changes take effect.

To Disable Portal Server:JESMF Integration:

1. Set the com.sun.portal.mfwk.disable property in desktopmfwk.properties to “True”.

2. Restart Portal Server to make the changes take effect.