Spring Boot + Prometheus + Grafana 打造可視化監(jiān)控，一目了然！

點(diǎn)擊關(guān)注公眾號(hào)，回復(fù)“2T”獲取2TB學(xué)習(xí)資源！

互聯(lián)網(wǎng)架構(gòu)師后臺(tái)回復(fù) 2T 有特別禮包

上一篇：一邊裁員，一邊招人。。

作者：煙味i
鏈接：https://www.cnblogs.com/2YSP/p/12827487.html

一、背景

Spring Boot 的應(yīng)用監(jiān)控方案比較多，SpringBoot + Prometheus + Grafana 是目前比較常用的方案之一。

它們?nèi)咧g的關(guān)系大概如下圖：

二、開發(fā)SpringBoot應(yīng)用

首先，創(chuàng)建一個(gè)SpringBoot項(xiàng)目，pom文件如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

<!-- https://mvnrepository.com/artifact/io.prometheus/simpleclient_spring_boot -->
<dependency>
    <groupId>io.prometheus</groupId>
    <artifactId>simpleclient_spring_boot</artifactId>
    <version>0.8.1</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

注意： 這里的SpringBoot版本是1.5.7.RELEASE，之所以不用最新的2.X是因?yàn)樽钚碌膕impleclient_spring_boot只支持1.5.X，不確定2.X版本的能否支持。

MonitorDemoApplication啟動(dòng)類增加注解

package cn.sp;

import io.prometheus.client.spring.boot.EnablePrometheusEndpoint;
import io.prometheus.client.spring.boot.EnableSpringBootMetricsCollector;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@EnablePrometheusEndpoint
@EnableSpringBootMetricsCollector
@SpringBootApplication
 public class MonitorDemoApplication {

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

 }

配置文件application.yml

server:
  port: 8848
spring:
  application:
    name: monitor-demo

security:
  user:
    name: admin
    password: 1234
  basic:
    enabled: true
    # 安全路徑列表，逗號(hào)分隔，此處只針對(duì)/admin路徑進(jìn)行認(rèn)證
    path: /admin

# actuator暴露接口的前綴
management:
  context-path: /admin
  # actuator暴露接口使用的端口，為了和api接口使用的端口進(jìn)行分離
  port: 8888
  security:
    enabled: true
    roles: SUPERUSER

測(cè)試代碼TestController

@RequestMapping("/heap/test")
@RestController
public class TestController {

    public static final Map<String, Object> map = new ConcurrentHashMap<>();

    @RequestMapping("")
    public String testHeapUsed() {
        for (int i = 0; i < 10000000; i++) {
            map.put(i + "", new Object());
        }
        return "ok";
    }
}

這里的邏輯就是在請(qǐng)求這個(gè)接口后，創(chuàng)建大量對(duì)象保存到map中增加堆內(nèi)存使用量，方便后面測(cè)試郵件報(bào)警。

啟動(dòng)項(xiàng)目后，可以在IDEA中看到有很多Endpoints，如圖：

開始我的IDEA是不顯示這個(gè)Endpoints，后來發(fā)現(xiàn)是我使用的idea版本太老了,還是2017.1的， 而這個(gè)需要 idea2017.2版本以上才能看到。另外，搜索公眾號(hào)互聯(lián)網(wǎng)架構(gòu)師后臺(tái)回復(fù)“面試”，獲取一份驚喜禮包。

后來只好重新下載安裝，弄了好久。。。。

啟動(dòng)完畢，訪問http://localhost:8888/admin/prometheus就可以看到服務(wù)暴露的那些監(jiān)控指標(biāo)了。

注意：

由于開啟了安全認(rèn)證，所以訪問這個(gè)URL的需要提示輸入賬號(hào)/密碼，如果提示404請(qǐng)檢查下你的請(qǐng)求地址是否正確，如果不設(shè)置management.context-path則默認(rèn)地址是http://ip:port/prometheus

三、安裝Prometheus

下載地址點(diǎn)擊這里，本文下載的是Windows版本prometheus-2.17.2.windows-amd64.tar.gz。

解壓后修改prometheus.yml文件，配置數(shù)據(jù)采集的目標(biāo)信息。

scrape_configs:
  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
  # - job_name: 'prometheus'

    # metrics_path defaults to '/metrics'
    # scheme defaults to 'http'.

    # static_configs:
    # - targets: ['localhost:9090']
  - job_name: 'monitor-demo'
    scrape_interval: 5s # 刮取的時(shí)間間隔
    scrape_timeout: 5s
    metrics_path: /admin/prometheus
    scheme: http
    basic_auth: #認(rèn)證信息
      username: admin
      password: 1234
    static_configs:
      - targets:
        - 127.0.0.1:8888  #此處填寫 Spring Boot 應(yīng)用的 IP + 端口號(hào)

更多配置信息請(qǐng)查看官方文檔。

現(xiàn)在可以啟動(dòng)Prometheus了，命令行輸入：prometheus.exe --config.file=prometheus.yml 訪問http://localhost:9090/targets，查看Spring Boot采集狀態(tài)是否正常。

四、安裝Grafana

下載地址點(diǎn)擊這里，本文用到的是Windows版本grafana-6.3.3.windows-amd64.zip。

