Springboot整合Prometheus

依赖

// actuator依赖提供指标

  org.springframework.boot
  spring-boot-starter-actuator
  2.6.3


// 将指标转换成prometheus可使用的格式

  io.micrometer
  micrometer-registry-prometheus
  1.8.2

1
2
3
4
5
6
7
8
9
10
11
12
13

SpringBootActuator默认开放指标

1、以下指标名称都为prometheus接收的指标名称
2、http://ip:port/actuator/prometheus 此为prometheus默认开放接口，输出prometheus格式
3、http://localhost:11130/actuator/metrics 此为actuator的指标接口，输出当前开放的指标
1
2
3

JVM 指标

自动配置通过使用核心 Micrometer 类启用 JVM Metrics。JVM 指标以jvm.计量名称发布。

提供了以下 JVM 指标：

• 各种内存和缓冲池细节（ jvm_buffer开头 ）
• 垃圾回收相关统计（ jvm_gc开头 ）
• 线程利用率（ jvm_threads开头 ）
• 加载和卸载的类数（ jvm_classes开头 ）

系统指标

自动配置通过使用核心 Micrometer 类启用系统指标。

提供了以下系统指标：

• CPU 指标（ system_cpu开头 ）
• 文件描述符指标
• 正常运行时间指标（ process开头 ）
• 可用磁盘空间（ disk_开头 ）

应用程序启动指标

自动配置公开应用程序启动时间指标：

• 启动应用程序所用的时间 （ application_started_time_seconds ）
• 应用程序准备好为请求提供服务所需的时间 ( application_ready_time_seconds )

记录器指标

自动配置公开 Logback 和 Log4J2 启用事件指标。

• log4j2_events开头
• logback_events开头

任务执行和调度指标

自动配置识别公开 ThreadPoolTaskExecutor 和ThreadPoolTaskScheduler beans执行。指标包含执行者的名称标记，该名称来自 bean 名称。

• executor开头

Spring MVC 指标

自动配置启用对 Spring MVC 控制器和功能处理程序处理的所有请求的检测。

• 请求指标（ http_server_requests开头）

可以通过management.metrics.web.server.request.metric-name属性来自定义指标开头。

@Timed注解可以标注在@Controller类和@RequestMapping方法上，如果你不想记录所有 Spring MVC 请求的指标，则可以设置management.metrics.web.server.request.autotime.enabled=false然后单独使用@Timed标注需要开放的请求

默认情况下，与 Spring MVC 相关的指标标记有以下信息：

如果要添加默认标签，请提供一个或多个@Bean实现WebMvcTagsContributor
如果要替换默认标签，请提供一个@Bean实现WebMvcTagsProvider
如果要处理所有请求，可以自定义过滤器，添加一个@Bean实现FilterRegistrationBean例如将4xx和5xx异常类型归为同一类

Spring WebFlux 指标

自动配置启用对 Spring WebFlux 控制器和功能处理程序处理的所有请求的检测。

• 请求指标（ http_server_requests开头）

可以通过management.metrics.web.server.request.metric-name属性来自定义指标开头。

@Timed注解可以标注在@Controller类和@RequestMapping方法上，如果你不想记录所有 Spring WebFlux 请求的指标，则可以设置management.metrics.web.server.request.autotime.enabled=false然后单独使用@Timed标注需要开放的请求

默认情况下，与 Spring WebFlux 相关的指标标记有以下信息：

如果要添加默认标签，请提供一个或多个@Bean实现WebFluxTagsContributor
如果要替换默认标签，请提供一个@Bean实现WebFluxTagsProvider

Jersey Server 指标

同 Spring MVC 和 Spring WebFlux类似

HTTP Client 指标

1、要让Spring Boot Actuator 管理RestTemplate和WebClient指标。必须使用自动配置的构建器构建实例，并注册为bean。（此方式需要将RestTemplate注册为Bean）

• RestTemplateBuilder可构建RestTemplate
• WebClient.Builder可构建WebClient

   @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        return builder.build();
    }
1
2
3
4

