目录

0、官方文档

一、引入依赖

二、application.yml文件中开启监控

三、具体使用

四、具体细节使用

五、端点开启与禁用

 六、定制Endpoint

1. 定制 /actuator/health 

 2. 定制 /actuator/info

(1)直接在配置文件中写死

(2)从pom文件中读取信息

 (3)代码实现

3. 定制metrics

七. 新增自己的监控端点 


0、官方文档

Spring Boot Actuator: Production-ready Features

一、引入依赖

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

二、application.yml文件开启监控

management:
  endpoints:
    enabled-by-default: true #暴露所有端点信息
    web:
      exposure:
        include: "*"  #以web方式暴露

三、具体使用

1. 查看可以监控哪些信息:

localhost:8080/actuator/

2. 根据1中查出来的结果可以监控具体的信息,比如: 

http://localhost:8080/actuator/health 【查看系统健康状态

localhost:8080/actuator/beans 【查看系统中所有的bean组件

localhost:8080/actuator/conditions 【查看系统激活组件,如下图

localhost:8080/actuator/configprops 【查看系统配置属性,如下图

localhost:8080/actuator/env 【查看系统环境变量

localhost:8080/actuator/metrics/  【查看系统可以监控哪些指标信息,即系统运行指标

根据上面查出来的指标,再具体查看每个指标详细信息比如下图查看系统CPU利用指标

localhost:8080/actuator/metrics/system.cpu.usage

四、具体细节使用

比如我现在直接想查看系统是否健康可以直接发送

 localhost:8080/actuator/health

这个请求,如下图默认返回的信息,只显示一个汇总后的结果告诉我们当前服务什么状态

 但是我想的服务配置了很多东西,比如数据库redis, mq组件,我想知道它们每一个健康状态可以配置文件针对每个监控端点进行更详细配置如下

如上配置好了以后,重新启动项目,再次查看 /actuator/health 端点,返回如下信息:

 

五、端点开启禁用

1. 直接使用如下方式默认开启所有监控端点,但是某些包含敏感信息的端点我们不想开启,而只想开启某些监控端点,该怎么办呢?

management:
  endpoints:
    enabled-by-default: true #暴露所有端点信息
    web:
      exposure:
        include: "*"  #以web方式暴露

把上面的配置改成如下方式,即单独针对一个监控端点的开启禁用进行控制

management:
  endpoints:
    enabled-by-default: false#关闭所有端点监控功能
    web:
      exposure:
        include: "*"  #以web方式暴露
  endpoint:
    health:
      show-details: always
      enabled: true
      
    info:
      enabled: true
    
    metrics:
      enabled: true

重启项目,再次查看监控端点信息,如下(只能看到我们想让你看到的监控信息):

 

同样的,在jconsole里面,也是只能看到这些信息,如下图:

在DOS命令行输入 jconsole就可以直接打开jconsole控制台

 六、定制Endpoint

说明这里定制端点是在SpringBoot已有的端点中,添加我们自己定制的一些信息,并没有新增监控端点(新增监控端点,看第7节)

1. 定制 /actuator/healt

比如在访问 http://localhost:8080/actuator/health 时,默认显示系统判断的那些组件的健康状态,如果我们自己添加一个 端点(组件)的健康状态,按照如下做法:

 2. 定制 /actuator/info

直接使用 http://localhost:8080/actuator/info时,输入的信息为空,那么我们如果想在页面展示一些项目基本信息,比如项目名称项目版本等信息该如何做呢,有如下三种办法:

(1)直接在配置文件中写

        如下图:

info:
  appName: boot-admin
  appVersion: 1.0.0

(2)从pom文件读取信息

        采用(1)中的方法的缺点是我不想把项目的名称或者版本号写死,我想动态获取(比如从maven中动态获取当前项目的项目名称和版本,因为项目名称或者版本可能变动)。那么此时页可以直接在配置文件application.yml)中动态获取maven配置文件pom.xml)中的一些基本信息,如下:

重启项目,访问 http://localhost:8080/actuator/info结果如下图:

 (3)代码实现

        第二种方式可以获取项目的一些基本信息,并且不是写死的,而是从pom文件中自动获取的,但是某些信息只能通过发送请求时,在代码里面进行逻辑处理完成之后才能获取,所以就引入了第三种方式,即通过代码实现获取一些项目相关的信息,代码实现如下:

package com.shg.admin.acutuator.info;

import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.stereotype.Component;

import java.util.Collections;

@Component
public class AppInfoInfoContributor implements InfoContributor {


    @Override
    public void contribute(Info.Builder builder) {

        builder.withDetail("msg","你好")
                .withDetail("hello","shg")
                .withDetails(Collections.singletonMap("world","666"));
    }
}

重启项目,访问 http://localhost:8080/actuator/info,结果如下图:

3. 定制metrics

        SpringBoot默认给我们的定制信息如下图:

 上述这些默认指标信息不一定能满足我们的需求,比如我就想单独监控某个 Controller对应的URL被请求次数,此时就需要定义一个mertics添加现有metrics中:

需求:比如我想统计 CityService里面selectListCity这个方法调用多少次。代码如下:

 

请求Controller的     localhost:8080/city/list 方法后,查询具体的指标如下,可以看到  CityService里面selectListCity这个方法已经被调用了6次。

七. 新增自己的监控端点 

SpringBoot给我们提供的监控端点就是在其官方文档里面的那些:

Spring Boot Actuator: Production-ready Features

如果我们自己想新增一些监控端点,该怎么做呢?代码如下:

重启项目,直接访问localhost:8080/actuator/ 结果如下:

 访问我们自定的端点,结果如下:

新增自己的监控端点后,通过jconsole里面也可以看到新增的监控端点,如下图;

原文地址:https://blog.csdn.net/qq_23388169/article/details/134758362

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任

如若转载,请注明出处:http://www.7code.cn/show_35964.html

如若内容造成侵权/违法违规/事实不符,请联系代码007邮箱suwngjj01@126.com进行投诉反馈,一经查实,立即删除

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注