Welcome!

Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Custom Debugging with WebLogic JMX

Trace your JDBC calls without modifying your existing code

Maintaining complicated legacy applications is a challenge, which is often made worse by lack of documentation, nonintuitive design, and coding practices. Unfortunately almost all software developers will find themselves with such an assignment at some point in their careers.

In the case of any application that utilizes a database, it is very useful to trace SQL statements generated by the application. Such a trace would help with profiling performance bottlenecks, debugging errors, and in facilitating the developer's understanding of the business processes associated with the application.

In the case of legacy applications we would want to do such tracing without changing any code or application configuration. I was able to use WebLogic's JMX API to quickly put together a little code to trace the JDBC calls of a very large and complicated legacy application without impacting the code and configuration of the application. In addition, this small project helped facilitate my understanding of JMX and how WebLogic uses JMX behind the scenes. In this article I will go over the details of using WebLogic JMX to trace SQL statements.

What is JMX?
JMX stands for Java Management Extensions. MBeans, or managed beans, are resources that can be managed through the JMX API. Most application servers use JMX to provide administration consoles and to manage resources. In addition, application developers can use JMX to provide administration and auditing capabilities in their custom applications.

What Advantages Does WebLogic's JMX Implementation Provide for Developers and Administrators?
WebLogic Servers use JMX MBeans for configuration and management. A WebLogic Server each has a copy of its own MBeans, which is updated by the administration server. The administration server maintains a master copy of the MBeans for all of the servers that it manages. If the administration server fails to come up, the managed servers can function based on their local copy of the MBeans until the administration server can become available to update the server's local MBeans.

Web Logic provides both an administration console, which does its work using JMX MBeans, as well as an API to allow application developers to configure and explore WebLogic resources. The easiest way to take advantage of WebLogic JMX is to use the WebLogic console to change the configuration of WebLogic resources and to view the metrics available in the console. While the monitoring and configuration capabilities of the WebLogic console are very powerful and will meet the needs of most applications running on WebLogic, the WebLogic JMX API provides an even more powerful instrument for managing applications running on the WebLogic platform. Using the WebLogic JMX API it is possible to configure and extend WebLogic resources and to also receive notifications from WebLogic's subsystems. For example, an application that is configured with n as the value for minimum and maximum number of JDBC connections might want to have a listener that listens to notifications from the WebLogic JMX MBeans and sends e-mail to an administrator in case the usage of the application crosses n-x concurrent JDBC connections, so that the administrator can decide on an increased value for n and reconfigure the JDBC connection pool(s) (where x is an arbitrary number that depends on the comfort level of the administrator). Examples of advanced uses of JMX by application developers include tracing events in the WebLogic subsystems, including EJB events and server start/stop events.

What Options Are Available for Profiling JDBC Statements in WebLogic Applications?
There are several techniques that can be used to create a dynamic trace of JDBC statements in a WebLogic application. Subclassing the Statement,PreparedStatement and CallableStatement classes from the java.sql package to print a trace using a logging system like Log4J or WebLogic logging and then using the subclasses in the application is a viable option, but it is not practical in the case of legacy code. Such traces may be available from tools such as TOAD, but such tools may not be easily available to application developers and may not provide all of the information that is required. AOP techniques are another valid choice for printing JDBC statements. However, at the time of writing AOP is not officially supported in WebLogic by BEA even though articles about WebLogic AOP have appeared on the dev2dev site. At the time of writing, getting AOP to work in WebLogic is not a trivial project. Using WebLogic JMX with WebLogic 6.1 and 8.1 does not require the use of any additional libraries or configuration, since all the required classes are available in weblogic.jar and the code is very simple to implement. In addition WebLogic JMX is a very mature technology and can be implemented without any changes to the core application code or bytecode.

Using the WebLogic JMX API
The WebLogic javadocs are available online at http://e-docs.bea.com/wls/docs81/javadocs/. The API contains several packages with management in their names. These packages are WebLogic's JMX implementation (see Table 1).

Using JMX to Trace JDBC Calls
A simple way to organize the tracing code and provide a UI to view the SQL is to write a JSP, a servlet, and a Java Bean or object. We'll go through the details of the bean/POJO here and leave most of the details of the UI/controller aspect out since most WebLogic developers already understand these very well. Note that you need not modify any deployment descriptors, database connection pools, or data sources in order to get the tracing to work. All changes to the needed application will happen at run time.

Step 1
First we'll create a class called MyTracerBean.java and import the WebLogic JMX packages and classes that we'll need.

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;

See Figure 1

These classes are in the weblogic.jar so you won't need to add any JARs or classes to the WebLogic classpath.

Step 2
Next we'll write a method to get the 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;
}

More Stories By Salma Saad

Salma started her career back in 1993, working on Steve Jobs NeXT platform and moved on to Java when it was at the ‘bleeding edge’. She has worked as a consultant for more than ten years, working primarily on website development projects for a large variety of clients. In addition to her fascination with everything technical she also has a strong interest in developing her leadership and management expertise. She enjoys living in Chicago and being the mother of two rugrats, ...um boys and is currently working for Arc Worldwide/Leo Burnett helping fortune 500 clients build awe-inspiring websites.

Comments (1) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
Oscar Madrigal 11/23/05 08:17:44 PM EST

Great tip but only log the succesfull statements, how can trace fails statements?

@ThingsExpo Stories
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
DevOps at Cloud Expo – being held June 5-7, 2018, at the Javits Center in New York, NY – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real results. Among the proven benefits,...
@DevOpsSummit at Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, is co-located with 22nd Cloud Expo | 1st DXWorld Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
SYS-CON Events announced today that T-Mobile exhibited at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on qua...
SYS-CON Events announced today that Cedexis will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Cedexis is the leader in data-driven enterprise global traffic management. Whether optimizing traffic through datacenters, clouds, CDNs, or any combination, Cedexis solutions drive quality and cost-effectiveness. For more information, please visit https://www.cedexis.com.
SYS-CON Events announced today that Google Cloud has been named “Keynote Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Companies come to Google Cloud to transform their businesses. Google Cloud’s comprehensive portfolio – from infrastructure to apps to devices – helps enterprises innovate faster, scale smarter, stay secure, and do more with data than ever before.
SYS-CON Events announced today that Vivint to exhibit at SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California. As a leading smart home technology provider, Vivint offers home security, energy management, home automation, local cloud storage, and high-speed Internet solutions to more than one million customers throughout the United States and Canada. The end result is a smart home solution that sav...
SYS-CON Events announced today that Opsani will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Opsani is the leading provider of deployment automation systems for running and scaling traditional enterprise applications on container infrastructure.
SYS-CON Events announced today that Nirmata will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nirmata provides a comprehensive platform, for deploying, operating, and optimizing containerized applications across clouds, powered by Kubernetes. Nirmata empowers enterprise DevOps teams by fully automating the complex operations and management of application containers and its underlying ...
SYS-CON Events announced today that Opsani to exhibit at SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California. Opsani is creating the next generation of automated continuous deployment tools designed specifically for containers. How is continuous deployment different from continuous integration and continuous delivery? CI/CD tools provide build and test. Continuous Deployment is the means by which...