天天看點

調用鍊監控 CAT 之 入門

文章首發于公衆号《程式員果果》

位址:

https://mp.weixin.qq.com/s/G15cw9yXpq4cOFB2C29JYw

簡介

CAT 是一個實時和接近全量的監控系統,它側重于對Java應用的監控,基本接入了美團上海所有核心應用。目前在中間件(MVC、RPC、資料庫、緩存等)架構中得到廣泛應用,為美團各業務線提供系統的性能名額、健康狀況、監控告警等。

優勢

  • 實時處理:資訊的價值會随時間銳減,尤其是事故處理過程中。
  • 全量資料:全量采集名額資料,便于深度分析故障案例。
  • 高可用:故障的還原與問題定位,需要高可用監控來支撐。
  • 故障容忍:故障不影響業務正常運轉、對業務透明。
  • 高吞吐:海量監控資料的收集,需要高吞吐能力做保證。
  • 可擴充:支援分布式、跨 IDC 部署,橫向擴充的監控系統。

開源産品比較

調用鍊監控 CAT 之 入門

快速上手

本地部署

步驟1:部署tomcat

準備一個tomcat,修改 tomcat conf 目錄下 server.xml,防中文亂碼。

Connector port="8080" protocol="HTTP/1.1"
           URIEncoding="utf-8"    connectionTimeout="20000"
               redirectPort="8443" />  <!-- 增加  URIEncoding="utf-8"  -->           

步驟2:程式對于/data/目錄具體讀寫權限(重要)

  • Linux
    • 要求/data/目錄能進行讀寫操作,如果/data/目錄不能寫,建議使用linux的軟連結連結到一個固定可寫的目錄。
    • 此目錄會存一些CAT必要的配置檔案以及運作時候的資料存儲目錄。
    • CAT支援CAT_HOME環境變量,可以通過JVM參數修改預設的路徑。
mkdir /data
chmod -R 777 /data/           
  • Windows

對程式運作盤下的/data/appdatas/cat和/data/applogs/cat有讀寫權限。例如cat服務運作在e盤的tomcat中,則需要對e:/data/appdatas/cat和e:/data/applogs/cat有讀寫權限。

