JavaMelody应用监控使用指南（一）-JAVA开发-优客志

JavaMelody教程

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

授权协议： LGPL

开发语言： Java

操作系统：跨平台

1、JavaMelody介绍

JavaMelody用于对Java应用或者应用服务器的QA以及开发环境的监控。它并不是一个模拟请求类似JMeter的压力测试工具，而是一个衡量并且计算在应用上的操作信息的工具，也就是说，它只负责对行为进行监控，而不负责触发操作。JavaMelody基于请求统计生成模拟图表，并为我们的应用程序在QA或者开发上提供下面的帮助：

给出平均的响应时间以及执行数
在某些操作趋势变得严重前给出提示
优化响应
找出响应瓶颈的根本
证实优化策略的效果

JDK版本要求：需要Java JDK在1.6或者1.6以上。

支持在以下应用服务器的部署以及监控：

servlet API在2.4以上
Tomcat 5.5 6 或者7
GlassFish v2或v3
JBoss 4,5,6,7
Jonas 4或5
Jetty 6或7
WebLogic 9,10,11

如果想要监控其他的服务器需要安装一些插件，详情阅读官方手册

官方wiki手册：https://github.com/javamelody/javamelody/wiki/UserGuide

GitHub：https://github.com/javamelody/javamelody

2、配置

需要注意的是，JavaMelody监控是非常简单的，部署也很快。通常JavaMelody与应用的整个都是软件自动完成的，并不需要用户做任何的操作。只需要修改一点配置文件即可。监控与应用整合一般都不会超过10秒钟，通常都会自动的被编译环境发现：你需要做的知识拷贝两个jar包，添加10行xml的代码。如果你发布的应用程序不是一个相对目录，而是war包，那么就需要阅读下面的章节了。如果是ear（EJBs）,那么就需要去阅读以下User Guide Advanced的一些相关内容了。

第一步：jar文件

找到两个jar包，一个是javamelody.jar，另一个是jrobin-x.jar。拷贝这两个jar包到webapp中对应war包的WEB-INF/lib目录下。

javamelody.jar：https://github.com/javamelody/javamelody/releases

jrobin-x.jar：https://github.com/javamelody/javamelody/releases/download/javamelody-core-1.49.0/jrobin-1.5.9.jar

请注意，javamelody.war文件在此处未安装使用。在大多数情况下不需要javamelody.war文件。

将位于所提供的javamelody.zip文件根目录下的文件javamelody.jar和jrobin-x.jar复制到要监视的web应用程序war的WEB-INF/lib目录中。

或者如果使用Maven，请在webapp的pom.xml文件中添加javamelody-core依赖项。点击查看依赖项

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

第二步：web.xml文件

如果您的应用程序服务器与Servlet API 3.0（如tomcat 7，glassfish v3或jboss 6）兼容，通常这一段不需要，您可以跳过它并启动服务器。

如果你没有在web.xml中使用 version="3.0"，在您的servlet描述之前，就需要在webapp的war的文件WEB-INF/web.xml中添加以下代码行。

<filter>
    <filter-name>javamelody</filter-name>
    <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
    <async-supported>true</async-supported>
</filter>
<filter-mapping>
    <filter-name>javamelody</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>ASYNC</dispatcher>
</filter-mapping>
<listener>
    <listener-class>net.bull.javamelody.SessionListener</listener-class>
</listener>

<async-supported>true</async-supported> 和<dispatcher>ASYNC</dispatcher> 是用来至此Servlet API 3.0的异步请求。

3、生成PDF报告

如果需要要生成PDF报告以及html报告，则必须添加库iText v2.1.7.jar（许可证MPL或LGPL，iText jar文件单独是足够的，没有像iText-rtf的其他依赖项）。

将提供的javamelody.zip文件的 src/test/test-webapp/WEB-INF/lib/ 目录下的文件 itext-2.1.7.jar 复制到 war-lib/webapp 监视。或者如果您使用Maven，请在webapp的pom.xml文件中添加itext依赖关系。 PDF链接将显示在HTML报告的顶部。

4、在web.xml中的补充

web.xml 文件中的url-pattern 可以适应为了不监视一些网址，可能在同一个过滤器的几个映射。

例如，使用以下 filter-mappings 和 url-patterns 仅监视 /servlet1/* 和 /servlet2/*，但不监视其他类似 /static/*的URL：

<filter>
    <filter-name>javamelody</filter-name>
    <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>javamelody</filter-name>
    <url-pattern>/servlet1/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>javamelody</filter-name>
    <url-pattern>/servlet2/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>javamelody</filter-name>
    <url-pattern>/monitoring</url-pattern>
</filter-mapping>
<listener>
    <listener-class>net.bull.javamelody.SessionListener</listener-class>
</listener>

注意，url模式必须“包含”url /monitoring 才能有报告。

或者，您可以使用单个/* url-pattern 和过滤器参数与正则表达式之前可以添加 </filter> ，以排除一些网址，例如：

<filter>
    <filter-name>javamelody</filter-name>
    <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>

    <init-param>
        <param-name>url-exclude-pattern</param-name>
        <param-value>/static/.*</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>javamelody</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<listener>
    <listener-class>net.bull.javamelody.SessionListener</listener-class>
</listener>

5、可选参数

可以配置一些设置。这些参数可以按优先级的升序来定义：

在过滤器的初始化参数（webapp中的web.xml文件）中，例如：

<filter>
    <filter-name>javamelody</filter-name>
    <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
    <init-param>
        <param-name>log</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
...

在webapp的上下文参数中使用前缀javamelody。在webapp中的web.xml文件中，例如：

<context-param>
    <param-name>javamelody.log</param-name>
    <param-value>true</param-value>
</context-param>
...

或者在tomcat conf的上下文xml文件或Glassfish中，例如：

<?xml version="1.0" encoding="UTF-8" ?>
<Context docBase="path_to/mywebapp.war" path="mywebapp" reloadable="false" >
    <Parameter name='javamelody.log' value='true' override='false'/>
</Context>

在带有前缀javamelody的系统属性中。（服务器的java启动命令或管理用户界面，如果是tomcat，则为$CATALINA_HOME/conf/catalina.properties），例如：

... -Djavamelody.log=true

.....

...

查看监控结果

现在就可以启动应用服务器打开网址查看监控效果了。网址：http://<host>/<context>/monitoring

<host>是web应用服务器的部署IP，通常是localhost:8080 或者127.0.0.1:8080具体看你自己的应用服务器
<context>是你的web应用的名字。

注意：

如果在启动过程中出错，出错信息关于window server（特别是如果使用Mac OS X服务器），并添加系统属性 -Djava.awt.headless = true（在java启动命令或服务器的管理用户界面中；如果使用到额是tomcat，那么在 conf/catalina.properties 中添加 java.awt.headless=true，然后重启服务器。

完整的简单配置图解，请看 JavaMelody应用监控使用指南（二）