使用JavaMelody监控Java EE应用

孟君

发布于 2019-10-22 16:49:51

1K0

发布于 2019-10-22 16:49:51

本文主要完成如下一个任务：

对一个已有的Web应用工程，添加JavaMelody工具，
从而去监控和查看Web应用的运行情况，比如：
Http请求的执行时间、SQL语句的执行时间、PDF报表的生成。

一、JavaMelody 简介

从Java Melody的WIKI页面上可以看到：

The goal of JavaMelody is to monitor Java or Java EE applications in QA and production environments. It is not a tool to simulate requests from users, it is a tool to measure and calculate statistics on real operation of an application depending on the usage of the application by users. from https://github.com/javamelody/javamelody/wiki

JavaMelody的目标是监控QA环境或者生产环境Java或者Java EE应用。JavaMelody不是一个模拟用户请求的工具；它是一个用于对应用上的真实操作进行衡量和和计算统计的工具，这些真实的操作取决于用户在应用上的使用情况。

JavaMelody 能够监测Java或Java EE应用程序服务器，并以图表的方式显示：Java内存和Java CPU使用情况，用户Session数量，JDBC连接数，和http请求、sql请求、jsp页面与业务接口方法（EJB3、Spring、 Guice）的执行数量，平均执行时间，错误百分比等。图表可以按天，周，月，年或自定义时间段查看。

二、现有系统使用的技术和环境

用于测试的环境如下：

操作系统     ：   windows
数据库       ：   MySQL 5.6
Web服务器    ：   Tomcat 7.0.43
开源框架     ：   Spring 4.2、Mybatis 3.2.6 和 Spring MVC
IDE         ：   Eclipse

三、JavaMelody环境搭建

因为使用的是Maven搭建的Web工程，所以，本文给出的例子就是在已有的Maven工程上添加的。

通过两个步骤就可以将JavaMelody整合到已有的Maven工程中去。

pom.xml中添加JavaMelody依赖包

    <dependency>
        <groupId>net.bull.javamelody</groupId>
        <artifactId>javamelody-core</artifactId>
        <version>1.62.0</version>
    </dependency>

web.xml中添加JavaMelody过滤器和监听器

<!-- javamelody过滤器和监听器 -->
<filter>
    <filter-name>monitoring</filter-name>
    <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>monitoring</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<listener>
    <listener-class>net.bull.javamelody.SessionListener</listener-class>
</listener>

通过上述两个步骤，你就可以通过如下URL访问监控页面。

http:/<host>:<port>/<context>/monitoring

举个例子：如果host为localhost，port为8080，context为Demo，那么，可以通过如下URL访问监控页面。

http:/localhost:8080/Demo/monitoring

四、JavaMelody对SQL的监控

SQL语句的执行情况，是一个Web应用比较重要的部分。如果能看到SQL语句的执行时间等，就能够对系统有一个较好的、直观的理解。

要想JavaMelody能够对SQL语句进行监控，需要对现有的、配置的dataSource包装一下。

执行如下几个步骤，就能完成对SQL的监控。

修改现有dataSource的配置

修改前:

<property name="dataSource" ref="dataSource" />

如：

  <!-- 配置mybatis -->
  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource" />
    <property name="mapperLocations">
      <list>
        <value>classpath:com/demo/mybatis/auto/xml/**/*.xml</value>
        <value>classpath:com/demo/mybatis/manual/xml/**/*.xml</value>
      </list>
    </property>
  </bean>

修改后：

使用wrappedDataSource代替dataSource

    <!-- 配置mybatis -->
  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- <property name="dataSource" ref="dataSource" /> -->
    <property name="dataSource" ref="wrappedDataSource" />
    <property name="mapperLocations">
      <list>
        <value>classpath:com/demo/mybatis/auto/xml/**/*.xml</value>
        <value>classpath:com/demo/mybatis/manual/xml/**/*.xml</value>
      </list>
    </property>
  </bean>

创建monitoring-spring.xml配置文件