步驟3: 配置/data/appdatas/cat/client.xml ($CAT_HOME/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>           

此配置檔案的作用是所有的用戶端都需要一個位址指向CAT的服務端。

步驟4: 安裝CAT的資料庫

下載下傳cat源碼包:

https://codeload.github.com/dianping/cat/

解壓後,資料庫的腳本檔案為 script/CatApplication.sql

mysql -uroot -Dcat < CatApplication.sql           

步驟5: 配置/data/appdatas/cat/datasources.xml($CAT_HOME/datasources.xml)

<?xml version="1.0" encoding="utf-8"?>

<data-sources>
    <data-source id="cat">
        <maximum-pool-size>3</maximum-pool-size>
        <connection-timeout>1s</connection-timeout>
        <idle-timeout>10m</idle-timeout>
        <statement-cache-size>1000</statement-cache-size>
        <properties>
            <driver>com.mysql.jdbc.Driver</driver>
            <url><![CDATA[jdbc:mysql://127.0.0.1:3306/cat]]></url>  <!-- 請替換為真實資料庫URL及Port  -->
            <user>root</user>  <!-- 請替換為真實資料庫使用者名  -->
            <password>root</password>  <!-- 請替換為真實資料庫密碼  -->
            <connectionProperties><![CDATA[useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&socketTimeout=120000]]></connectionProperties>
        </properties>
    </data-source>
</data-sources>           

步驟6: war打包

官方下載下傳:

http://unidal.org/nexus/service/local/repositories/releases/content/com/dianping/cat/cat-home/3.0.0/cat-home-3.0.0.war

重命名為cat.war進行部署,注意此war是用jdk8,服務端請使用jdk8版本

步驟7: war部署

<?xml version="1.0" encoding="utf-8"?>
<router-config backup-server="你的本機ip(不要用127.0.0.1)" backup-server-port="2280">
   <default-server id="你的本機ip(不要用127.0.0.1)" weight="1.0" port="2280" enable="true"/>
   <network-policy id="default" title="預設" block="false" server-group="default_group">
   </network-policy>
   <server-group id="default_group" title="default-group">
      <group-server id="你的本機ip(不要用127.0.0.1)"/>
   </server-group>
   <domain id="cat">
      <group id="default">
         <server id="你的本機ip(不要用127.0.0.1)" port="2280" weight="1.0"/>
      </group>
   </domain>
</router-config>           

送出後,重新開機tomcat,通路

http://127.0.0.1:8080/cat

,出現如下界面,說明搭建成功。

調用鍊監控 CAT 之 入門

測試

安裝jar包

進入cat源碼包的 lib/java/jar ,将cat-client-3.0.0.jar 包 安裝到本地maven倉庫。

mvn install:install-file -DgroupId=com.dianping.cat -DartifactId=cat-client Dversion=3.0.0 -Dpackaging=jar -Dfile=cat-client-3.0.0.jar           

建立工程

建立一個springboot 工程,關鍵代碼如下。

pom.xml
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>com.dianping.cat</groupId>
    <artifactId>cat-client</artifactId>
    <version>3.0.0</version>
</dependency>           

app.properties

需要在你的項目中建立 src/main/resources/META-INF/app.properties 檔案, 并添加如下内容:

app.name={appkey}           

appkey 隻能包含英文字母 (a-z, A-Z)、數字 (0-9)、下劃線 (_) 和中劃線 (-)

application.yml

server:
  port: 8760

spring:
  application:
    name: cat-simple           

啟動類

@SpringBootApplication
@RestController
public class CatSimpleApplication {


    public static void main(String[] args) {
        SpringApplication.run( CatSimpleApplication.class, args );
    }

    @PostMapping("/hi")
    public String hi(HttpServletRequest request){
        String url = request.getRequestURL().toString();

        // 建立一個 Transaction
        Transaction transaction = Cat.newTransaction( "URL", url );
        try {
            // 處理業務
            myBusiness();
            // 設定狀态
            transaction.setStatus(Transaction.SUCCESS);
        } catch (Exception e) {
            // 設定錯誤狀态
            transaction.setStatus(e);
            // 記錄錯誤資訊
            Cat.logError(e);
        } finally {
            // 結束 Transaction
            transaction.complete();
        }

        return "hello";
    }

    @PostMapping("/error")
    public String error(HttpServletRequest request){
        String url = request.getRequestURL().toString();

        // 建立一個 Transaction
        Transaction transaction = Cat.newTransaction( "URL", url );
        try {
            // 處理業務
            int i = 1 / 0;
            // 設定狀态
            transaction.setStatus(Transaction.SUCCESS);
        } catch (Exception e) {
            // 設定錯誤狀态
            transaction.setStatus(e);
            // 記錄錯誤資訊
            Cat.logError(e);
        } finally {
            // 結束 Transaction
            transaction.complete();
        }

        return "500";
    }

    private void myBusiness() {
        //模拟業務處理的時間
        try {
            Thread.sleep( 500 );
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }


}           

請求

http://localhost:8760/hi
curl -X POST  http://localhost:8760/hi           
http://localhost:8760/error
curl -X POST  http://localhost:8760/error           

檢視監控資訊

進入 cat 控制台,點選 Transaction 按鈕 ,之後點選全部,會看到有哪些用戶端,如圖:

調用鍊監控 CAT 之 入門

點選用戶端 cat-simple ,出現如圖:

調用鍊監控 CAT 之 入門

如上圖,可以清晰的看到 請求的 總個數(tatal)、均值(avg)、最大/最小(max/min)、标準差(std)等,其他都比較直覺,标準差稍微複雜一點,大家自己可以推演一下怎麼做增量計算。那集合運算,比如95線(表示95%請求的完成時間)、999線(表示99.9%請求的完成時間)

點選 “log View” 可以檢視 錯誤資訊,如圖:

調用鍊監控 CAT 之 入門

源碼

https://github.com/gf-huanchupk/SpringCloudLearning/tree/master/chapter14

參考

https://github.com/dianping/cat/wiki