pinpoint 安装部署
Posted duanxz
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了pinpoint 安装部署相关的知识,希望对你有一定的参考价值。
序章
简单的说,Pinpoint是一款对Java编写的大规模分布式系统的APM工具,有些人也喜欢称呼这类工具为调用链系统
、分布式跟踪系统
。我们知道,前端向后台发起一个查询请求,后台服务可能要调用多个服务,每个服务可能又会调用其它服务,最终将结果返回,汇总到页面上。如果某个环节发生异常,工程师很难准确定位这个问题到底是由哪个服务调用造成的,Pinpoint等相关工具的作用就是追踪每个请求的完整调用链路,收集调用链路上每个服务的性能数据,方便工程师能够快速定位问题。
同类工具
为什么要用Pinpoint
最重要的原因,对代码的零侵入,运用JavaAgent字节码增强技术,只需要加启动参数即可。
Pinpoint架构图
(图片出处:官网)架构说明:
- Pinpoint-Collector:收集各种性能数据
- Pinpoint-Agent:和自己运行的应用关联起来的探针
- Pinpoint-Web:将收集到的数据显示成WEB网页形式
- HBase Storage:收集到的数据存到HBase中
开始部署
前提条件
- maven 3.2.x+
- git
- java 6+
1. 开始
- 下载:git clone https://github.com/naver/pinpoint.git
- 进入Pinpoint目录后编译:mvn install -Dmaven.test.skip=true
- 如果不想自己手动打包,则可以在这里直接下载打包好的。下载
2. 部署Hbase
Pinpoint以Hbase作为数据的存储。
- 下载Hbase:http://apache.mirror.cdnetworks.com/hbase/
- 解压后编辑:
conf/hbase-env.sh,
添加JAVA_HOME配置:,在27行左右:
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home
- 编辑hbase-site.xml:
<configuration> <property> <name>hbase.rootdir</name> <value>file:///Users/acheron/Tmp/hbase</value> </property> <property> <name>hbase.zookeeper.property.dataDir</name> <value>/Users/acheron/Tmp/zookeeper</value> </property> <property> <name>hbase.zookeeper.property.clientPort</name> <value>2182</value> </property> </configuration>
这样配置是本地单实例模式启动,上面配置分别表示:数据存放地点、zookeeper数据存放地点、zookeeper端口号(默认2181)。当然这个文件可以不配置,那么会采取默认值。
启动hbase的时候,hbase用得是自带的zk,在hbase的配置里可见 export HBASE_MANAGES_ZK=true;
- 进入hbase/bin目录启动hbase:./start-hbase.sh
- 用
jps
命令查看Hbase是否启动成功,如果启动成功的会看到”HMaster”的进程 - 初始化pinpoint需要的表:./hbase shell hbase-create.hbase (这里的hbase-create.hbase在源码
pinpoint/hbase/scripts/hbase-create.hbase
) - 访问页面测试是否成功:http://localhost:16010/master-status ,如果成功在页面的tables标签下能看到导入的表。
- 也可以用命令来查看是否导入表成功,进入hbase,输入”status ‘detailed‘”可以查看初始化的
./hbase shell status ‘detailed‘
2. 部署Pinpoint-collector
- 将pinpoint-collector-1.6.0-SNAPSHOT.war放到tomcat-collector-8086/webapps/下,并重命名为ROOT.war
- 启动tomcat,配置ROOT/WEB-INF/classes/hbase.properties:
hbase.client.host=localhost hbase.client.port=2181
指向zookeeper的地址和端口,如果是本机,端口默认,则这里不需更改。
- 配置上面后,重启tomcat(端口8086)
3. 部署Pinpoint-web
Pinpoint-web的配置和Pinpoint-collector相似:
- 将pinpoint-web-1.6.0-SNAPSHOT.war放到tomcat-web-8085/webapps/下,并重命名为ROOT.war
- 启动tomcat,配置ROOT/WEB-INF/classes/hbase.properties:
hbase.client.host=localhost hbase.client.port=2181
指向zookeeper的地址和端口,如果是本机,端口默认,则这里不需更改。
- 配置上面后,重启tomcat(端口8085)
4. 部署Pinpoint-agent
- 新建目录:mkdir pp-agent
- 将pinpoint-agent-1.6.0-SNAPSHOT.tar.gz 拷贝到pp-agent目录并解压
- 配置pinpoint.config:profiler.collector.ip=127.0.0.1这是指pinpoint-collector的地址,如果是同一服务器,则不用修改。其它默认。
- 安装pinpoint-collector启动后,自动就开启了9994,9995,9996的端口了,这里默认即可。如果有端口需求,要去pinpoint-collector的配置文件(“pinpoint-collector/webapps/ROOT/WEB-INF/classes/pinpoint-collector.properties”)中,修改这些端口。
5. 部署TestApp
- 官方提供了一个测试用的应用,pinpoint-quickstart-testapp-null.war,将其重命名为ROOT.war,部署到tomcat-testapp-8084
- 修改此tomat的
/bin/catalina.sh
,在106行左右加入启动参数:
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/Users/acheron/pinpoint/pp-agent/pinpoint-bootstrap-1.6.0.jar" CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.agentId=myapp" CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.applicationName=MyTestPP"
第一行:pinpoint-bootstrap-1.6.0.jar的位置
第二行:这里的agentId必须唯一,标志一个jvm。
第三行:applicationName表示同一种应用:同一个应用的不同实例应该使用不同的agentId,相同的applicationName。
6. springboot包部署
如果是jar包部署,直接在启动命令加启动参数:
nohup java -javaagent:/Users/acheron/pinpoint/pp-agent/pinpoint-bootstrap-1.6.0.jar -Dpinpoint.agentId=acheron-consumer -Dpinpoint.applicationName=acheron-consumer -jar myapp.jar &
7.效果演示
hbase和各应用都启动成功之后,访问Pinpoint-web,效果:
束语
各大APM工具,几乎都是根据google这篇经典的Dapper论文而来,一定要读一读。这里是它的源文地址:https://research.google.com/pubs/pub36356.html,感谢这位同学的翻译:http://bigbully.github.io/Dapper-translation/
参考文章
- Dapper,大规模分布式系统的跟踪系统
- Pinpoint – 应用性能管理(APM)平台实践之部署篇
- 有什么知名的开源apm(Application Performance Management)工具(知乎)
- 分布式跟踪系统调研
- pinpoint安装与配置
- pinpoint安装部署
===================================================================================================================================
1. 环境配置
1.1 获取需要的依赖包
进入home目录,创建一个"pp_res"的资源目录,用来存放需要安装的包
使用xshell等类似的工具,将需要的文件上传到Linux虚拟机中,主要要传的文件都在百度网盘中
- jdk7 --- Java运行环境
- hbase-1.0 --- 数据库,用来存储监控信息
- tomcat8.0 --- Web服务器
- pinpoint-collector.war --- pp的控制器
- pinpoint-web.war --- pp展示页面
- pp-collector.init --- 用来快速启动pp-col,不要也可以
- pp-web.init --- 用来快速启动pp-web,不要也可以
使用ll命令,查看一下是否上传成功
1.2 配置jdk1.7
这套APM系统主要是用jdk1.7来进行部署的,首先要配置jdk的环境变量
配置java环境变量
将下列复制到profile的最后一行中
让环境变量生效
测试java的环境变量是否配置好了
2. 安装Hbase
pinpoint收集来的测试数据,主要是存在Hbase数据库的。所以它可以收集大量的数据,可以进行更加详细的分析。
2.1 将Hbase解压,并且放入指定目录
2.2 修改hbase-env.sh的JAVA_HOME环境变量位置
在27行左右的位置,修改如下
2.3 修改Hbase的配置信息
在结尾修改成如下,这里我们指定Hbase本地来存储数据,生产环境将数据建议存入HDFS中。
2.4 启动hbase
查看Hbase是否启动成功,如果启动成功的会看到"HMaster"的进程
2.5 初始化Hbase的pinpoint库
执行pinpoint提供的Hbase初始化语句,这时会初始化一会。
执行完了以后,进入Hbase
进入后可以看到Hbase的版本,还有一些相关的信息
输入"status ‘detailed‘"可以查看刚才初始化的表,是否存在
也可以登录web,来查看HBase的数据是否初始化成功
HbaseWeb : http://192.168.245.134:16010/master-status
3. 安装pinpoint-collector
3.1 部署war包
解压Tomcat,将Tomcat重命名移动到指定位置
修改pp-col的Tomcat的配置,主要修改端口,避免与pp-web的Tomcat的端口冲突。我在原本默认的端口前都加了1,下面是替换的shell命令。
【注意】最后一条是将tomcat的私有ip开放,需要将localhost替换成本机的ip,我本机的网卡是默认的,如果你本机的网卡不是eth0,需要进行相关的修改。或者直接用"vi"进去,修改localhost
部署pinpoint-collector.war包
【注意:如果没有unzip命令,可以 "yum install unzip" 】
启动Tomcat
查看日志,是否成功启动
3.2 配置快速启动
配置快速启动需要修改pp-collector.init的路径( pp-collector在网盘里面有 ),可以"vi"进去,大概在18,24,27行处,修改相关的路径。我这边为了方便,直接就用替换的shell做了,如果路径与我的不一致,需要将路径修改成自己的路径。
将文件赋予"执行"的权限,把它放到"init.d"中去。以后就可以restart快速重启了。
4. 安装pinpoint-web
4.1 部署war包
解压Tomcat,将Tomcat重命名移动到指定位置
修改pp-web的Tomcat的配置,主要修改端口,避免与pp-col的Tomcat的端口冲突。我在原本默认的端口前都加了2,下面是替换的shell命令
【注意】最后一条是将tomcat的私有ip开放,需要将localhost替换成本机的ip,我本机的网卡是默认的,如果你本机的网卡不是eth0,需要进行相关的修改。或者直接用"vi"进去,修改localhost
部署pinpoint-collector.war包
【注意:如果没有unzip命令,可以 "yum install unzip" 】
查看war包是否解压成功
这里说明一下:
- hbase.properties 配置我们pp-web从哪个数据源获取采集数据,这里我们只指定Hbase的zookeeper地址。
- jdbc.properties pp-web连接自身mysql数据库的连接认证配置。
- sql目录 pp-web本身有些数据需要存放在MySQL数据库中,这里需要初始化一下表结构。
- pinpoint-web.properties 这里pp-web集群的配置文件,如果你需要pp-web集群的话。
- applicationContext-* .xml 这些文件在后续的调优工作中会用到。
- log4j.xml 日志相关配置。
启动Tomcat
查看日志,Tocmat是否启动成功
日志中出现下面这句话,说明已经启动成功了
这时候我们可以访问一下这个地址,在浏览器中输入"http://192.168.245.136:28080",就会出现主页面了
如果访问不了的话,关闭防火墙
4.2 配置快速启动
需要修改"pp-web.init",与上面的步骤一致
将文件赋予"执行"的权限,把让放到"init.d"中去。以后就可以restart快速重启了。
5. 部署pp-agent采集监控数据
5.1 在测试系统中,部署pp-agent采集监控数据
部署采集器就很简单了,只需要加3句话就好了。我这边做一个测试的Tomcat,来模拟部署。
首先,先建立一个文件夹,放测试需要的包
将测试需要的pp-agent拉到服务器上
查看包是否上传成功
5.2 配置模拟的Tomcat测试环境
为了方便观察,配置一个假的系统,解压Tomcat到指定目录
配置localhost让外部可以访问
解压测试用的war包
5.3 配置pp-agent采集器
解压pp-agent
编辑配置文件
主要修改IP,只需要指定到安装pp-col的IP就行了,安装pp-col启动后,自动就开启了9994,9995,9996的端口了。这里就不需要操心了,如果有端口需求,要去pp-col的配置文件("pp-col/webapps/ROOT/WEB-INF/classes/pinpoint-collector.properties")中,修改这些端口
修改测试项目下的tomcat启动文件"catalina.sh",修改这个只要是为了监控测试环境的Tomcat,增加探针
在20行增加如下字段
- 第一行是pp-agent的jar包位置
- 第二行是agent的ID,这个ID是唯一的,我是用pp + 今天的日期命名的,只要与其他的项目的ID不重复就好了
- 第三行是采集项目的名字,这个名字可以随便取,只要各个项目不重复就好了
5.4 监控Tomcat
配置好了。就可以开始监控了,我们启动测试用的Tomcat的服务器
查看启动日志,确实Tomcat启动
启动了,我们就可以访问测试环境了
这时候我们在访问pp-web,可以发现它的下拉框中,多了一个app
因为我访问了两次,所以他显示有两条请求记录,可以在右上角的框查看详情。
【注意】鼠标点击右上角箭头位置,鼠标左键按住不动,拉框查看。我被这个坑,坑懵逼了,特此写清楚。
这时候就弹出了新页面,可以看到,我访问了一次主页,访问了一次test的servlet。而且详细信息都记录在下表中。
总结
到这里,整个部署过程就完了。值得要注意的地方:
- 如果Hbase不是与pp-web, pp-col装在一台机器上,需要安装zookeeper,只要安装就好,确实2181端口启动就好。
- 如果zookeeper安装在独立机器上,这里需要修改一下pp-colletor 和 pp-web的配置文件pinpoint-collector.properties,pinpoint-web.properties,不然会导致俩个模块启动失败。
- 发现pinpoint还是有些缺陷,异步的操作监控不到,比如我写了个多线程来发送HttpClient4的请求,但是pinpoint监控不到。但是它介绍又说可以监控到Httpclient4的请求。现在都是分布式系统,异步拿数据再常见不过来,如果监控不到异步的操作,就很鸡肋了。看pp1.6会不会修复这个问题
- 在pp1.6部署,Hbase中的默认字段有增加,如果没有加上默认字段,取得的数据就会变得相当少了。