第1章 CAT链路监控
1. 目标
- 了解CAT链路监控平台
- 了解CAT链路监控机制与基本原理
2. 分析
- 背景
- 简介
- 优势
- 功能报表
- Google Dapper分布式跟踪系统理论
- Dapper部署架构
- 链路监控机制
- CAT的架构设计
3. 讲解
3.1 背景
从单体架构到微服务架构的演变, 一个业务请求往往会流转多个服务, 大型互联网产品服务架构尤为复杂,腾讯的抢红包服务, 阿里的交易支付服务, 可能就流转成百上千个服务节点, 面对众多服务, 如何监控管理? 服务请求一旦出现问题, 如何快速定位问题? 如何保障服务的高可用, 做到全面的监控与预警? 如何分析统计服务的运行状况? 看下链路监控产品如何解决这些问题。
3.2 CAT简介
- CAT 是基于 Java 开发的实时应用监控平台,为美团点评提供了全面的实时监控告警服务。
- CAT 作为服务端项目基础组件,提供了 Java, C/C++, Node.js, Python, Go 等多语言客户端,已经在美团点评的基础架构中间件框架(MVC框架,RPC框架,数据库框架,缓存框架等,消息队列,配置系统等)深度集成,为美团点评各业务线提供系统丰富的性能指标、健康状况、实时告警等。
- CAT 很大的优势是它是一个实时系统,CAT 大部分系统是分钟级统计,但是从数据生成到服务端处理结束是秒级别,秒级定义是48分钟40秒,基本上看到48分钟38秒数据,整体报表的统计粒度是分钟级;第二个优势,监控数据是全量统计,客户端预计算;链路数据是采样计算。
3.3 CAT优势
- 实时处理:信息的价值会随时间锐减,尤其是事故处理过程中。
- 全量数据:全量采集指标数据,便于深度分析故障案例。
- 高可用:故障的还原与问题定位,需要高可用监控来支撑。
- 故障容忍:故障不影响业务正常运转、对业务透明。
- 高吞吐:海量监控数据的收集,需要高吞吐能力做保证。
- 可扩展:支持分布式、跨 IDC 部署,横向扩展的监控系统。
- 报表丰富: 帮助管理人员从各个角度了解系统的整体状况。
3.4 CAT报表
-
报错统计报表
-
业务统计报表
-
LOGVIEW统计
-
可视化LOGVIEW
-
应用类型报表
3.5 Google Dapper论文
3.6 Dapper Deployment
3.7 链路监控工作机制
3.8 CAT架构设计
整体设计
简单即是最好原则设计, 主要分为三个模块cat-client,cat-consumer,cat-home。
- cat-client 提供给业务以及中间层埋点的底层sdk。
- cat-consumer 用于实时分析从客户端的提供的数据。
- cat-home 作为提供给用户的展示的控制端。
客户端设计
客户端设计是CAT系统设计中最为核心的一个环节,客户端要求是做到API简单、高可靠性能、无论在任何场景下客户端都不能影响各业务服务的性能(监控只是公司核心业务流程一个旁路环节)。
服务端设计
服务端单机cat-consumer的整体架构:
当某个报表处理器处理来不及时候,比如Transaction报表处理比较慢,可以通过配置支持开启多个Transaction处理线程,并发消费消息。
4. 总结
- CAT功能作用, 特点优势
- CAT的统计报表,功能作用
- Google Dapper分布式链路监控理论基础, 部署结构。
- 链路的监控机制, 如何运作, 如何跟踪。
- CAT的架构设计,特征, 核心模块,处理流程。
第2章 CAT安装使用
1. 目标
- 安装与配置CAT服务
- CAT的接入使用, 查看链路跟踪信息
2. 步骤
- 完成CAT单机部署
- 拓展CAT集群部署
- 服务设计
- 工程结构
- CAT集成事项
- 启动验证
3. 实现
3.1 CAT单机部署
环境要求
CAT启动配置
不建议在Windows下部署, 设计上对window支持不好, 容易出各种问题。
-
下载CAT源码, 如GIT方式过慢, 可用Download Zip 方式打包下载。
-
构建CAT服务war包
可以导入IDEA工程进行编译, 或者直接用MAVEN进行编译:
将MAVEN加入到系统PATH, 执行mvn命令:mvn clean install -Dmaven.test.skip=true
-
创建数据库
先创建CAT数据库, 采用utf8mb4字符集, 再导入{CAT_SRC}/script/目录下的CatApplication.sql脚本。
-
配置修改
运行盘下的/data/appdatas/cat和/data/applogs/cat有读写权限, 如果程序是在E盘, 则需创建e:/data/appdatas/cat目录
-
配置/data/appdatas/cat/client.xml (客户端使用)
<?xml version="1.0" encoding="utf-8"?> <config mode="client"> <servers> <server ip="127.0.0.1" port="2280" http-port="8080"/> </servers> </config>
-
配置/data/appdatas/cat/datasources.xml (服务端使用)
-
TOMCAT配置
修改tomcat conf 目录下 server.xml, 检查好端口没有被其他程序占用。
如果内存不足, 需作调整(linux)
```sh
CATALINA_OPTS="-Xms1024m -Xmx2048m -Xss1024K -XX:MetaspaceSize=512m -XX:MaxMetaspaceSize=1024m"
- 启动
-
执行start.sh
-
打开控制台地址: http://10.10.20.10:8080/cat/s/config?op=routerConfigUpdate
-
默认用户名:admin 默认密码:admin
正常可以看到后台:
3.2 CAT集群部署
课程演示, 不作详细介绍, 具体可参考官方文档: CAT集群部署
3.3 服务设计
设计四个服务:网关服务、订单服务、账户服务和库存服务, 三层调用关系监控,
Gateway->Order->Account、Stock
3.4 工程结构
- cat-demo: 父级工程
- cat-demo-account: 账户服务工程
- cat-demo-gateway: 网关服务工程
- cat-demo-order: 订单服务工程
- cat-demo-stock: 库存服务工程
3.5 CAT集成事项
- cat-demo父级工程的POM依赖:
引用最新版本cat组件:
<dependencies>
<!-- spring boot 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Nacos服务注册发现依赖 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!-- Spring Boot 监控组件依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!-- CAT 组件依赖-->
<dependency>
<groupId>com.dianping.cat</groupId>
<artifactId>cat-client</artifactId>
<version>3.0.0</version>
</dependency>
</dependencies>
- 请求接收拦截器
拦截所有经过服务的请求, 为前置拦截器, 支持URL正则匹配
CatFilterConfigure 配置类:
@Configuration
public class CatFilterConfigure {
@Bean
public FilterRegistrationBean catFilter() {
FilterRegistrationBean registration = new FilterRegistrationBean();
CatServletFilter filter = new CatServletFilter();
registration.setFilter(filter);
registration.addUrlPatterns("/*");
registration.setName("cat-filter");
registration.setOrder(1);
return registration;
}
}
CatServletFilter实现类:
package com.test.cat.demo.gateway.catutils;
import com.dianping.cat.Cat;
import com.dianping.cat.CatConstants;
import com.dianping.cat.message.Message;
import com.dianping.cat.message.Transaction;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
public class CatServletFilter implements Filter {
private String[] urlPatterns = new String[0];
/**
* 初始化配置
* @param filterConfig
* @throws ServletException
*/
@Override
public void init(FilterConfig filterConfig) throws ServletException {
String patterns = filterConfig.getInitParameter("CatHttpModuleUrlPatterns");
if (patterns != null) {
patterns = patterns.trim();
urlPatterns = patterns.split(",");
for (int i = 0; i < urlPatterns.length; i++) {
urlPatterns[i] = urlPatterns[i].trim();
}
}
}
/**
* 请求过滤处理
* @param servletRequest
* @param servletResponse
* @param filterChain
* @throws IOException
* @throws ServletException
*/
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
String url = request.getRequestURL().toString();
for (String urlPattern : urlPatterns) {
if (url.startsWith(urlPattern)) {
url = urlPattern;
}
}
// cat 上下文信息设置
CatContext catContext = new CatContext();
catContext.addProperty(Cat.Context.ROOT, request.getHeader(CatHttpConstants.CAT_HTTP_HEADER_ROOT_MESSAGE_ID));
catContext.addProperty(Cat.Context.PARENT, request.getHeader(CatHttpConstants.CAT_HTTP_HEADER_PARENT_MESSAGE_ID));
catContext.addProperty(Cat.Context.CHILD, request.getHeader(CatHttpConstants.CAT_HTTP_HEADER_CHILD_MESSAGE_ID));
Cat.logRemoteCallServer(catContext);
Transaction t = Cat.newTransaction(CatConstants.TYPE_URL, url);
try {
// cat日志记录
Cat.logEvent("Service.method", request.getMethod(), Message.SUCCESS, request.getRequestURL().toString());
Cat.logEvent("Service.client", request.getRemoteHost());
filterChain.doFilter(servletRequest, servletResponse);
t.setStatus(Transaction.SUCCESS);
} catch (Exception ex) {
t.setStatus(ex);
Cat.logError(ex);
throw ex;
} finally {
t.complete();
}
}
}
-
RestTemplate请求拦截器
请求传递拦截器, 保存CAT调用链信息, 跟踪记录发送至外部服务的请求。
CatRestInterceptor
@Component
public class CatRestInterceptor implements ClientHttpRequestInterceptor {
@Override
public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
throws IOException {
Transaction t = Cat.newTransaction(CatConstants.TYPE_CALL, request.getURI().toString());
try {
HttpHeaders headers = request.getHeaders();
// 保存和传递CAT调用链上下文
Context ctx = new CatContext();
Cat.logRemoteCallClient(ctx);
headers.add(CatHttpConstants.CAT_HTTP_HEADER_ROOT_MESSAGE_ID, ctx.getProperty(Context.ROOT));
headers.add(CatHttpConstants.CAT_HTTP_HEADER_PARENT_MESSAGE_ID, ctx.getProperty(Context.PARENT));
headers.add(CatHttpConstants.CAT_HTTP_HEADER_CHILD_MESSAGE_ID, ctx.getProperty(Context.CHILD));
// 继续执行请求
ClientHttpResponse response = execution.execute(request, body);
t.setStatus(Transaction.SUCCESS);
return response;
} catch (Exception e) {
Cat.getProducer().logError(e);
t.setStatus(e);
throw e;
} finally {
t.complete();
}
}
}
注意, RestTemplate的初始化配置:
@Bean
RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
// 保存和传递调用链上下文
restTemplate.setInterceptors(Collections.singletonList(new CatRestInterceptor()));
return restTemplate;
}
- 注意
- resources资源目录, 路径META-INF下, 必须创建app.properties, 内部只要配置app.name属性。
- 3.0版本后, client的配置抽离, 写在/data/appdatas/cat目录下的client.xml文件
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema" xsi:noNamespaceSchemaLocation="config.xsd">
<servers>
<server ip="10.10.20.10" port="2280" http-port="8080" />
</servers>
</config>
服务最好要在Linux下运行, 源码没有正确识别windows盘符, 会有问题。
3.6 启动验证
-
Nacos控制台
四个服务正常启动注册。注意: 这里打包时候Nacos指向地址为宿主机的HOST地址
-
访问Gateway服务, 本示例是部署在Linux机器上, 地址: http://10.10.20.10:8081/gateway
所有服务均正常返回结果:
gateway service ==> Calling order service[order success] ==> Calling Account Service [account success] ==> Calling Customer Service [stock success]
- CAT控制台
CAT的LOGVIEW按层级完整的记录了四个服务的请求信息, 1至4分别对应Gateway、Order、Account和Stock服务。
LOGVIEW主要包含请求时间, 服务地址, 请求客户端等主要信息, 也支持图形方式呈现:
CAT 还有很多指标统计与报表展示, 能有效帮助我们监控管理整体微服务调用链路状态。
4. 总结
- CAT的单机部署, 虚拟机下, 注意绑定的IP, TOMCAT下注意采用UTF8编码, 防止乱码, 如本机内存有限, 可以将CAT占用内存调小些。
- 了解整体服务结构设计, 接入CAT使用验证, 查看链路跟踪信息。
- 掌握LOGVIEW的关键信息, 服务地址, 客户端信息, 请求耗时等。