SpringBoot使用prometheus监控

Myth丶恋晨 2022-03-11 05:15 298阅读 0赞

> 本文介绍SpringBoot如何使用Prometheus配合Grafana监控。

# 1.关于Prometheus #

Prometheus是一个根据应用的metrics来进行监控的开源工具。相信很多工程都在使用它来进行监控，有关详细介绍可以查看官网：[https://prometheus.io/docs/introduction/overview/][https_prometheus.io_docs_introduction_overview]。

# 2.有关Grafana #

Grafana是一个开源监控利器，如图所示。

![1][]

从图中就可以看出来，使用Grafana监控很高大上，提供了很多可视化的图标。

官网地址：[https://grafana.com/][https_grafana.com]

# 3.SpringBoot使用Prometheus #

## 3.1 依赖内容 ##

在SpringBoot中使用Prometheus其实很简单，不需要配置太多的东西，在pom文件中加入依赖，完整内容如下所示。

<?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>2.1.3.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.dalaoyang</groupId>
    	<artifactId>springboot2_prometheus</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>springboot2_prometheus</name>
    	<description>springboot2_prometheus</description>
    
    	<properties>
    		<java.version>1.8</java.version>
    	</properties>
    
    	<dependencies>
    		<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.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    		<dependency>
    			<groupId>io.micrometer</groupId>
    			<artifactId>micrometer-registry-prometheus</artifactId>
    			<version>1.1.3</version>
    		</dependency>
    	</dependencies>
    
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    </project>

## 3.2 配置文件 ##

配置文件中加入配置，这里就只进行一些简单配置，management.metrics.tags.application属性是本文配合Grafana的Dashboard设置的，如下所示：

spring.application.name=springboot_prometheus
    management.endpoints.web.exposure.include=*
    management.metrics.tags.application=${spring.application.name}

## 3.3 设置application ##

修改启动类，如下所示.

@SpringBootApplication
    public class Springboot2PrometheusApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(Springboot2PrometheusApplication.class, args);
    	}
    	@Bean
    	MeterRegistryCustomizer<MeterRegistry> configurer(
    			@Value("${spring.application.name}") String applicationName) {
    		return (registry) -> registry.config().commonTags("application", applicationName);
    	}
    }

SpringBoot项目到这里就配置完成了，启动项目，访问[http://localhost:8080/actuator/prometheus][http_localhost_8080_actuator_prometheus]，如图所示，可以看到一些度量指标。

![2][]

# 4.Prometheus配置 #

## 4.1 配置应用 ##

在prometheus配置监控我们的SpringBoot应用，完整配置如下所示。

# my global config
    global:
      scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
      evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
      # scrape_timeout is set to the global default (10s).
    
    # Alertmanager configuration
    alerting:
      alertmanagers:
      - static_configs:
        - targets:
          # - alertmanager:9093
    
    # Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
    rule_files:
      # - "first_rules.yml"
      # - "second_rules.yml"
    
    # A scrape configuration containing exactly one endpoint to scrape:
    # Here it's Prometheus itself.
    scrape_configs:
      - job_name: 'prometheus'
        static_configs:
        - targets: ['127.0.0.1:9090']
    ###以下内容为SpringBoot应用配置
      - job_name: 'springboot_prometheus'
        scrape_interval: 5s
        metrics_path: '/actuator/prometheus'
        static_configs:
          - targets: ['127.0.0.1:8080']

## 4.2 启动Prometheus ##

启动Prometheus，浏览器访问，查看Prometheus页面，如图所示。

![3][]

点击如图所示位置，可以查看Prometheus监控的应用。

![4][]

列表中UP的页面为存活的实例，如图所示。

![5][]

也可以查看很多指数，如下所示。

![6][]

# 5.Grafana配置 #

启动Grafana，配置Prometheus数据源，这里以ID是4701的Doshboard为例（地址：[https://grafana.com/dashboards/4701][https_grafana.com_dashboards_4701]）如图。

![7][]

在Grafana内点击如图所示import按钮

![8][]

在如图所示位置填写4701，然后点击load。

![9][]

接下来导入Doshboard。

![10][]

导入后就可以看到我们的SpringBoot项目对应的指标图表了，如图。

![11][]

# 6.源码 #

源码地址：[https://gitee.com/dalaoyang/springboot\_learn/tree/master/springboot2\_prometheus][https_gitee.com_dalaoyang_springboot_learn_tree_master_springboot2_prometheus]

[https_prometheus.io_docs_introduction_overview]: https://prometheus.io/docs/introduction/overview/
[1]: /images/20220311/c04f2b4019ce4c66b6a033c4a0ee12c4.png
[https_grafana.com]: https://grafana.com/
[http_localhost_8080_actuator_prometheus]: http://localhost:8080/actuator/prometheus
[2]: /images/20220311/3504241349e448b68ee2f5c24e4e1195.png
[3]: /images/20220311/e9589985c5ba4c009cb1b1b870f49f2d.png
[4]: /images/20220311/4814101d2dd54a2993d72c7bf30bb81c.png
[5]: /images/20220311/abbbda6277624997864c04f70b6671d3.png
[6]: /images/20220311/5a7d86daf102478cb304e5d0d5d9dff3.png
[https_grafana.com_dashboards_4701]: https://grafana.com/dashboards/4701
[7]: /images/20220311/f1290facfc86440295513772869a0c50.png
[8]: /images/20220311/1c6e231285df4db7a2f052127104e0e4.png
[9]: /images/20220311/c7982c6d24a54c8aa4561d7e9f37fcf5.png
[10]: /images/20220311/c04f2b4019ce4c66b6a033c4a0ee12c4.png0
[11]: /images/20220311/c04f2b4019ce4c66b6a033c4a0ee12c4.png1
[https_gitee.com_dalaoyang_springboot_learn_tree_master_springboot2_prometheus]: https://gitee.com/dalaoyang/springboot_learn/tree/master/springboot2_prometheus