内容

Size: px

Start display at page:

Download "内容"

例晶吕
5 years ago
Views:

1 听云 Java 探针功能说明手册 Version:2.1.1 BuildDate:

2 Java 探针 1 简介采集数据项兼容性及系统要求 2 安装 2.1 下载探针文件 2.2 自动安装 2.3 手动安装在 ColdFusion 上安装 Java 探针在 Glassfish 上安装 Java 探针在 Grails 上安装 Java 探针在 JBoss 上安装 Java 探针在 Play 上安装 Java 探针在 Resin 上安装 Java 探针在 Tomcat 上安装 Java 探针听云 Java 探针功能说明手册 Version:2.1.1 BuildDate: 在 WebLogic 上安装 Java 探针在 WebSphere 上安装 Java 探针在 WildFlay 上安装 Java 探针 2.4 无容器安装 2.5 升级 3 配置应用自动命名听云 Browser SSL 证书 4 卸载 5 自定义监控通过 XML 文件自定义监控通过报表自定义监控 6 问题排查没有数据版权

3 听云 Java 探针采集的数据项 : Application request controller and dispatch activity Database Operator External web services calls View resolve Uncaught Exceptions and counts Process Memory and CPU usage 通过对特定方法嵌码, 采集这些数据 : 每个方法的响应时间以及响应时间统计分析 ( 最大值最小值平均值以及标准差 ) 在报表系统里, 你可以看到这些类和方法的相应时间和调用次数除此之外, 还可以采集线程堆栈数据库执行计划自定义参数 HTTP request parameters 等数据传输 Java 探针默认启用 SSL 方式传输数据可以在 Java Agent 的配置文件 (tingyun.properties) 里启用或者禁用使用 HTTPS Java Agent 通讯使用 2 个 host: redirect.networkbench.com dc*.networkbench.com * 可能为任意的数字这个数字可能不是一成不变的, 启动探针时, 您可以通过 logs/tingyun_agent.log 文件查看如果您有防火墙, 需要将以下 IP 和端口添加到许可列表 : IP 端口 TCP 80 TCP 443

4 兼容性和要求安装 Java 探针之前, 请确保您的系统满足如下这些条件要求 JVM Oracle Hotspot JVM for Linux, Solaris, Windows, OSX 6-8 Apple Hotspot JVM for OSX 6 IBM JVM for Linux 6-7 Application servers ColdFusion 10 Glassfish JBoss x JBoss EAP 6.x Jetty Netty Resin Tomcat TomEE 1.5 WebLogic WebSphere WildFly 8 Frameworks Grails x JSF (Java Server Faces) Play Play x Spring 3.x - 4.x Struts 2 JDBC drivers 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 bin Oracle ojdbc14, ojdbc5, ojdbc6 Postgres postgressql jdbc3, 9.0, 9.1 SQLServer sqljdbc4 Generic support for other JDBC drivers NoSQLs Memcached MongoDB Jedis RPC Services Dubbo Consumer Thrift Client XmlRpc Client Apache Axis Apache CXF Spring WS Java JAX-WS Java JAX-RS (REST) Jersey 2.0+ (REST) Resteasy 2.2+ (REST) Others HttpClient java.net (HttpURLConnection) JMS 1.1 and Spring-JMS

5 JMX JSP - Java Server Pages Quartz Job Scheduler x Scala async tracking Solr

下载 Java 探针 1. 登录到 http://report.tingyun.com/ 2. 选择 Server 产品, 点击新建应用 3. 选择 Java 语言, 点击下载 Java 探针在 tingyun-

6 下载 Java 探针 1. 登录到 2. 选择 Server 产品, 点击新建应用 3. 选择 Java 语言, 点击下载 Java 探针在 tingyun-agent-java.zip 文件中包含一下 2 个文件, 以及其他的文件 : 1. tingyun-agent-java.jar: 探针类文件 2. tingyun.properties: 配置文件, 包括你的 license key 应用名称等在 Application Server 启动的时候, 探针会在 tingyun-agent-java.jar 的同级目录查找 tingyun.properties 文件 ; 探针会在 tingyunagent-java.jar 所在目录中的子目录 logs 中记录探针运行日志 ( 请确保改目录有写权限 )

