Cat监控埋点集成

通用埋点: 如restful api接口监控，sql数据库访问监控、缓存使用监控等。对于通用的监控埋点需求，可以封装成公共服务工具类，便于其他项目直接使用。

定制化埋点: 基于不同业务场景需求，如报表job生成、业务监控(当日订单金额监控)等，project中自行通过cat-client Api实现灵活的自定义埋点。

Cat对监控的消息，定义了几个监控对象 Transaction(访问时间)、Event(访问次数)、Heartbeat(系统心跳元数据)、Metric(业务指标监控)模型。主要api也是围绕这几类实现。

以下是官方给出的监控api样例。使用比较简单，业务代码中需要自行埋点的可以参考使用。

详请请参见官方文档

项目目录中新增app.preperties文件。

src/main/resources/META-INF/app.properties

app.properties文件新增内容。

app.name={appkey}

{appkey}替换为监控应用名，如用户项目，app.name=user

对于restful api项目，可以编写一个通用filter类，对http请求进行拦截，统计接口的访问次数、响应时间、调用报错等指标。

针对这类场景，cat-client中已实现了CatFilter类。项目中只需引入便可使用。

springboot项目中添加以下初始化配置。

@Bean public FilterRegistrationBean catFilterRegistration() { FilterRegistrationBean registration = new FilterRegistrationBean(); CatFilter catFilter = new CatFilter(); registration.setFilter(catFilter); registration.addUrlPatterns("/*"); // 定制化实现无关请求的过滤 registration.addInitParameter("excludeUris", ".*\\.css$;.*\\.js$;.*\\.png$;.*\\.gif$;.*\\.jpg$"); registration.setName("catFilter"); registration.setOrder(1); return registration; } mybatis sql埋点

新增CatMybatisPlugin.java文件

package com.dianping.cat.ext; import com.alibaba.fastjson.JSON; import com.dianping.cat.Cat; import com.dianping.cat.ext.CatGlobalPropConfig; import com.dianping.cat.ext.MybatisSqlCfg; import com.dianping.cat.message.Transaction; import java.util.Properties; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.ibatis.cache.CacheKey; import org.apache.ibatis.executor.Executor; import org.apache.ibatis.mapping.BoundSql; import org.apache.ibatis.mapping.MappedStatement; import org.apache.ibatis.mapping.SqlCommandType; import org.apache.ibatis.plugin.Interceptor; import org.apache.ibatis.plugin.Intercepts; import org.apache.ibatis.plugin.Invocation; import org.apache.ibatis.plugin.Plugin; import org.apache.ibatis.plugin.Signature; import org.apache.ibatis.session.ResultHandler; import org.apache.ibatis.session.RowBounds; @Intercepts({ @Signature( method = "query", type = Executor.class, args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class} ), @Signature( type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class} ), @Signature( method = "update", type = Executor.class, args = {MappedStatement.class, Object.class} )}) public class CatMybatisPlugin implements Interceptor { private static Log logger = LogFactory.getLog(CatMybatisPlugin.class); private Executor target; public CatMybatisPlugin() { } public Object intercept(Invocation invocation) throws Throwable { MybatisSqlCfg mybatisSqlCfg = CatGlobalPropConfig.getInstance().getMybatisSqlCfgThreadLocal(); Object returnObj = null; if(mybatisSqlCfg != null && !mybatisSqlCfg.isSqlMonitor()) { returnObj = invocation.proceed(); return returnObj; } else { MappedStatement mappedStatement = (MappedStatement)invocation.getArgs()[0]; String[] strArr = mappedStatement.getId().split("\\."); String methodName = strArr[strArr.length - 2] "." strArr[strArr.length - 1]; Object parameter = null; if(invocation.getArgs().length > 1) { parameter = invocation.getArgs()[1]; } Transaction t = Cat.newTransaction("SQL", methodName); BoundSql boundSql = mappedStatement.getBoundSql(parameter); String sql = boundSql.getSql(); Object parameterObject = boundSql.getParameterObject(); SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType(); Cat.logEvent("SQL.Method", sqlCommandType.name().toLowerCase(), "0", sql); Cat.logEvent("SQL.Param", "Value", "0", JSON.toJSONString(parameterObject)); try { returnObj = invocation.proceed(); t.setStatus("0"); } catch (Exception var17) { t.setStatus(var17); Cat.logError(var17); throw var17; } finally { t.complete(); } return returnObj; } } public Object plugin(Object target) { if(target instanceof Executor) { this.target = (Executor)target; return Plugin.wrap(target, this); } else { return target; } } public void setProperties(Properties properties) { } }

以mybatis插件方式实现sql的监控埋点。

项目中mybatis-config.xml添加插件集成。

springboot全局异常处理添加cat error埋点。

package com.dctl.ea.demo.app.config; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.support.spring.FastJsonJsonView; import com.dctl.ea.base.vo.BaseResponseVo; import com.dctl.ea.base.vo.DefaultResponseVo; import com.dctl.ea.common.redis.flowcontrol.RedisFlowLimitException; import com.dctl.ea.common.util.IpUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerExceptionResolver; import org.springframework.web.servlet.ModelAndView; import sun.net.util.IPAddressUtil; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.util.Map; @Component public class ExceptionResolver implements HandlerExceptionResolver { private Logger logger = LoggerFactory.getLogger(this.getClass()); @Override public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) { logger.error("系统全局异常",e); int code = BaseResponseVo.SYSYTEM_EXCEPTION; String message = "系统异常"; //Cat 全局异常埋点 Cat.logError("系统全局异常:",e); FastJsonJsonView fastJsonJsonView = new FastJsonJsonView(); ModelAndView modelAndView = new ModelAndView(); fastJsonJsonView.setAttributesMap(JSON.parseObject(JSON.toJSONString(DefaultResponseVo.fail(code,message)), Map.class)); modelAndView.setView(fastJsonJsonView); return modelAndView; } }

到此，监控项目的Cat client集成已完成。本文介绍了Cat在java项目中如何实现自定义的埋点方式，有类似需求的童鞋可以参考实现。

下篇将介绍Cat项目集成中的一些深入定制优化，有兴趣的童鞋，请关注我。原创不易，请多多支持，谢谢！