创建一个配置文件monitoring-spring.xml，在monitoring-spring.xml配置文件中，配置一个wrappedDataSource的Bean，其中，targetName对应的值为之前配置的dataSource。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tx="http://www.springframework.org/schema/tx"
  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">

  <bean id="monitoringAdvisor" class="net.bull.javamelody.MonitoringSpringAdvisor">
    <property name="pointcut">
      <bean class="net.bull.javamelody.MonitoredWithAnnotationPointcut" />
    </property>
  </bean>

  <bean
    class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" />

  <bean id="wrappedDataSource" class="net.bull.javamelody.SpringDataSourceFactoryBean">
    <property name="targetName" value="dataSource" />
  </bean>
</beans>

在applicationContext.xml中加载monitoring-spring.xml

  <import resource="classpath:monitoring-spring.xml" />
  <!-- 数据访问层配置 -->
  <import resource="classpath:spring-dao.xml" />
  <!--服务层配置 -->
  <import resource="classpath:spring-service.xml" />

经过上述，几个步骤，我们启动项目，在页面上点击几个页面，就可以看到相关页面SQL语句执行的情况，包括：SQL语句、SQL执行的平均时间等将展示在监控页面上。如：

在spring-dao.xml文件 dataSource的配置以及monitoring-spring.xml配置文件中的wrappedDataSource配置详情如下：

    <!-- 配置数据源 -->
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"
          destroy-method="close">
      <property name="driverClass" value="${jdbc.driverClassName}" />
    <property name="jdbcUrl" value="${jdbc.url}" />
    <property name="user" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />

    <property name="autoCommitOnClose" value="false" />
    <property name="maxIdleTime" value="${cpool.maxIdleTime}" />
    <property name="checkoutTimeout" value="${cpool.checkoutTimeout}" />
    <property name="initialPoolSize" value="${cpool.minPoolSize}" />
    <property name="minPoolSize" value="${cpool.minPoolSize}" />
    <property name="maxPoolSize" value="${cpool.maxPoolSize}" />
    <property name="acquireIncrement" value="${cpool.acquireIncrement}" />
    <property name="maxIdleTimeExcessConnections" value="${cpool.maxIdleTimeExcessConnections}" />
    </bean>
    
    <!-- 配置mybatis -->
  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- <property name="dataSource" ref="dataSource" /> -->
    <property name="dataSource" ref="wrappedDataSource" />
    <property name="mapperLocations">
      <list>
        <value>classpath:com/demo/mybatis/auto/xml/**/*.xml</value>
        <value>classpath:com/demo/mybatis/manual/xml/**/*.xml</value>
      </list>
    </property>
  </bean>

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tx="http://www.springframework.org/schema/tx"
  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">

  <bean id="monitoringAdvisor" class="net.bull.javamelody.MonitoringSpringAdvisor">
    <property name="pointcut">
      <bean class="net.bull.javamelody.MonitoredWithAnnotationPointcut" />
    </property>
  </bean>

  <bean
    class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" />

  <bean id="wrappedDataSource" class="net.bull.javamelody.SpringDataSourceFactoryBean">
    <property name="targetName" value="dataSource" />
  </bean>
</beans>

五、JavaMelody对现有监控状态生成报表

JavaMelody也提供了对PDF报表导出的支持。

要想实现该功能，我们只需要为JavaMelody添加用于生成PDF的包iText即可。

pom.xml文件中添加iText依赖包

    <!-- itext, option to add PDF export -->
    <dependency>
        <groupId>com.lowagie</groupId>
        <artifactId>itext</artifactId>
        <version>2.1.7</version>
        <exclusions>
            <exclusion>
                <artifactId>bcmail-jdk14</artifactId>
                <groupId>bouncycastle</groupId>
            </exclusion>
            <exclusion>
                <artifactId>bcprov-jdk14</artifactId>
                <groupId>bouncycastle</groupId>
            </exclusion>
            <exclusion>
                <artifactId>bctsp-jdk14</artifactId>
                <groupId>bouncycastle</groupId>
            </exclusion>
        </exclusions>
    </dependency>

只需要通过添加依赖包，就可以在JavaMolody监控页面上，点击PDF连接导出当前运行的所有图表信息。