7 自动安装 ( 支持 GlassFish,Jetty, JBoss 和 Tomcat) 1.1.Linux or Mac OS 1) 解压缩 tingyun-agent-java- ${version}.zip 到应用服务器的根目录 GlassFish 需要解压到使用的 domain 目录, 如.../domains/domain1/: unzip tingyun-agent-java-${version}.zip -d /path/to/appserver/ 2) 在 tingyun 目录下执行自动安装程序 : cd /path/to/appserver/tingyun java -jar tingyun-agent-java.jar install 3) 启动或重新启动你的应用服务器 4) 登录到查看你的应用性能 1.2. 参数说明 install 命令会查找启动脚本文件, 先备份, 然后修改脚本文件, 资 java 的启动脚本里增加 -javaagent 参数 install 命令参数说明 : 参数描述 -h 显示命令帮助 -l licensekey 指定 license key -s /path/to/appserver 指定应用服务的路径如果没有将 tingyun-agent-java.zip 解压到应用服务器的根目录, 需要通过该参数指定 install 命令执行结果 : 1) 执行成功后, 会提示您重启应用服务器, 访问您的应用, 登陆到报表系统查看数据 ; 2) 执行失败后, 会提示您失败原因

8 手动安装 1) 解压缩安装文件包到你的应用服务器的根目录 ( 推荐 ) 或指定目录 2) 备份 tingyun 目录下 tingyun.properties 文件 3) 在应用服务器的启动脚本中增加 : -javaagent:/path/to/tingyun/tingyun-agent-java.jar 4) 启动或重新启动你的应用服务器, 详细安装文档请查看下章节中不同应用服务器安装说明 5) 登录到查看你的应用性能不同 Application Server 安装说明 App Server ColdFusion Notes ColdFusion installation. Geronimo 使用 geronimo run 启动时, 将 tingyun-agent-java.jar 添加到 JAVA_OPTS 变量里 : export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyun-agent-java.jar" && geronimo run Glassfish Grails JBoss Glassfish installation. Grails installation. JBoss installation. Jetty 在 jetty.sh 里配置 JAVA_OPTIONS : export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/full/path/to/tingyun-agent-java.jar" Play 1.x Play 2.x Resin Play installation. Play 2 installation. Resin installation. Solr 单独运行 Solor, 在 start.jar 之前添加 -javaagent : java -javaagent:/full/path/to/tingyun-agent-java.jar -jar start.jar 在应用服务器里运行 Solr, 在应用服务器的启动脚本里增加 -javaagent, 并要确保该应用服务器开启 JMX Tomcat 修改 catalina.sh/catalina.bat, 配置 JAVA_OPTS : export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyun-agent-java.jar" 如果 tomcat 作为 windows 的服务, 请见 Tomcat installation. 如果使用 Apache Commons Daemon (jsvc) 启动 Tomcat, 详见 The Apache Commons Daemon (jsvc). WebLogic WebLogic installation. WebSphere WebSphere installation. 对于 WebSphere Community Edition, 启动是增加 JAVA_OPTS 配置来启动 : export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyun-agent-java.jar" && startup WildFly 其他应用服务器 WildFly installation. Java 探针可以运行在任何应用服务器上, 只要在启动大参数中配置 -javaagent:/path/to/tingyun-agent-java.jar 注 : 所有配置 -javaagent 的地方请使用完整路径

9 ColdFusion installation for Java 在 ColdFusion 上安装 Java 探针注意 : 探针暂时不支持 ColdFusion Version 9 on IIS 1 访问 ColdFusion Administrator Console; 2 从左侧菜单依次选择 : SERVER SETTINGS -> Java and JVM; 3 在 JVM Arguments 输入框里, 配置 -javaagent 参数 ; -javaagent:/path/to/tingyun-agent-java.jar 5 点击 Submit Changes; 6 重启 ColdFusion

Glassfish installation for Java 在 Glassfish 上安装 Java 探针 1 访问 Glassfish 配置界面 ; 2 从左侧菜单依次选择 : Configurations -> server-config -> JVM Settings -> JVM Options; 3 在 JVM Options 页面, 选择 Add JVM Option; 4

