### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

### 本篇概覽
- 本文是《Docker下Prometheus和Grafana三部曲》的終篇，前面的文章中，我們體驗了快速搭建監控環境，也揭示瞭如何編排Docker容器來簡化環境搭建過程，在監控系統中有個業務web服務，它上報的資料也能在監控系統中透過圖形化介面展現出來，如下圖所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310001409991.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 本文透過實戰來介紹業務應用如何將業務資料上報到prometheus，再透過Grafana的圖形化介面展現出來；

### 原始碼下載
- 接下來詳細講述應用的編碼過程，如果您不想自己寫程式碼，也可以在GitHub下載完整的應用原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章原始碼在prometheusdemo這個資料夾下，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310111133224.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

### 編碼實戰
- 基於maven建立一個springboot web工程，pom.xml內容如下，增加了actuator的依賴，以及prometheus的SDK依賴項micrometer-spring-legacy和micrometer-registry-prometheus，另外要注意的是**plugin**節點，裡面配置了製作docker映象的外掛：

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelversion>4.0.0</modelversion>
    <parent>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-starter-parent</artifactid>
        <version>1.5.19.RELEASE</version>
        <relativepath></relativepath> 
    </parent>
    <groupid>com.bolingcavalry</groupid>
    <artifactid>prometheusdemo</artifactid>
    <version>0.0.1-SNAPSHOT</version>
    <name>prometheusdemo</name>
    <description>Demo project for Spring Boot</description>

<dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>

<dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>

<dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-actuator</artifactid>
        </dependency>
        
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-devtools</artifactid>
            <optional>true</optional>
        </dependency>

<dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-actuator</artifactid>
        </dependency>

<dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-security</artifactid>
        </dependency>

<dependency>
            <groupid>io.micrometer</groupid>
            <artifactid>micrometer-spring-legacy</artifactid>
            <version>1.0.6</version>
        </dependency>
        <dependency>
            <groupid>io.micrometer</groupid>
            <artifactid>micrometer-registry-prometheus</artifactid>
            <version>1.0.6</version>
        </dependency>
    </dependencies>

<build>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>

<plugin>
                <groupid>com.spotify</groupid>
                <artifactid>docker-maven-plugin</artifactid>
                <version>0.4.12</version> 
                <configuration>
                    
                    <imagename>bolingcavalry/${project.artifactId}</imagename>
                    
                    <imagetags>
                        <imagetag>${project.version}</imagetag>
                    </imagetags>
                    
                    <baseimage>java:8u111-jdk</baseimage>
                    
                    <entrypoint>["java", "-jar", "/${project.build.finalName}.jar"]</entrypoint>
                    
                    <resources>
                        <resource>
                            <targetpath>/</targetpath>
                            <directory>${project.build.directory}</directory>
                            <include>${project.build.finalName}.jar</include>
                        </resource>
                    </resources>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
```

- 修改系統配置檔案application.yml的內容，增加prometheus的SDK會用到的配置，以及關閉security驗證：

```yml
management:
  endpoints:
    web:
      exposure:
        include: '*'
    jmx:
      exposure:
        include: '*'
    shutdown:
      enabled: true
  metrics:
    distribution:
      percentiles-histogram[http.server.requests]: true
  security:
    enabled: false

spring:
  metrics:
    servo:
      enabled: false
security:
  basic:
    enabled: false
```

- 增加一個configuration類，作用是向spring容器註冊一個Counter例項，該例項使用者向prometheus上報資料：

```java
package com.bolingcavalry.prometheusdemo;

import io.micrometer.core.instrument.Counter;
import io.micrometer.prometheus.PrometheusMeterRegistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class PromConfig {

@Autowired
    PrometheusMeterRegistry registry;

@Bean
    public Counter getCounter() {
        Counter counter = Counter.builder("my_sample_counter")
                .tags("status", "success")
                .description("A simple Counter to illustrate custom Counters in Spring Boot and Prometheus")
                .register(registry);
        return counter;
    }
}
```

- 從上述程式碼可見，Counter.builder方法會例項化一個Counter類，這個類就代表了一個prometheus的監控項，可以用來上報名為"my_sample_counter"的監控資料，另外這個監控資料還會帶上名為"status=success"的tag(稍後展示的實際資料可以看到)；

- 做一個響應web請求的controller，每收到一次web請求，都透過呼叫**counter.increment()**方法上報一次監控資料：

```java
package com.bolingcavalry.prometheusdemo;

import io.micrometer.core.instrument.Counter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime;

