1 Star 8 Fork 1

user_1413365 / CAT-CLIENT-LOCAL

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Cat Client Local for Java

前言

为现有系统接入监控体系提供最简解决方案。—— 你负责引入JAR依赖, 剩下的工作全部交给我们!

本项目基于大众点评的CAT监控平台开源版的cat-client for java. 意图打造史上最低难度的单体应用监控接入解决方案, 摆脱过往需要登录部署服务器查看日志排错的低效工作方式, 助推监控体系在无专业运维团队的快速落地, 实现系统监控常态化。

项目产生的背景

使用方法

  1. 对于每个前端请求, 返回值的HTTP HEADER中都会存在一个KEY为X-CAT-ROOT-ID的键值对, 该键值对的值也就是我们常说的链路追踪体系下的traceId.
  2. 拿着上一步获取到的traceId, 即可以在我们提供的默认查询页面下获取所对应的请求全链路调用图(见下方示例GIF).
  3. 在自定义查询页面下,我们还提供了下载当前页面,以及将当前页面导出为图片的附加功能,以应对因为某些原因无法在线查询链路日志的问题。

效果图

demo

对于以上GIF中链路查询结果的解释: demo-explain

演示地址

演示地址

与官方标准版CAT-CLIENT比较

  1. 无需要部署服务端,引入本组件依赖就能用。
  2. 内置请求链路查询页面。结合本组件自动生成并作为HTTP Header返回前端的traceid,使用者无需任何额外开发即可享用全链路日志追踪的功能。
  3. 内置日志文件按小时切割储存,无需额外部署存储介质,同时杜绝了单个日志文件过大的问题。注:这一功能移植自标准版CAT。
  4. 内置链路查询结果导出功能,以应对诸如内网隔离等导致的无法在线搜索的问题。
  5. 内置链路图形化展示功能,以人类更敏感的图形化方式更加直观地展示链路中各操作的耗时占比。注:这一功能移植自标准版CAT。
  6. 提供对外扩展接口。使用者可以籍此实现诸如报表统计、预警通知、流量回放、规范落地审查等等自定义需求(参见下方集成样例)。
  7. 提供完善的入门文档和典型示例项目, 极限压低接入曲线。

集成样例

  1. springboot项目集成
  2. springmvc项目集成
  3. struts2项目集成
  4. Spring-JdbcTemplate埋点
  5. Spring-RestTemplate埋点
  6. Spring-RedisTemplate埋点
  7. MybatisPlus埋点
  8. OkHttp埋点
  9. Apache HttpClient埋点
  10. commons-httpclient埋点
  11. Metric示例
  12. 玩得花之调用链路展示为流程图效果
  13. 官方集成案例

原理

  1. 直接复用CAT久经考验的日志模型,以及基于ThreadLocal的实现方式, 即不介入cat-client sdk中前期的日志收集和日志结构组装的逻辑,尽可能地站在巨人肩膀上.
  2. 主要的自定义改造点位于cat-client sdk将收集来的日志通过netty发送给服务端的那部分代码实现处。

FAQ

  1. 是否支持跨服务调用?

本组件的最新版是支持跨服务调用的, 但这里并不推荐采用本组件进行跨服务调用的支持。 跨服务推荐使用标准版本,我们这个主打单体应用追踪,将监控集成的成本压到最低,哪怕你是个单人项目也可以从中受益。

相关介绍性文档

快速入门

快速入门

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

对大众点评开源的cat-client进行本地化,去服务端化。实现只需要引入JAR即可完成链路追踪监控的接入。助力系统监控常态化。 展开 收起
Java 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/lqzkcx3/cat-local.git
git@gitee.com:lqzkcx3/cat-local.git
lqzkcx3
cat-local
CAT-CLIENT-LOCAL
master

搜索帮助