10 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)

11 Grails installation for Java 使用 run-app 启动 Grails 使用 run-war 启动 Grails 使用 run-app 启动 Grails 当使用 grails run-app 启动服务时, 需要在 run-app 之前增加 -javaagent 参数 : grails -noreloading -javaagent:/path/to/tingyun-agent-java.jar run-app Note: -noreloading 参数只在 Grails 2.x 版本需要使用 run-war 启动 Grails 修改 {your-grails-app}/conf/buildconfig.groovy 文件, 在 grails.tomcat.jvmargs 属性里添加 -javaagent 参数 : grails.tomcat.jvmargs = ["-javaagent:/path/to/tingyun-agent-java.jar"]

12 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 Final and Alpha1 不允许在 domain.xml 中配置 jvm-options 如果你使用的是存在这个 bug 的 JBoss, 请升级 JBoss 应用服务器 Standalone mode 警告 : 请确认 -javaagent 指定路径是 tingyun-agent-java.jar 的完整路径平台用法 Unix / Mac OS 使用 6.x EAP 或 7.0.x AS 及更高版本在 bin/standalone.conf 文件的底部, 添加 : JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/tingyun-agent-java.jar" Windows 使用 6.x EAP 或 7.0.x AS 及更高版本在 bin/standalone.bat 文件的该行之前 : set JBOSS_ENDORSED_DIRS=%JBOSS_HOME%\lib\endorsed 添加 : set "JAVA_OPTS=-javaagent:C:/path/to/tingyun-agent-java.jar %JAVA_OPTS%" 使用斜线 : C:/newlens/tingyun-agent-java.jar. Unix / Mac OS 使用 6.x 及更低版本在 bin/run.conf 文件的底部, 添加 : JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyun-agent-java.jar" Windows 使用 6.x 及更低版本在 bin/run.bat 文件中该行之前 : set JBOSS_CLASSPATH=%RUN_CLASSPATH% 添加 : set "JAVA_OPTS=-javaagent:C:/path/to/tingyun-agent-java.jar %JAVA_OPTS%" 使用斜线 : C:/newlens/tingyun-agent-java.jar.

