Document History

Date

Author

Version Description & Notes

20110214

Michael O'Brien

1.0 Initial draft started

Problem Statement

This enhancement details work that will be done to enhance our basic JMX management API and add additional support for diagnostics and analytics reporting. We will also look at adding features that will enable developers to more accurately capture runtime performance and diagnostics information, as well as tools to interpret that data.

There are two issues to this enhancement that separately deal with management and diagnostics reporting.

Management API

Our existing runtime JMX management API that is exposed through the services MBean in any of the SUN JConsole, JRockit JRMC, Oracle JRF Enterprise Manager or JBoss web based console is sufficient but needs to be enhanced.

Diagnostics API

Our existing runtime performance monitoring API could be enhanced with more JVM reporting - ideally that would not itself add overhead. This type of monitoring is currently done with JRockit - however it does not specifically target the JPA runtime API.

Scope

The scope of this issue is limited to the primary EE application servers that we currently support via JMX. These are WebLogic, WebSphere, GlassFish and JBoss. We may also extend support to SE applications and EJB 3.1 Lite containers running exclusively in the web container.

Session Management

Unified Metadata

Metadata mappings from Annotations and ORM XML

JPA 2.0 Metamodel

Session Cache

Query Cache

Dependency Injection Reference

Spring, Session, Message-Driven and Singleton beans that reference or have injections of EMFs or EMs

L1 Cache

L2 Cache

JDBC Database Configuration

Extensibility and Multi-Tenancy

Management of shared schemas at design-time and runtime including DDL generation support for modified schemas.

We need to integrate with work done for Multi-Tenancy - which is a specific implementation of the Extensibility API

We need to integrate with work done for Extensibility - which is a general API for extending a schema at static (design-time) or dynamic(run-time). Multi-Tenancy is one implementation of this API.

Requirements

Before we can decide on how and where we will enhance our management, analytics and diagnostics support we need to answer the following questions.

Q1) What do we currently provide

Q2) What are we going to with existing enhancment requests and how will we merge these with new requirements.

Q3) What new features can we provide to leverage new or existing management, performance and analytics tools that ship with the latest application server releases

Q4) What new features can we provide on top of Q1-Q3 that are specific to EclipseLink that go beyond what is currently available.

WebLogic Specific Requirements

WebLogic Server has several monitoring API join points that we can use either at the WebLogic MBean level or through events exposed to JRMC for servers running on the JRockit JVM. We will need to work closely with the WLS team to finalize the interfaces between EclipseLink and WLS.

WebSphere Specific Requirements

JBoss Specific Requirements

Spring TC Specific Requirements

Tomcat Specific Requirements

Generic Server Requirements

Ideally, any new API should be available to all supported EE servers (not just WebLogic) and optionally SE clients.

R: Expose PerformanceProfiler/PerformanceMonitor events through a new MBean generic to all EE servers

Constraints

non-WebLogic EE servers may not benefit from performance tracking provided by JRockit out of the box. These servers (WebSphere, JBoss and GlassFish) can however use the JRockit JVM with minimal configuration changes.

JRMC EclipseLink MBean method and attribute usage

JRMC EclipseLink MBean Trigger Rules

An example would be a trigger on Number of Objects In All Identity Maps. In my [distributed case study] after running the server for 24 hours we reach around 26000 objects in the identity map before the map is reset back to 6000. Therefore if we put a trigger at say 26000 we should see an event once a day on a load of 1 transaction per second.

JRMC Live Method Profiler for EclipseLink User and API classes

JRMC Live Exception Count for EclipseLink API and JPA Spec Exceptions

JRMC Diagnostic Commands for running EclipseLink user or System Threads

Performance Monitor

Data Partitioning

Multi-Tenancy Support

R20.1: Integrate with work for Multi-Tenancy - which is a specific implementation of the Extensibility API

Extensibility Support

R20.2: Integrate with work for Extensibility - which is a general API for extending a schema at static (design-time) or dynamic(run-time). Multi-Tenancy is one implementation of this API.

For example see the section in the Use case where the user of the Extensibility API makes changes at runtime to the existing schema by adding a relationship via to be determined set of new attributes or functions in the JMX management interface.

Currently the Add action is supported. Delete and Update are not supported yet without an application shutdown.

Extensibility via Flex Columns

Any new JMX API introduced into EclipseLink will follow the API exposed by the ExtensionManager in the 340192 design document.