解壓后運(yùn)行bin目錄下的grafana-server.exe啟動(dòng)，游覽器訪問http://localhost:3000即可看到登錄頁面，默認(rèn)賬號(hào)密碼是admin/admin。

現(xiàn)在開始創(chuàng)建自己的可視化監(jiān)控面板。

1.設(shè)置數(shù)據(jù)源

2. 創(chuàng)建一個(gè)Dashboard

3. 填寫采集的指標(biāo)點(diǎn)

注意： 這里的指標(biāo)點(diǎn)不能隨便填，必須是已有的可以在 Prometheus看到。

4.選擇圖表樣式

5.填寫標(biāo)題描述

最后點(diǎn)擊右上角的保存，輸入Dashboad的名稱即可。

Tips: 這里的圖表布局是可以用鼠標(biāo)拖動(dòng)的

五、添加郵件報(bào)警

在實(shí)際項(xiàng)目中當(dāng)監(jiān)控的某的個(gè)指標(biāo)超過閾值（比如CPU使用率過高），希望監(jiān)控系統(tǒng)自動(dòng)通過短信、釘釘和郵件等方式報(bào)警及時(shí)通知運(yùn)維人員，Grafana就支持該功能。

第一步： 點(diǎn)擊[Alerting]——>[Notification channels]添加通知通道

創(chuàng)建通道

 

這里的Type有很多選項(xiàng)，包括webhook、釘釘?shù)?，這里以郵件為例。

第二步： 郵箱配置

Grafana默認(rèn)使用conf目錄下defaults.ini作為配置文件運(yùn)行，根據(jù)官方的建議我們不要更改defaults.ini而是在同級(jí)目錄下新建一個(gè)配置文件custom.ini。

以騰訊企業(yè)郵箱為例，配置如下：

#################################### SMTP / Emailing #####################
[smtp]
enabled = true
host = smtp.exmail.qq.com:465
user = [email protected]
# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
password = XXX
cert_file =
key_file =
skip_verify = true
from_address = [email protected]
from_name = Grafana
ehlo_identity = ininin.com

然后需要重啟Grafana，命令grafana-server.exe -config=E:\file\grafana-6.3.3\conf\custom.ini

第三步： 為指標(biāo)添加alert

配置預(yù)警規(guī)則

配置通知方式和信息

Evaluate every

表示檢測(cè)評(píng)率，這里為了測(cè)試效果，改為1秒

For

如果警報(bào)規(guī)則配置了For，并且查詢違反了配置的閾值，那么它將首先從OK變?yōu)镻ending。從OK到Pending Grafana不會(huì)發(fā)送任何通知。另外，搜索公眾號(hào)互聯(lián)網(wǎng)架構(gòu)師后臺(tái)回復(fù)“面試”，獲取一份驚喜禮包。一旦警報(bào)規(guī)則的觸發(fā)時(shí)間超過持續(xù)時(shí)間，它將更改為Alerting并發(fā)送警報(bào)通知。

Conditions

when 表示什么時(shí)間，of 表示條件，is above 表示觸發(fā)值 同時(shí)，設(shè)置了is above后會(huì)有一條紅線。

If no data or all values are null

如果沒有數(shù)據(jù)或所有值都為空，這里選擇觸發(fā)報(bào)警

If execution error or timeout

如果執(zhí)行錯(cuò)誤或超時(shí)，這里選擇觸發(fā)報(bào)警

注意： 下一次觸發(fā)，比如10秒后，它不會(huì)再次觸發(fā)，防止報(bào)警風(fēng)暴產(chǎn)生！

第四步： 測(cè)試

請(qǐng)求http://localhost:8848/heap/test接口后，內(nèi)存升高大于設(shè)置的閾值，然后就收到報(bào)警郵件。

這里圖片沒有顯示出來，搞不懂為什么。

六、總結(jié)

這套監(jiān)控功能還是挺強(qiáng)大的，就是Prometheus的表達(dá)式有點(diǎn)多。

感謝您的閱讀，也歡迎您發(fā)表關(guān)于這篇文章的任何建議，關(guān)注我，技術(shù)不迷茫！小編到你上高速。

    · END ·

最后，關(guān)注公眾號(hào)互聯(lián)網(wǎng)架構(gòu)師，在后臺(tái)回復(fù)：2T，可以獲取我整理的 Java 系列面試題和答案，非常齊全。

正文結(jié)束

推薦閱讀 ↓↓↓

1.心態(tài)崩了！稅前2萬4，到手1萬4，年終獎(jiǎng)扣稅方式1月1日起施行~

2.深圳一普通中學(xué)老師工資單曝光，秒殺程序員，網(wǎng)友：敢問是哪個(gè)學(xué)校畢業(yè)的？

3.從零開始搭建創(chuàng)業(yè)公司后臺(tái)技術(shù)棧

4.程序員一般可以從什么平臺(tái)接私活？

5.清華大學(xué)：2021 元宇宙研究報(bào)告！

6.為什么國(guó)內(nèi) 996 干不過國(guó)外的 955呢？

7.這封“領(lǐng)導(dǎo)痛批95后下屬”的郵件，句句扎心！

8.15張圖看懂瞎忙和高效的區(qū)別！