13 Play installation Play 2.3.x Play 2.2.x production mode Play 2 production mode Play 2 development mode Play 1 Play 2.3.x 进入项目目录./activator -J-javaagent:/path/to/tingyun/tingyun-agent-java.jar run Play 2.2+ production mode 注意 :2.2+ 之后 play start 不允许使用 -javaagent 参数解压包含 start 脚本的 zip 文件 : play clean dist && unzip target/universal/*.zip 在启动应用时增加 -J-javaagent 参数 : cd UNZIPPEDFOLDER;./bin/SCRIPTNAME -J-javaagent:/path/to/tingyun-agent-java.jar Play 2 production mode Note: 该版本的 Play 使用 play start 命名启动服务时, 不支持 -javaagent 参数解压包含 start 脚本的 zip 文件 : play clean dist && unzip dist/*.zip 在启动应用时增加 -javaagent 参数 : cd UNZIPPEDFOLDER; chmod a+x start;./start -javaagent:/path/to/tingyun-agent-java.jar Play 2 development mode 在 play 的安装目录修改 framework/build 文件 ( 或者修改 windows 环境下的 build.bat 文件 ) nano `which play`/../framework/build 在 java exec 调用之前配置 JAVA_OPTS, 增加 -javaagent 参数 :

14 JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/newlens/tingyun-agent-java.jar" 如果在调用 java exec 这行不存在 ${JAVA_OPTS}, 将 ${JAVA_OPTS} 添加进去 dev 模式启动 ( 切勿使用 play start ): play run Play 1 installation 在运行应用的时候增加 -javaagent 参数 : play run helloworld -javaagent:/path/to/tingyun-agent-java.jar

15 Resin installation Resin pro 3.1+ production mode Resin pro 4.0+ production mode Resin pro 3.1+ production mode 找到 conf 目录下的 resin.conf 文件, 增加 <jvm-arg>-javaagent:/path/to/tingyun-agent-java.jar</jvm-arg>, 详情如下 : 针对集群所有 server 增加探针 : <cluster id="cluster_id">... <server-default>... <jvm-arg> -javaagent:/path/to/tingyun-agent-java.jar</jvm-arg>... </server-default>... </cluster> 针对集群某台 server 增加探针 : <cluster id="cluster_id">... <server id="" address="xxx.xxx.xxx.xxx" port="xxxx">... <jvm-arg> -javaagent:/path/to/tingyun-agent-java.jar</jvm-arg>... </server>... </cluster> Resin pro 4.0+ production mode Resin pro 4.0+ 有两种安装方式第一种 : 找到 conf 目录下的 resin.properties 文件, 将 jvm 的配置打开, 并增加 -javaagent:/path/to/tingyunagent-java.jar, 详情如下 : # Arg passed directly to the JVM jvm_args : -javaagent:/path/to/tingyun-agent-java.jar # jvm_mode : -server 第二种 : 增加 <jvm-arg>-javaagent:/path/to/tingyun-agent-java.jar</jvm-arg>, 详情如下 : 针对集群所有 server 增加探针 :

16 <cluster id="cluster_id">... <server-default>... <jvm-arg> -javaagent:/path/to/tingyun-agent-java.jar</jvm-arg>... </server-default>... </cluster> 针对集群某台 server 增加探针 : <cluster id="cluster_id">... <server id="" address="xxx.xxx.xxx.xxx" port="xxxx">... <jvm-arg> -javaagent:/path/to/tingyun-agent-java.jar</jvm-arg>... </server>... </cluster>

17 Tomcat installation 目录 : 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 参数

18 在 WebLogic 上安装 Java 探针目录 : 在 Linux 和 Mac OS 下的安装在 Windows 下的安装管理控制台安装安全性 (Java 2 Security) 配置在 Linux 和 Mac 下的安装在 Linux 和 Mac 操作系统下安装听云 Java 探针的步骤 : 1 在 domain 的 bin 目录下找到 startweblogic.sh 文件 : WEBLOGIC_HOME/user_projects/domains/ domain_name/bin/startweblogic.sh 2 修改文件, 在 # START WEBLOGIC 和 echo "starting weblogic with Java version:" 之间增加探针配置 :... # START WEBLOGIC export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/path/to/tingyun/ tingyun-agent-java.jar" echo "starting weblogic with Java version:"... 重启 weblogic 在 Windows 下的安装在 Windows 操作系统下安装听云 Java 探针的步骤 : 1 在 domain 的 bin 目录下找到 startweblogic.bat 文件 : WEBLOGIC_HOME/user_projects/domains/ domain_name/bin/startweblogic.bat 2 修改文件, 在 # START WEBLOGIC 和 echo "starting weblogic with Java version:" 之间增加探针配置 :... # START WEBLOGIC set JAVA_OPTIONS="%JAVA_OPTIONS% -javaagent: C:\path\to\tingyun\ tingyun-agent-java.jar" echo "starting weblogic with Java version:"... 重启 weblogic

19 管理控制台安装当使用 Node Manager 来启动和停止被管理的服务器时, 采用以下的步骤来安装 Java 探针 : 从管理控制台中, 浏览 :Environments > Servers > (select your server) > Server Start > Arguments; 2 在 Arguments 选项的文本框中增加以下内容 : -javaagent:"/path/to/tingyun-agent-java.jar" TODO: 截图

20 在 WebSphere 上安装 Java 探针在 WebSphere 上安装 Java 探针目录 : 兼容性兼容性在 WebSphere 上安装 Java 探针安全性 (Java 2 Security) 配置听云 Java 探针支持 WebSphere 7.0 到的所有版本, 除了有部分的版本与该探针不兼容在 WebSphere 上安装 Java 探针 1. 修改 server.xml 文件 ( 不推荐 ), 文件路径大致为 : WAS_HOME/AppServer/profiles/ app_server_name/config/cells/ cell_name/nodes/ node_name/servers/ server_name /server.xml >... <jvmentries... genericjvmarguments="-javaagent: /path/to/tingyun/ tingyun-agent-java.jar"... </jvmentries> 2. 通过管理控制台配置探针 ( 推荐 ): 1 登录管理控制台 : 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/ tingyun-agent-java.jar" 6 点击 Apply 按钮, 然后点击 Save 按钮 ; 7 重启服务提示 : 如果启用了 Java 安全性 (Java 2 Security), 需要授权 Tingyun Agent 通过 JMX 获取 PMI 指标参考以下步骤 :

安全性 (Java 2 Security) 配置如果您使用的是 Java 2 Security 或 WebSphere 管理安全性, 需要授予 tingyun 目录下所有 jar 文件的执行权限可以通过修改 java.policy 文件启用授予全局安全性, 也可以修改某个 Server 的 server.

22 安全性 (Java 2 Security) 配置如果您使用的是 Java 2 Security 或 WebSphere 管理安全性, 需要授予 tingyun 目录下所有 jar 文件的执行权限可以通过修改 java.policy 文件启用授予全局安全性, 也可以修改某个 Server 的 server.policy 文件只授权单个 Server 的权限 : 授权所有 Server 修改 java.policy 文件, 文件路径大概为 : WAS_HOME/java/jre/lib/security/java.policy 将如下内容添加到 java.policy 中, file: 后面的路径必须指定到 tingyun-agent-java.jar 的目录, 并确保最后存在 - grant codebase "file:/path/to/tingyun/-" { permission java.security.allpermission; permission java.net.socketpermission "*.networkbench.com", "connect,accept,resolve"; permission java.lang.runtimepermission "createclassloader"; permission java.lang.runtimepermission "getclassloader"; }; 重启应用 WebSphere 授权单个 Server 修改 server.policy 文件, 文件路径大概为 : WAS_HOME/AppServer/profiles/ APP_SERVER_NAME/properties/server.policy 将如下内容添加到 java.policy 中, file: 后面的路径必须指定到 tingyun-agent-java.jar 的目录, 并确保最后存在 - grant codebase "file:/path/to/tingyun/-" { permission java.security.allpermission; permission java.net.socketpermission "*.networkbench.com", "connect,accept,resolve"; permission java.lang.runtimepermission "createclassloader"; permission java.lang.runtimepermission "getclassloader"; };

23 重启应用 WebSphere 提示 : 每个 Server 最终的安全性都取决于 java.policy 和 server.policy 的并集, 切勿在多个文件配置同样的授权 policy 文件的配置格式及语法可参考 Default Policy Implementation and Policy File Syntax

24 WildFlay installation for Java Domain mode Standalone mode Domain mode 修改 domain/configuration/domain.xml 里的 <jvm-options /> 增加 <option />: <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> 如果你在 Windows 使用, 路径使用的是斜杠 '/' 例如 : d:/tingyun/tingyun-agent-java.jar Standalone mode 操作系统描述 Unix / Mac OS 在 bin/standalone.conf 文件的底部, 添加 : JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/tingyun-agent-java.jar" Windows 查找 bin/standalone.bat 文件中得如下内容 : rem Setup JBoss specific properties 在改行之后添加 set "JAVA_OPTS=-javaagent:C:/tingyun/tingyun-agent-java.jar %JAVA_OPTS%"

25 无容器安装 java -javaagent:/path/to/tingyun/tingyun-agent-java.jar -jar xxx.jar 注 :-javaagent 一定要放置在 -jar 之前

26 升级探针登陆到下载最新的探针使用 zip 文件里的 tingyun-agent-java.jar 替换当前使用的文件重启 Application Server

27 应用自动命名 Java Agent 通过应用名称归类应用性能数据在单一的 JVM 实例上,Java Agent 将所有性能数据 (Web 应用过程数据库 NoSQL 错误 JVM 后台任务等 ) 汇总到 tingyun.properties 文件中通过 nbs.app_name 指定的应用名称上修改 tingyun.properties 文件里 nbs.auto_app_naming 为 true 后, 应用将根据其 context, filter, servlet, 或者 request attribute 自动命名为不同的名称自动命名适用于单个 JVM 上运行多个应用,Java Agent 会将 Web 应用过程数据库 NoSQL 错误 JVM 数据上传到不同的应用但是后台任务依然会被上传到 tingyun.properties 文件配置的应用名称上. 备注 : 所有配置改动都需要重启 JVM 才能生效目录应用命名规则 Request attribute Servlet init parameter Filter init parameter Context parameter Display name Context path 应用命名规则当设置 nbs.auto_app_naming=true 时,Java Agent 使用如下规则命名应用 : 数据后台任务 Web 应用过程命名规则配置在 tingyun.properties 里的默认名称优先级 : Request attribute ( 高优先级 ) Servlet init parameter Filter init parameter Web app context parameter Web app context name (display-name) Web app context path ( 低优先级 ) Request attribute Request attribute APPLICATION_NAME 的优先级最高, 请尽早的再 Web 应用过程中设置改属性, 如果多次调用, 最后一次设置会覆盖之前的设置备注 : 只有设置在 ServletRequests 上 APPLICATION_NAME 才会生效根据 request URI 设置应用名称 : protected void service(httpservletrequest request, HttpServletResponse response) throws ServletExcept ion, IOException {... String requesturi = httpservletrequest.getrequesturi(); if (requesturi.startswith("/your-owner-uri/")) { request.setattribute("com.tingyun.agent.application_name", "CustomApplicationName"); }

28 ... Servlet init parameter 配置 web.xml 中得 init parameters 实现对应用的命名 : <servlet> <servlet-name>payservlet</servlet-name> <servlet-class>com.example.payservlet</servlet-class> <init-param> <param-name>com.tingyun.agent.application_name</param-name> <param-value>onlinepay</param-value> </init-param> </servlet> Java Agent 通过调用如下方法来获取 init-param 内容 javax.servlet.servletconfig#getinitparameter(string) 参数为 com.tingyun.agent.application_name. 如果有多个 Servlet, 第一个 servlet 的 init-param 生效. 如果没有指定 init-param 使用默认的应用名称 Filter init parameter 如果没有使用 Servlet, 通过 Filter 的 init parameter 命名应用 : <filter> <filter-name>productfilter</filter-name> <filter-class>com.sample.productfilter</filter-class> <init-param> <param-name>com.tingyun.agent.application_name</param-name> <param-value>productapplication</param-value> </init-param> </filter> Java Agent 通过向 javax.servlet.filterconfig#getinitparameter(string) 传递 com.tingyun.agent.application_name 参数获取 init-param 内容如果有多个 filter, 第一个 filter 的 init-param 生效 Context parameter 使用 context param 命名应用 : <context-param> <param-name>com.tingyun.agent.application_name</param-name> <param-value>mywebapp</param-value> </context-param> Java Agent 通过向 javax.servlet.servletcontext#getinitparameter(string) 传递 com.tingyun.agent.application_name 参数获取 context-param 内容

29 Display name 配置 web.xml 文件的 display-name 元素命名应用 : <display-name>myapplicationname</display-name> Java 探针通过调用 javax.servlet.servletcontext#getservletcontextname() 获取 display-name 内容 Context path 如果没有配置 display-name, 其他一些高优先级的属性也没有设置,Java Agent 通过调用 javax.servlet.servletcontext#getcontextpath() 获得 context path, 来命名应用过程 Context path 一般作 request URI 的一部分, 且在最前面例如 : 如果一个 url 类似这样 : Request URI 是 /tingyun-agent/testhttpclient. Context path 是 /tingyun-agent. Application 会被命名为 tingyun-agent.

30 听云 Browser Java Agent 通过对 Web 页面嵌入 js 代码监测页面性能数据应用 Java Agent 实现页面监测功能, 需要 : 1 确认升级 java agent 到最新版本 (1.3.0 或者更高版本 ); 2 将 tingyun-agent-api.jar 添加到 web 应用的 classpath 中 ; 备注 :tingyun-agent-api.jar 的 Maven 坐标 : <dependency> <groupid>com.tingyun</groupid> <artifactid>tingyun-agent-api</artifactid> <version>1.0.0</version> </dependency> 目录自动页面嵌码手动页面嵌码自动页面嵌码 Java Agent 对 tomcat(5-8),glassfish(3-4),jetty(7-9) 支持自动页面嵌码登陆听云 Browser: 新建支持自动页面嵌码的应用 jsp 页面必须存在 head 标签, 探针将会在 head 标签中嵌入监测页面加载时间的 js 代码, 如 : <%@ page contenttype="text/html;charset=utf-8" language="java" %> <html> <head> tinyun script code...</head> <body>...</body> </html> 手动页面嵌码 Java Agent 对非 tomcat glassfish jetty 容器, 支持采取 tingyun api 的方式进行页面嵌码在页面中添加类似代码 com.tingyun.api.agent.tingyun.getrumheader() ; 详情如下 : JSP 页面的手动嵌码 : <%@ page contenttype="text/html;charset=utf-8" language="java" %> <html> <head> <%=com.tingyun.api.agent.tingyun.getrumheader()%> </head> <body>...</body> </html> Servlet 等生成 html 方式 : response.setcontenttype("text/html;charset=utf-8");

31 ... PrintWriter out = response.getwriter(); out.write(com.tingyun.api.agent.tingyun.getrumheader());... Velocity 等模板引擎方式 : 后端代码 :... VelocityEngine velocityengine = new VelocityEngine(properties); VelocityContext context=new VelocityContext(); context.put("tingyunrumcode",com.tingyun.api.agent.tingyun.getrumheader());... *.vm 中 : <html> <head>... $tingyunrumcode... </head> <body>...</body> </html> JSF 的支持 :... <head> <%=com.tingyun.api.agent.tingyun.getrumheader()%> </head>...

32 配置 SSL 证书备份默认证书 cp $JAVA_HOME/jre/lib/security/cacerts $JAVA_HOME/jre/lib/security/cacerts_bak 下载听云证书 cd /opt/tingyun;wget 合并证书 keytool -import -alias networkbench -keystore $JAVA_HOME/jre/lib/security/cacerts -file networkbench.cer 默认密码 :changeit 重启 Application Server

33 卸载探针 1) 将备份的启动脚本回退到原来的名称 2) 删除 tingyun 目录 3) 重启应用服务器

34 通过 XML 文件自定义监控通过 XML 文件, 可以在不修改代码的前提下监控指定方法的性能 XML 文件需要指定具体的类和方法的描述在探针启动的时候加载定义的 XML, 实现对特定类的方法的嵌码目录文件结构文件结构验证文件正确性文件路径验证文件是否被加载多个文件 extension.xsd xml schema sample.xml 示例 sample.xml 说明请参考文件说明或者 xml 自定义监控示例验证 2 种方式 : 文件路径使用浏览器打开使用一些在线的 xml 文件验证器 Java Ageng 在启动的时候读取和解析 xml 文件有两种方式可以指定 xml 文件路径 : 文件路径步骤创建 extensions 目录 1. 在 tingyun-agent-java.jar 同级目录创建 extensions 目录 ; 2. 拷贝 sample.xml 到 extensions 目录 ; 3. 确认在 tingyun.properties 文件里没有设置 nbs.extensions.dir 通过 tingyun.properties 指定已经存在的目录 1. 修改 tingyun.properties 文件, 配置 nbs.extensions.dir 属性, 指定到 xml 文件路径 ; 2. 确认指定的目录存在扩展名为.xml 的文件存在验证文件是否被加载为了验证文件是否被加载, 首先需要设置 tingyun.properties 文件的 nbs.agent_log_level=debug 1. 编辑 tingyun.properties 修改日志级别属性 nbs.agent_log_level=debug 2. 启动或者重启 Application Server 如果读取成功, logs/tingyun_agent.log 会打印类似如下内容 : Reading custom extension file /opt/tingyun/extensions/sample.xml

35 如果没有出现类似内容, 可能是文件找不到, 或者是 xml 文件检验失败, 请检查文件路径以及文件合法性多个文件如果存在多个 xml 文件如果两个文件的 extensionname 相同, version 数值大的生效, 数值小的会被忽略如果两个文件的 extensionname 相同, version 也相同, 则第一个被加载的文件会生效, 其他文件不会生效

通过报表端自定义监控通过在报表端配置, 可以在不修改代码, 不重启容器的前提下增加监控指定方法的性能报表端配置 : 1. 登录到 http://report.tingyun.com/ 2. 选择 Server 产品, 点击设置 -> 自定义规则配置 -> 添加 3.

instrumentclass), 监控填写的指定的 Class 类 ; 监控类型选择 Interface 时, 方框处填写 Interface 全路径名, 监控指定 Interface 的所有实现类 ; 当监控类型为 BaseClass 时, 方框处填写 BaseClass 全路径名, 监控指定的 BaseClass 类及其实现类 ; 监控方法类型相关监控方法匹配类型选择 Name 时,

36 通过报表端自定义监控通过在报表端配置, 可以在不修改代码, 不重启容器的前提下增加监控指定方法的性能报表端配置 : 1. 登录到 2. 选择 Server 产品, 点击设置 -> 自定义规则配置 -> 添加 3. 设置需要监控的类型和方法信息, 点击提交 [ 鼠标停留在问号出 3s 有详细的说明 ] 报表端配置元素说明监控类型和监控方法类型必须均填写, 方可起作用监控类类型相关监控类型选择 Class 时, 方框处填写 Class 全路径名 (com.tingyun.custom.instrumentclass), 监控填写的指定的 Class 类 ; 监控类型选择 Interface 时, 方框处填写 Interface 全路径名, 监控指定 Interface 的所有实现类 ; 当监控类型为 BaseClass 时, 方框处填写 BaseClass 全路径名, 监控指定的 BaseClass 类及其实现类 ; 监控方法类型相关监控方法匹配类型选择 Name 时, 方框处填写监控方法名, 此时需填写方法参数 : 填写监控方法的参数全名, 参数的顺序必须和方法的参数顺序一致, 以英文逗号 (,) 分隔 [ 注 : 基础类型可直接填写, 如 int 则直接填写 int 即可 ] 如果需要监控指定方法名的的所有方法 ( 无论是否有参数 ), 此处不需填写如果指定监控的方法没有参数, 此处需要填写为 [] 即可当监控方法类型选择 ReturnType 时, 方框处填写返回类型的全路径名,void 返回值请选择按方法名进行自定义监控 ; 此时对所有返回该 ReturnType 的方法均添加监控当监控方法类型选择 Annotation 时, 方框处填写指定的 Annotation 全路径名, 此时对所有添加该 Annotation 的方法均添加监控

37 问题描述在报表里看不到数据解决思路正常情况下, 当你的应用有 request 后, 约 5 分钟左右, 数据既可以在报表中心查看如果没有数据, 请按照以下步骤查找问题 : 1. 是否已经安装探针, 如果没有安装, 请参考第 2 节安装 2. 安装完探针是否重启了应用服务器, 如果没有重启, 请重启 3. 确保 tingyun-agent-java.jar 和 tingyun.properties 在同一级目录 4. 执行 ps -ef grep tingyun 是否有内容, 如果没有内容, 请检查步 5. 在 tingyun 目录是否存在 logs/tingyun_agent.log 文件, 如果不存在请检查将日志级别改为 debug, 检查 tingyun_agent.log 文件内容, 看是否有报错, 如果有报错, 根据错误提示做相应修改 7. 确定你的应用是否被禁用或者删除, 如果出现如下日志, 请检查应用配置, 或联系我们的技术支持 TingYun Agent disabled for: Java Application 8. 验证你的应用数据是否上传到正确的应用名称上, 在 tingyun_agent.log 文件里会出现以下信息 : Agent @cib01122/Java Application connected to dc1.networkbench.com 如果你将数据上传到多个应用上, 则以上信息会出现多条如果显示的不是正确的引用, 请检查是否开启应用自动命名, 如果开启自动命名请确保在 tingyun.properties 中配置 nbs.app_name 和 web.xml 的 display-name 相同

38 版权申明本文档版权归北京基调网络股份有限公司所有未经书面许可, 任何人不得复制传播北京基调网络股份有限公司总部地址 : 北京市朝阳区京顺路 5 号曙光大厦 C 座 207 室邮编 : 联系电话 :

Java 探针 1 简介兼容性及系统要求常见问题 2 安装 2.1 下载探针文件 2.2 安装 Java 探针 2.3 不同 Web 容器安装说明在 Glassfish 上安装 Java 探针在 JBoss 上安装 Java 探针在 Play 上安装 Jav

基调网络听云 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 探针基调网络听云