@RestController
class GreetingController {

@Autowired
    Counter counter;

@GetMapping("/greet")
    String greet(@RequestParam(defaultValue = "World") String name) {
        counter.increment();
        return "Hello: " + name + " " + LocalDateTime.now();
    }
}
```

- 應用的入口類沒有什麼特別的，如下：

```java
package com.bolingcavalry.prometheusdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class PrometheusdemoApplication {

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

- 另外為了方便大家實戰，我把前面幾篇文章用到的指令碼內容也放在這個工程中了，在名為files的資料夾下：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310113620512.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 以上就是整個web工程的全部內容了，接下來要將此工程編譯並構建成Docker映象；

### 構建應用的Docker映象
- 請確認當前的電腦上maven和Docker環境都已經配置好，我這裡Maven版本是3.6.0，在pom.xml檔案所在目錄執行以下命令，即可將當前工程構建成Docker映象：

```shell
mvn clean package -U -DskipTests docker:build
```

- 如果控制檯輸出以下內容代表構建成功：

```shell
[INFO] --- spring-boot-maven-plugin:1.5.19.RELEASE:repackage (default) @ prometheusdemo ---
[INFO] 
[INFO] --- docker-maven-plugin:0.4.12:build (default-cli) @ prometheusdemo ---
[INFO] Copying /root/work/temp/201903/09/prometheusdemo/target/prometheusdemo-0.0.1-SNAPSHOT.jar -> /root/work/temp/201903/09/prometheusdemo/target/docker/prometheusdemo-0.0.1-SNAPSHOT.jar
[INFO] Building image bolingcavalry/prometheusdemo
Step 1/3 : FROM java:8u111-jdk
 ---> d23bdf5b1b1b
Step 2/3 : ADD /prometheusdemo-0.0.1-SNAPSHOT.jar //
 ---> 2c5819935f94
Removing intermediate container 7d42332c1da5
Step 3/3 : ENTRYPOINT java -jar /prometheusdemo-0.0.1-SNAPSHOT.jar
 ---> Running in 52407ee52ae4
 ---> c2e2c7027455
Removing intermediate container 52407ee52ae4
Successfully built c2e2c7027455
[INFO] Built bolingcavalry/prometheusdemo
[INFO] Tagging bolingcavalry/prometheusdemo with 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  25.294 s
[INFO] Finished at: 2019-03-10T11:42:25+08:00
[INFO] ------------------------------------------------------------------------
```

- 輸入docker images命令檢查本地映象，可以看到新構建的內容，如下圖紅框：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310114510525.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 由於基礎映象使用的是JDK官方版，整個映象的體積較大，達到了660MB，您可以修改pom.xml中關於基礎映象的設定，將baseImage節點的內容從**java:8u111-jdk**改為**openjdk:8u191-jdk-alpine3.9**，重新構建後，新的映象體積會縮小到122MB，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310115517213.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 以上就是web工程的開發以及Docker映象的製作過程了，接下來看看如何進行配置，在Grafana上看到監控資料；

### 配置自定義監控項

- 宿主機的IP地址是192.168.1.101，在瀏覽器上看看web工程給prometheus提供的資料，訪問地址是：http://192.168.1.101:8081/prometheus ，如下圖，程式碼中自定義的監控項在資料中可以看到，不過名稱被加了個字尾，變成了**my_sample_counter_total**，另外tag的內容status="success"也出現了：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/2019031012014945.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 有了上述內容，prometheus就能採集到業務上報的監控項了，接下來我們來試試在Grafana頁面上如何配置這個監控項的展示頁面，前面的實戰中，我們是透過import_dashboard.sh指令碼匯入的，現在我們自己動手配置一個一模一樣的；

- 在Grafana頁面點選manage，再點選"+Dashboard"按鈕，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310120643713.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)4. 對新增的Dashboard進行設定，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/2019031012085711.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 填寫基本資訊，除了名稱、描述、還可以打上一些標籤：

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310121115312.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 建立一個變數，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310121221566.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 在設定變數的頁面進行設定，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310130204421.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 基本配置完成了，現在可以配置一個監控，用來展示業務上報的my_sample_counter_total資料了，如下：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/2019031013035037.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 如下圖紅框，選擇Graph：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310130426665.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 如下圖，在新頁面點選Panel Title的下拉選單，選擇"Edit":
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310130745773.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 先配置展示名稱，如下：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310130810919.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 如下圖，選擇"Metrics"頁，資料來源選擇"Prometheus"，紅框3位置輸入內容"my_sample_counter_total{status="success", job="$job"}"，頁面會立即展示my_sample_counter_total這個監控項的曲線圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310131124342.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 此時，一個自定義監控項就設定成功了，記得點選右上角的"儲存"按鈕，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310131258554.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 點選dashboard的manage選單，可見新增的dashboard，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310131423765.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 點選上圖的紅框，就能像其他監控項一樣檢視監控資料了：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310131526673.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 如果您想將這個監控項的配置匯出來，以便備份或者匯入到另一個Grafana系統，可以在設定頁面點選"JSON Model"選單，得到JSON格式的配置資訊，自行儲存，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190310131750627.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 至此，自定義監控項從開發到配置我們都完成了實戰，也到了《Docker下Prometheus和Grafana三部曲》系列和您說再見的時候了，在您搭建監控系統的時候，希望此係列文章能給您帶來一些參考。

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

Docker下Prometheus和Grafana三部曲之三：自定義監控項開發和配置

相關文章