使用WebLogic JMX进行定制调试

wang_rx

     维护复杂的遗留系统是一项挑战，而文档、理性设计以及编码实践的缺乏通常会使情况变得更为糟糕。遗憾的是，几乎所有的软件开发人员在其职业生涯中都会遇到此类任务。
　　对于任何使用数据库的应用程序，跟踪应用程序所生成的SQL语句是非常有益的。这样的跟踪有助于分析性能瓶颈和调试错误，还可以帮助开发人员了解与应用程序相关的业务流程。
　　对于遗留的应用程序，我们希望可以进行这样的跟踪而不必修改任何代码或应用程序配置。利用WebLogic的JMX API，我们可以快速地编写出跟踪大型复杂遗留应用程序的JDBC调用的少量代码，而不会对现有代码和应用程序配置产生影响。此外，这种小项目有助于我们理解JMX以及在幕后WebLogic是如何使用JMX的。在本文中，我将展示利用WebLogic JMX跟踪SQL语句的细节。
什么是JMX？
　　JMX全称为Java Management Extensions（Java管理扩展）。MBean（即managed bean，托管bean）是可以通过JMX API进行管理的资源。大多数应用服务器使用JMX来提供管理控制台并管理资源。此外，应用程序开发人员可以在他们的定制应用程序中使用JMX来提供管理和审计功能。
WebLogic的JMX实现为开发人员和管理员提供了哪些优点？
　　WebLogic Server使用JMX MBeans进行配置和管理。每个WebLogic Server会有一个自己的MBean的副本，它由管理服务器负责更新。管理服务器维护它所管理的所有服务器的MBeans的正本。一旦管理服务器发生故障，托管服务器将根据本地的MBean副本运行，直到管理服务器可以再次更新该服务器的本地MBean。
　　WebLogic不仅提供了一个使用JMX MBeans的管理控制台，它还提供了一个API以便允许应用程序开发人员配置和研究WebLogic资源。利用WebLogic JMX的最容易的方式就是使用WebLogic控制台来更改WebLogic资源的配置，以及查看控制台中的技术指标。虽然WebLogic控制台的监控和配置功能相当强大，可以满足运行在WebLogic上的大多数应用程序的需要，WebLogic JMX API还是提供了一种更为强大的工具来管理运行在WebLogic平台上的应用程序。WebLogic JMX API的使用使得配置和扩展WebLogic资源成为可能，还可以从WebLogic的子系统接收通知。例如，一个JDBC连接的最小和最大数设为n的应用程序可能希望有一个监听器，以便监听来自WebLogic JMX MBeans的通知，并且在有n-x个并发JDBC连接使用应用程序时，会向管理员发送电子邮件，从而使管理员可以决定增加n值并重新配置JDBC连接池（这里x是一个由管理员决定的任意数字）。应用程序开发人员进一步使用JMX的例子包括WebLogic子系统中的跟踪事件，包括EJB事件和服务器启动/停止事件。
在分析JDBC语句方面，WebLogic应用程序中有哪些可用选项？
　　在WebLogic应用程序中，有多种技术可以用来创建对JDBC语句的动态跟踪。为来自java.sql包的Statement、PreparedStatement和CallableStatement类创建子类，以便使用Log4J或WebLogic记录之类的记录系统打印跟踪信息，然后在应用程序中使用这些子类，这是一个可行方案，但是并不适用于遗留代码。也可以使用类似于TOAD的工具来实现这种跟踪，但是此类工具对于应用程序开发人员而言可能不容易得到，而且可能无法提供所需的全部信息。AOP技术是打印JDBC语句的另一种可行方案。然而在撰写本文时，BEA WebLogic还没有正式支持AOP，尽管关于WebLogic AOP的文章已经在dev2dev网站上出现。在撰写本文时，在WebLogic上实现AOP也并不是一项轻而易举的任务。使用WebLogic 6.1或8.1的WebLogic JMX不需要使用任何附加的类库和配置，因为所需的所有类均可在weblogic.jar中得到，而且代码实现起来相当简单。况且WebLogic JMX是一项非常成熟的技术，可以通过不改变任何核心应用程序代码或者字节码来实现。
使用WebLogic JMX API
　　WebLogic javadoc可以通过http://e-docs.bea.com/wls/docs81/javadocs/在线获得。该API包括几个名称中包含management的包，这些包就是WebLogic的JMX实现（参见表1）。

