基调网络听云 Java 探针说明
Java 探针 1 简介兼容性及系统要求常见问题 2 安装 2.1 下载探针文件 2.2 安装 Java 探针 2.3 不同 Web 容器安装说明 2.3.1 在 Glassfish 上安装 Java 探针 2.3.2 在 JBoss 上安装 Java 探针 2.3.3 在 Play 上安装 Java 探针 2.3.4 在 Tomcat 上安装 Java 探针 基调网络听云 Java 探针说明 2.3.5 在 WebLogic 上安装 Java 探针 2.3.6 在 WebSphere 上安装 Java 探针 版权
Java 兼容性及系统要求 1 确认您的系统满足兼容性要求 2 如果您还没有听云帐户, 请注册听云帐户 3 登陆到听云 Server 4 下载 Java 探针 5 安装配置 Java 探针 6 重启 Web 应用服务器 7 通过报表页面查看数据, 有问题请参考安装和排除故障章节 兼容性和要求 安装 Java 探针之前, 请确保您的系统满足如下这些条件 要求 JVM Oracle Hotspot JVM for Linux, Solaris, Windows, OSX 6-7 Apple Hotspot JVM for OSX 6 IBM JVM for Linux 6-7 App/Web servers Glassfish 3.0-4.0 JBoss 4.0.5-7.x Jetty 6-9.1 Tomcat 5.5-8 WebLogic 10.3.3-12.1 WebSphere 7.0-8.5.5 Frameworks JSF (Java Server Faces) Play 1.2.4 Play 2.0.3-2.3.0 Spring 3.x - 4.x Struts 2 jtds open source JDBC 3.0 type 4 driver for Microsoft SQL Server (6.5 up to 2008) and Sybase ASE MySQL mysql-connector-java-5.1.13-bin
JDBC drivers Oracle ojdbc14, ojdbc5, ojdbc6 Postgres postgressql-8.4-701.jdbc3, 9.0, 9.1 SQLServer sqljdbc4 Generic support for other JDBC drivers Other Hibernate 3.x - 4.x HttpClient 3.0.1-4.3.0 java.net (HttpURLConnection) JMS 1.1 and Spring-JMS JMX JSP - Java Server Pages 2.0-2.2 Quartz Job Scheduler 1.8.3-2.2.x
1. Java 探针都能采集哪些数据? 目前, 探针可以采集 Java 运行时的性能数据和错误信息 性能数据包括 :HTTP 请求的总响应时间 前端阻塞时间 数据库耗时 NOSQL 耗时 外部服务耗时等性 能 ; 详细到数据库表的性能统计 ; 错误信息包括 : 数据库连接错误 sql 语法错误 Java 运行时未捕获的异常等 ;
下载 Java 探针 Java 探针需要 Java JDK 1.6 + 如果你没有听云帐户, 请注册听云帐户 Java 探针提供两种方式的下载 : 听云报表系统下载 Maven Repository 听云报表系统下载 1. 登录到 http://reportbeta.tingyun.com/server 2. 3. Maven Repository
1. 搜索 com.networkbench.newlens.agent.java <dependency> <groupid>com.networkbench.newlens.agent.java</groupid> <artifactid>tingyun-agent-java</artifactid> <version>1.0.0</version> </dependency> 在 tingyun-agent-java.zip 文件中包含 2 个文件 1. tingyun-agent-java.jar: 探针类文件 2. tingyun.properties: 配置文件, 包括你的 license key 应用名称等在 Web Server 启动的时候, 探针会在 tingyun-agent-java.jar 的同级目录查找 tingyun.properties 文件 ; 探针会在 tingyun-agent-java.jar 所在目录中的子目录 logs 中记录探针运行日志
安装 Java 探针 1. 自动安装 ( 支持 JBoss,GlassFish,Jetty 和 Tomcat) 1.1.Linux or Mac 1) 解压缩安装文件包到你的应用服务器的根目录 : unzip tingyun-agent-java-lastest.zip -d /path/to/appserver/ 2) 在 tingyun 目录下执行自动安装程序 : cd /path/to/appserver/tingyun java -jar tingyun-agent-java.jar install 3) 启动或重新启动你的应用服务器, 详细安装温度请查看下章节不同应用服务器安装说明 4) 登录到 http://reportbeta.tingyun.com/server 查看你的应用性能 1.2.Windows 1) 打开 tingyun-agent-java.zip 2) 拷贝 tingyun 目录到你的应用服务器的根目录 3) 在命令行窗口执行: cd tingyun java -jar tingyun-agent-java.jar install 4) 启动或重新启动你的应用服务器, 详细安装温度请查看下章节不同应用服务器安装说明 5) 登录到 http://reportbeta.tingyun.com/server 查看你的应用性能 2. 手动安装 1) 解压缩安装文件包到你的应用服务器的根目录( 推荐 ) 或指定目录 2) 备份 tingyun 目录下 tingyun.properties 文件 3) 在应用服务器的启动脚本中增加: -javaagent:/path/to/tingyun/tingyun-agent-java.jar 4) 启动或重新启动你的应用服务器, 详细安装文档请查看下章节中不同应用服务器安装说明 5) 登录到 http://reportbeta.tingyun.com/server 查看你的应用性能
不同 Web 容器安装说明 Platform Glassfish JBoss 详见 Glassfish installation. 详见 JBoss installation. Notes Jetty 启动脚本 (jetty.sh) 可以通过 JAVA_OPTIONS 配置 : Jetty export JAVA_OPTIONS="${JAVA_OPTIONS} - javaagent:/full/path/to/tingyun-agent-java.jar" -javaagent 参数需要指定到 tingyun-agent-java.jar 文件的完整路径. Play 1.x Play 2.x and higher Resin 详见 Play installation. 详见 Play 2 installation. 在 Resin 上安装 Java 探针可以通过在 resin.conf 配置文件中的 jvmargs 设置项里增加 -javaagent 参数来完成 : <jvm-arg>-javaagent:/full/path/to/tingyun-agent-java.jar</jvm-arg> 在 Tomcat 服务器上使用 Java 探针可以通过在启动脚本 (catalina.sh) 中使用 JAVA_OPTS 来指定 : export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyunagent-java.jar" Tomcat -javaagent 参数需要指定到 tingyun-agent-java.jar 文件的完整路径. 如果你需要在 Window 上的 Tomcat 服务器安装探针, 详见 Tomcat installation. 如果你使用 Apache Commons Daemon (jsvc) 启动 Tomcat, 详见 The Apache Commons Daemon (jsvc). WebLogic 详见 WebLogic installation. 详见 WebSphere installation. WebSphere 对于 WebSphere Community Edition, 通过配置 JAVA_OPTS 环境变量来启动 : export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyunagent-java.jar" && startup 其他应用服务器 Java 探针可以运行在任何应用服务器上, 只要在启动大参数中配置 - javaagent:/path/to/tingyun-agent-java.jar
版权申明 本文档版权归北京基调网络系统有限公司所有 未经书面许可, 任何人不得复制 传播 北京基调网络系统有限公司 www.networkbench.com 总部地址 : 北京市朝阳区京顺路 5 号曙光大厦 C 座 207 室邮编 :100028 联系电话 :010-84440086
Glassfish installation for Java 在 Glassfish 上安装 Java 探针 1 访问 Glassfish 配置界面 ; 2 从左侧菜单依次选择: Configurations -> server-config -> JVM Settings -> JVM Options; 3 在 JVM Options 页面, 选择 Add JVM Option; 4 添加一个条目, 配置 -javaagent 参数 ; -javaagent:/path/to/tingyun-agent-java.jar 5 保存设置 6 重启应用服务器
如果 Glassfish 不能够正常启动, 可能是 -javaagent 参数没有设置正确, 可以通过编辑 domain.xml 中正确配置 - javaagent 参数 ({GLASSFISH_HOME}/glassfish/domains/{domain}/config/domain.xml)
JBoss installation for Java 在 JBoss 上安装 Java 探针 说明 : 从 8.0 以后的版本,JBoss 更名为 WildFly 如果是正在使用 WildFly, 请参见 WildFly installation for Java 目录 : Domain mode Standalon mode Domain mode Domain mode 使用在 JBoss 6.X EAP 或 7.0.X 及以后的版本 每个服务器组的 JVM 配置信息可以在 domain/configuration/domain.xml 文件配置 <server-group name="main-server-group" profile="full"> <jvm name="default"> <jvm-options> <option value="-javaagent:/path/to/tingyun-agent-java.jar"/> </jvm-options> </jvm> </server-group> 请确认 -javaagent 指定路径是 tingyun-agent-java.jar 的完整路径 如果你在 Windows 使用, 路径使用的是斜杠 '/' 例如 : d:/newlens/tingyun-agent-java.jar 警告 :JBoss 存在一个 Bug 详见 :JBoss bug in 7.0.2.Final and 7.1.0.Alpha1 不允许在 domain.xml 中配置 jvm-options 如果你使用的是存在这个 bug 的 JBoss, 请升级 JBoss 应用服务器 Standalone mode
警告 : 请确认 -javaagent 指定路径是 tingyun-agent-java.jar 的完整路径 平台 Unix / Mac OS with 6.x EAP or 7.0.x AS and above Windows with 6.x EAP or 7.0.x AS and above 用法 在 bin/standalone.conf 文件的底部, 添加 : JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyunagent-java.jar" 在 bin/standalone.bat 文件的该行之前 : set JBOSS_ENDORSED_DIRS=%JBOSS_HOME%\lib\endorsed 添加 : set "JAVA_OPTS=-javaagent:C:/full/path/to/tingyun-agentjava.jar %JAVA_OPTS%" 使用斜线 : C:/newlens/tingyun-agent-java.jar. Unix / Mac OS with 6.x and below Windows with 6.x and below 在 bin/run.conf 文件的底部, 添加 : JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyunagent-java.jar" 在 bin/run.bat 文件中该行之前 : set JBOSS_CLASSPATH=%RUN_CLASSPATH% 添加 : set "JAVA_OPTS=-javaagent:C:/full/path/to/tingyun-agentjava.jar %JAVA_OPTS%" 使用斜线 : C:/newlens/tingyun-agent-java.jar.
目录 Play 2.2+ production mode installation Play 2 production mode installation Play 2 development mode installation Play 1 installation Play 2.2+ production mode installation 注意 : play start 不允许使用 -javaagent 参数 Begin with an unzipped distribution containing the start script: play clean dist && unzip target/universal/*.zip Append the -J-javaagent switch when starting your play application. For example: cd UNZIPPEDFOLDER;./bin/SCRIPTNAME -J-javaagent:path/to/tingyun-agent-java.jar Play 2 production mode installation Note: The play start command does not allow for the -javaagent option. Begin with an unzipped distribution containing the start script: play clean dist && unzip dist/*.zip Append the -javaagent switch when starting your play application. For example: cd UNZIPPEDFOLDER; chmod a+x start;./start -javaagent:path/to/tingyun-agent-java.jar Play 2 development mode installation In your play install modify the framework/build file (or make similar change for build.bat in windows)
nano `which play`/../framework/build Add the JAVA_OPTS command above the java exec call: JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newlens/tingyun-agent-java.jar" Add ${JAVA_OPTS} to the java exec line if one doesn't exist. Run in dev mode ( play start won't work): play run Play 1 installation Append the -javaagent switch when running your play application. For example: play run helloworld -javaagent:/full/path/to/tingyun-agent-java.jar
在 Tomcat 上安装 Java 探针 在 Tomcat 上安装 Java 探针 目录 : Tomcat for Windows Apache Commons Daemon(jsvc) Tomcat for Windows 大多数 Windows 用户都把 Tomcat 作为服务来运行 Tomcat 提供了一个配置程序来指定该服务的 JVM 参数 1 点击 Start > Apache Tomcat (Version) > Configure Tomcat; 2 选择: Java; 3 在 Java Options 文本框中的行末增加 : -javaagent:/path/to/tingyun-agent-java.jar 4 点击 Apply 按钮 ; 5 重启 Tomcat 服务设置 -javaagent 参数时, 请使用正斜杠作为路径分隔符, 例如 : -javaagent:c:/tingyun/tingyun-agent-java.jar 对于 Tomcat 6 版本, 在 -javaagent 参数之后需要有回车符 并且路径分隔符可以使用正斜杠和反斜杠 如果您使用 catalina.bat 来启动 Tomcat, 请在该批处理文件的顶部增加以下内容 : SET JAVA_OPTS=%JAVA_OPTS% -javaagent:/path/to/tingyun-agent-java.jar Apache Commons Daemon(jsvc) Tomcat 6 中自带的 Apache Commons Daemon(jsvc) 不支持 -javaagent 参数 关于该问题的描述请 见 :[daemon] JSVC does not support all the standard java 5.0 launcher options 在 Apache Commons 源代码仓库中已经包含了该问题的修复版本 参见 :
Apache 源代码仓库 Apache SVN 源代码仓库 您也可以直接下载编译好的 jsvc 版本 该版本的 jsvc 支持通过 -X 前缀来设置 -javaagent 参数
在 WebLogic 上安装 Java 探针 在 WebLogic 上安装 Java 探针 目录 : 在 Linux 和 Mac OS 下的安装 在 Windows 下的安装 管理控制台安装 在 Linux 和 Mac OS 下的安装 在 Linux 和 Mac OS 操作系统下安装听云 Java 探针的步骤 : 1 在域的 bin 目录下找到 startweblogic.sh 文件 : /path/to/appserver/userprojects/domains/base_domain/bin 2 在该文件中增加以下内容 : export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/path/to/tingyun-agent-java.jar" 在 Windows 下的安装 在 Windows 操作系统下安装听云 Java 探针的步骤 : 1 在域的 bin 目录下找到 startweblogic.bat 文件 : C:\Oracle\Middleware\userprojects\domains\base_domain\bin\ 2 在该文件中增加以下内容 : set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"c:\path\to\tingyun-agent-java.jar" 管理控制台安装 当使用 Node Manager 来启动和停止被管理的服务器时, 采用以下的步骤来安装 Java 探针 : 从管理控制台中, 浏览 :Environments > Servers > (select your server) > Server Start > Arguments;
2 在 Arguments 选项的文本框中增加以下内容 : -javaagent:"/path/to/tingyun-agent-java.jar" TODO: 截图
在 WebSphere 上安装 Java 探针 在 WebSphere 上安装 Java 探针 目录 : 兼容性 在 WebSphere 上安装 Java 探针 兼容性 听云 Java 探针支持 WebSphere 7.0 到 8.5.5 的所有版本, 除了有部分 8.5.0 的版本与该探针不兼容 在 WebSphere 上安装 Java 探针 在 WebSphere 上安装听云 Java 探针的步骤 : 1 登录管理控制台:https://ip:9043/ibm/consol 2 浏览:Servers > Application servers > ( 选择指定的 Server); 3 选择:Configuration > Service Infrastructure > Java and Process Management > Process Definition > Additional Properties; 4 在 Process Definition > Additional Properties 下, 选择 Java Virtual Machine; 5 在 Java Virtual Machine 页面中, 在 Generic JVM arguments 选项的文本框中, 增加以下内容 : -javaagent:"/path/to/tingyun-agent-java.jar" 6 点击 Apply 按钮, 然后点击 Save 按钮 ; 7 重启服务 参考以下步骤 :