2、也可以构建时手动添加指标检测的定制器，即MetricsRestTemplateCustomizer和MetricsWebClientCustomizer。（此方式不需要将RestTemplate注册为Bean，并能对RestTemplate做定制化）

@Autowired
private MetricsRestTemplateCustomizer metricsRestTemplateCustomizer;
 
RestTemplate restTemplate = new RestTemplateBuilder()
                .additionalCustomizers(metricsRestTemplateCustomizer)
                .build();
1
2
3
4
5
6

• 请求指标（http_client_requests开头）

可以通过设置management.metrics.web.client.request.metric-name属性来自定义名称

默认情况下，与HTTP Client相关的指标标记有以下信息：

如果要自定义标签，需根据使用的客户端，提供一个@Bean实现RestTemplateExchangeTagsProvider 或者WebClientExchangeTagsProvider。底层使用RestTemplateExchangeTags和WebClientExchangeTags的静态函数设置标签内容。

示例：

@Autowired
private MeterRegistry meterRegistry;

// 此时会覆盖原来的标签
RestTemplateExchangeTagsProvider restTemplateExchangeTagsProvider = new RestTemplateExchangeTagsProvider() {
            @Override
            public Iterable getTags(String urlTemplate, HttpRequest request, ClientHttpResponse response) {
                // 此为默认实现
//                Tag uriTag = (StringUtils.hasText(urlTemplate) ? RestTemplateExchangeTags.uri(urlTemplate)
//                        : RestTemplateExchangeTags.uri(request));
//                return Arrays.asList(RestTemplateExchangeTags.method(request), uriTag,
//                        RestTemplateExchangeTags.status(response), RestTemplateExchangeTags.clientName(request),
//                        RestTemplateExchangeTags.outcome(response));
                
                // 指标key不能为中文。如果为中文，会转换成下划线。
                return Arrays.asList(Tag.of("tag1", "指标值"), Tag.of("tag2", "指标值"));
            }
        };

        RestTemplate restTemplate = new RestTemplateBuilder()
                .additionalCustomizers(
                        new MetricsRestTemplateCustomizer( // 自定义指标模板
                        meterRegistry, // 指标注册器
                        restTemplateExchangeTagsProvider, // 自定义标签
                        "http_client_requests12", // 自定义指标名
                        new AutoTimeProperties())) // Timer指标是否开启，null为不开启。此时须开启，因为Http自动配置的指标都为Timer统计的，后续会讲到。
                .build();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

结果：

Tomcat 指标

自动配置仅在启用时检测Tomcat 的MBeanRegistry是否启用。默认情况下，MBeanRegistry是禁用，但您可以通过设置server.tomcat.mbeanregistry.enabled=true启用它。

• 指标（ tomcat开头 ）

缓存指标

自动配置缓存在启动时检测所有可用实例的。

• 指标（cache开头）

缓存的基本指标进行了标准化。此外，还提供了特定缓存的指标。
支持以下缓存库：

• Cache2k
• Caffeine
• EhCache 2
• Hazelcast
• Any compliant JCache (JSR-107) implementation（所有基于JCache 规则实现的）
• Redis

指标名称由缓存的名称和CacheManager从 bean 名称派生的名称进行生成。

只有在启动时配置的缓存才会绑定到注册表。

对于未在启动时定义的缓存，例如动态创建的缓存或在启动阶段后以编程方式创建的缓存，需要显式注册。可以使用 CacheMetricsRegistrar 这个Bean进行便捷注册。

示例：

 	@Bean  //给容器注册一个Bean，返回缓存管理器,这里有redisTemplate容器，所以会自动注入
    public CacheManager MyRedisCacheConfig(RedisTemplate redisTemplate) {
        //1.创建RedisCacheWriter
        /**
         * 非锁方式：nonLockingRedisCacheWriter(RedisConnectionFactory connectionFactory);
         * 有锁方式：lockingRedisCacheWriter(RedisConnectionFactory connectionFactory);
         */
        RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(Objects.requireNonNull(redisTemplate.getConnectionFactory()));
        //2.创建Jackson对象并传入需要序列化的对象
        Jackson2JsonRedisSerializer