　　使用JMX跟踪JDBC调用
　　一种编写跟踪代码并提供一个用户界面来查看SQL的简单方法是编写一个JSP、一个Servlet以及一个Java Bean或对象。我们将展示bean/POJO的全部细节，而省去用户界面/控制器方面的大多数细节，因为大多数WebLogic开发人员对此已有很深的了解。注意，无需修改任何部署描述符、数据库连接池或数据源来实现跟踪，所有对应用程序的更改将在运行时进行。
步骤1
　　首先我们将创建一个名为MyTracerBean.java的类，并导入所需的WebLogic JMX包和类。

import javax.naming.Context;
import weblogic.jndi.Environment;
import weblogic.management.MBeanHome;
import weblogic.management.configuration.JDBCConnectionPoolMBean;
import weblogic.management.runtime.JDBCStatementProfile;
import weblogic.management.runtime.JDBCConnectionPoolRuntimeMBean;
import javax.management.InstanceNotFoundException;
import javax.management.InvalidAttributeValueException;
import javax.naming.NamingException;

　　这些类均位于weblogic.jar中，因此不需要向WebLogic类路径添加任何JAR或类。
步骤2
　　接下来我们将编写一个获取MBeanHome的方法。

private MBeanHome getMBeanHome() {
//URL to the serve whose JDBC activity we are tracing
String url = "t3://localhost:7001";
String username = "mywlconsoleuname";
String password = "mywlconsolepsswd";
//The MBeanHome will allow us to
//retrieve the MBeans related to JDBC statement tracing
MBeanHome home = null;
try { //We'll need the environment so that we can //retrieve the initial context
Environment env = new Environment();
env.setProviderUrl(url);
env.setSecurityPrincipal(username);
env.setSecurityCredentials(password Context ctx = env.getInitialContext();
//Retrieving the MBeanHome interface for the server with //the url t3://localhost:7001
home =(MBeanHome)ctx.lookup(MBeanHome.LOCAL_JNDI_NAME);
} catch (NamingException ne) {
System.out.println("Error getting MBeanHome " + ne);
}
return home;
}

　　对于最简单的情形：管理服务器也驻留了我们要跟踪的JDBC应用程序，上述代码完全可行；但是对于管理服务器独立于托管服务器，并且涉及到几个独立JVM的情形，我们需要获得管理MBeans home而不是本地MBeans home。二者的区别在于，本地home只为单个服务器提供Mbean，而管理home则为管理服务器所管理的所有服务器提供MBean。为了获得管理MBeans home而不是本地MBeans home，可以将上述代码中的LOCAL_JNDI_NAME替换为ADMIN_JNDI_NAME。
步骤3
　　提供一种打开和关闭JDBC分析的方式是非常有用的，因为分析的开销相当大，所以不需要时应当将其关闭。默认情况下，分析是关闭的，因此必须在跟踪任何JDBC语句前打开它。创建一个如下的方法：
public void configureJDBCAuditing(boolean isOn) {
try {
MBeanHome home = getMBeanHome();
//Retreive the bean to help us configure the Pool
JDBCConnectionPoolMBean mConfigBean =
(JDBCConnectionPoolMBean)home.getConfigurationMBean("MyPool","JDBCConnectionPoolConfig");
mConfigBean.setSqlStmtProfilingEnabled(isOn);
mConfigBean.setSqlStmtParamLoggingEnabled(isOn);
} catch (InvalidAttributeValueException iave) {
System.out.println("Invalid attribute while configuring tracing " + iave);
} catch (InstanceNotFoundException infe) {
System.out.println("Instance not found while configuring tracing " + infe);
}
}

　　在上述代码中，我们还告知连接池我们希望查看传入SQL语句中的参数。这会增加跟踪的开销，但是它可以为我们提供一些有价值的信息。
步骤4
　　在配置JDBC池来保存配置文件之后，我们可以对其进行查询。记住，检索到的配置文件数等于打开分析后所执行的SQL语句数，而不等于所有由MyPool ConnectionPool执行的SQL语句数。以下的代码检索配置文件，maxProfiles参数指示应该获取最近的多少个配置文件。创建的方法如下：
/** Pass in -1 to get all profiles */
public JDBCStatementProfile[] getProfiles(int maxProfiles) {
JDBCStatementProfile[] profiles = null;
try {
MBeanHome home = getMBeanHome();
JDBCConnectionPoolRuntimeMBean mbean =
(JDBCConnectionPoolRuntimeMBean)home.getRuntimeMBean("MyPool
","JDBCConnectionPoolRuntime");
int numProfiles = mbean.getStatementProfileCount();
int profilesIndex = 0;
//figure out index to start at and how many we want
if (maxProfiles != -1) {
profilesIndex = numProfiles - maxProfiles;
}else {
maxProfiles = numProfiles;
}
profiles =mbean.getStatementProfiles(profilesIndex,maxProfiles);
} catch (InstanceNotFoundException infe) {
System.out.println("Problem retrieving jdbc profiles " + infe);
}
return profiles;
}

　　JDBCConnectionPoolRuntimeMBean的getStatementProfiles方法在WebLogic 8.1 API文档中没有提及，尽管它曾在WebLogic 6.1文档中出现。不过这看起来是个错误，因为在WebLogic 8.1中该方法是可用的，并且WebLogic 8.1还修复了方法中的一个bug（CR094729，参见http://e-docs.bea.com/wls/docs81/notes/resolved_sp01.html），这意味着WebLogic 8.1是打算包含该方法的。
步骤5
　　可以添加一个清空功能，使得重启服务器时可以清空语句缓存：
public void reset() {
MBeanHome home = getMBeanHome();
try {
JDBCConnectionPoolRuntimeMBean mbean =
(JDBCConnectionPoolRuntimeMBean)home.getRuntimeMBean("MyPool
","JDBCConnectionPoolRuntime");
//Remove everything from the cache
mbean.resetStatementProfile();
} catch (InstanceNotFoundException infe) {
System.out.println("Problem while resetting JDBC profiles " + infe);
}
}

步骤6
　　对配置文件进行迭代，获得要显示的信息（参见清单1）。这些代码可能放在用户界面层，比如放在一个JSP中。
清单1
MyTracerBean myTracer = new MyTracerBean();
//In this case we want the 100 most recently executed statements
JDBCStatementProfile[] profiles = myTracer.getProfiles(100);
//Doing the looping so that the most recent statements information is
//retrieved first
for (int i=profiles.length-1;i>-1;i--) {
//Getting the number of parameters passed into the current //statement
int paramCount = profiles.getParameterCount();
//Format the start and end time for the current statement
SimpleDateFormat simpleDateFormat =
new SimpleDateFormat("yyyyy.MMMMM.dd GGG hh:mm:ss:SS aaa");
String startTime=simpleDateFormat.format(new Date(profiles.getStartTime()));
String endTime=simpleDateFormat.format(new Date(profiles.getStopTime()));
//Append the parameters together in order to display them
StringBuffer paramsBuffer = new StringBuffer();
if (paramCount < 1) {
paramsBuffer.append("None");
} else {
for (int j=0;j<paramCount;j++) {
paramsBuffer.append(profiles.getParameter(j));
paramsBuffer.append(" ");
}
}
String statementTxt = profiles.getStatementText();
String paramsTxt = paramsBuffer.toString();
String timeTaken = profiles.getTimeTaken()
//Then use statementTxt, paramsTxt, timeTaken, startTime, endTime
// etc to show the statement details in a UI
}

　　展望WebLogic JMX的前景
　　在撰写本文时，刚刚发布的WebLogic 9.0支持的是JMX 1.2而不是WebLogic 8.1及以前版本一直支持的JMX 1.0。响应JMX规范的变化，9.0中的WebLogic JMX API有了相当大的变化，清单1中的代码可能会引起不支持的警告。当升级至9.0时，应当用JDBCDataSourceRuntimeMBean替换JDBCConnectionPoolRuntimeMBean。不过，在撰写本文时，绝大多数运行在WebLogic上的遗留应用程序还没有使用WebLogic Server 9.0，而且很可能在相当长的一段时间内不会使用9.0。
　　原文出处: Custom Debugging with WebLogic JMX http://wldj.sys-con.com/read/138275.htm

作者简介
	Salma Saad在International Survey Research公司工作，她负责ISR的完善且高可用的全球调查报告网站，在Java及相关技术领域拥有接近十年的专业经验。