springboot + prometheus + grafana

安利一款好用的谷歌json格式化插件 jsonview,地址 https://jsonview.com/
搭建 springboot 项目 引入 actuator 组件

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

actuator 目的:监控并管理应用程序,详情见官方文档 https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready

一些常用的 Endpoint

id 说明 默认开启 默认HTTP 默认JMX
beans 显示容器的Bean Y N Y
health 显示健康信息 Y Y Y
info 应用信息 Y Y Y
cache 应用缓存 Y N Y

application.properties 配置打开所有监控

management.endpoints.web.exposure.include=*

浏览器输入 http://localhost:8080/actuator/health 打印

{
status: "UP"
}

进入 安装的JDK/bin 目录 ,cmd 输入 jconsole 可以看到 Actuator EndPoint 信息
Spring boot 健康检查 通过实现 HealthIndicator 接口

@FunctionalInterface
public interface HealthIndicator extends HealthContributor {

    default Health getHealth(boolean includeDetails) {
        Health health = health();
        return includeDetails ? health : health.withoutDetails();
    }
    Health health();

}

举个例子 数据库的健康检查 DataSourceHealthIndicator 类,构造的时候传入 DataSource

public DataSourceHealthIndicator(DataSource dataSource) {
        this(dataSource, null);
    }

健康检查

    @Override
    protected void doHealthCheck(Health.Builder builder) throws Exception {
        if (this.dataSource == null) {
            builder.up().withDetail("database", "unknown"); // 没有数据库 就当是健康的 并提示 unknown
        }
        else {
            doDataSourceHealthCheck(builder);
        }
    }

doDataSourceHealthCheck 方法判断当前数据库健康状态

    private void doDataSourceHealthCheck(Health.Builder builder) throws Exception {
        String product = getProduct(); // 什么数据库
        builder.up().withDetail("database", product);
        String validationQuery = getValidationQuery(product);
        try {
            // Avoid calling getObject as it breaks MySQL on Java 7
            List<Object> results = this.jdbcTemplate.query(validationQuery, new SingleColumnRowMapper()); // 通过 jdbcTemplate 查询
            Object result = DataAccessUtils.requiredSingleResult(results); // 取得结果
            builder.withDetail("result", result);
        }
        finally {
            builder.withDetail("validationQuery", validationQuery);
        }
    }

实现自己程序的健康状态 定义 HealthIndicatorTest

@Component
public class HealthIndicatorTest implements HealthIndicator {

    @Override
    public Health health() {
        Map<String,Object> map = new HashMap<>();
        // 这里根据你的业务逻辑去判断
        map.put("血压","正常");
        map.put("体重",120);
        return Health.up().withDetails(map).build();
    }
}

浏览器输入 http://localhost:8080/actuator/health 查看结果

healthIndicatorTest: {
status: "UP",
details: {
  体重: 120,
  血压: "正常"
  }
}

上面通过 Actuator Health 了解程序是否健康,在程序中还需要收集更多的度量指标,比如操作系统 或者 JVM、业务指标 等,通过 Micrometer 收集这些信息,官方网站 https://micrometer.io/ ,应用在 Spring Boot, 查看文档 https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-metrics

利用 Micrometer 后端埋点 统计接口请求次数
pom 引入组件

    <dependency>
            <groupId>io.micrometer</groupId>
            <artifactId>micrometer-registry-prometheus</artifactId>
        </dependency>

新建 Test

@RestController
@RequestMapping("/test")
@Slf4j
public class Test implements MeterBinder {

    private Counter counter;

    @GetMapping(path = "/")
    public String test() {
        counter.increment(); // 埋点
        return "";
    }

    @Override
    public void bindTo(MeterRegistry registry) {
        this.counter = this.counter = registry.counter("counter.number");
    }
}

浏览器 输入 http://localhost:8081/test/ 请求服务
输入 http://localhost:8081/actuator/metrics/counter.number 查看请求次数

{
name: "counter.number",
description: null,
baseUnit: null,
measurements: [
{
statistic: "COUNT",
value: 1
}
],
availableTags: [ ]
}

windows 安装 grafana ,地址 : https://grafana.com/grafana/download?platform=windows
安装之后,打开 \grafana\conf 文件 查看配置

  • 默认配置文件是在/conf/defaults.ini
  • 用户配置文件是在/conf/custom.ini
    更改 端口
[server]
http_port = 8888

更改 账号密码

[security]

# default admin user, created on startup
admin_user = admin

# default admin password, can be changed before first start of grafana, or in profile settings
admin_password = admin

进入目录 grafana\bin 运行 grafana-server.exe
浏览器输入 http://localhost:8888/ ,输入 admin admin

捕获.PNG

windows 安装 prometheus ,地址 :https://prometheus.io/download/
配置 任务和实例,打开 prometheus.yml 文件,详情见 任务和实例

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'.
    
    metrics_path: '/actuator/prometheus'

    static_configs:
    - targets: ['localhost:8080']
    
  - job_name: 'node'

    # metrics_path defaults to '/metrics'
    # scheme defaults to 'http'.
    
    static_configs:
    - targets: ['localhost:9182']

浏览器输入 http://localhost:9090/targetsprometheus 默认端口 9090,看到这两个实例都是 down 状态

捕获.PNG

了解下 prometheus 架构,prometheus 主要是通过定时拉取应用程序中暴露的时间序列进行工作的,可以在 prometheus.yml 文件配置 Jobs/Exporters

architecture.png

为什么要监控应用程序的各个指标,推荐文章 度量驱动开发 感兴趣的可以看下

springboot 引入 micrometer-jvm-extras 组件,查看 JVM 相关信息

        <dependency>
            <groupId>io.github.mweirauch</groupId>
            <artifactId>micrometer-jvm-extras</artifactId>
            <version>0.1.4</version>
        </dependency>

启动项目,看到 springboot 项目实例 状态是 up

捕获.PNG

点击 Endpoint 可以看到 JVM 各项指标

捕获.PNG

通过 grafana 图形化展示,JVM 堆内存 进程内存 HTTP请求持续时间 详情见 4701 指标
https://grafana.com/grafana/dashboards

捕获.PNG

参考文章
Spring Boot Actuator:健康检查、审计、统计和监控
Spring Boot Metrics监控之Prometheus&Grafana

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容