SpringBoot技术实践-actuator监控

灰太狼 2022-08-31 06:47 350阅读 0赞

### 文章目录 ###

*  一、actuator介绍
 *  二、搭建actuator环境
 *  三、拓展health监控端点
 *  四、自定义监控端点

# 一、actuator介绍 #

1.  actuator是Springboot提供的用来对应用系统进行自省和监控的功能模块，借助于actuator开发者可以很方便地对应用系统某些监控指标进行查看、统计等
2.  参考文档：[https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/\#production-ready][https_docs.spring.io_spring-boot_docs_current_reference_htmlsingle_production-ready]

# 二、搭建actuator环境 #

1.  新建springboot项目，添加maven依赖

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

1.  启动项目，访问地址为
    
     *  访问所有：http://ip:port/actuator
     *  访问单个：http://ip:port/actuator/endpoint
     *  然后会以json的形式返回支持的端点(监控点)的访问地址

{ 
    	"_links": { 
    		"self": { 
    			"href": "http://localhost:8426/actuator",
    			"templated": false
    		},
    		"health": { 
    			"href": "http://localhost:8426/actuator/health",
    			"templated": false
    		},
    		"health-path": { 
    			"href": "http://localhost:8426/actuator/health/{*path}",
    			"templated": true
    		},
    		"info": { 
    			"href": "http://localhost:8426/actuator/info",
    			"templated": false
    		}
    	}
    }

1.  默认情况下只开启了health和info端点的对外访问，如果开启所有端点访问需要做以下配置

management:
      endpoint:
        health:
          # 显示健康信息，不开启健康节点只会显示状态信息
          show-details: ALWAYS
        shutdown:
          # 开启post关闭：http://ip:port/actuator/shutdown
          enabled: true
      endpoints:
        web:
          exposure:
            # 指定暴露所有端点，默认是info,health
            #include: info,health
            # 配置*暴露所有端点，也可以使用单引号
            include: "*"

1.  重新访问即可显示所有端点

{ 
    	"_links": { 
    		"self": { 
    			"href": "http://localhost:8426/actuator",
    			"templated": false
    		},
    		"beans": { 
    			"href": "http://localhost:8426/actuator/beans",
    			"templated": false
    		},
    		"caches-cache": { 
    			"href": "http://localhost:8426/actuator/caches/{cache}",
    			"templated": true
    		},
    		"caches": { 
    			"href": "http://localhost:8426/actuator/caches",
    			"templated": false
    		},
    		"health": { 
    			"href": "http://localhost:8426/actuator/health",
    			"templated": false
    		},
    		"health-path": { 
    			"href": "http://localhost:8426/actuator/health/{*path}",
    			"templated": true
    		},
    		"info": { 
    			"href": "http://localhost:8426/actuator/info",
    			"templated": false
    		},
    		"conditions": { 
    			"href": "http://localhost:8426/actuator/conditions",
    			"templated": false
    		},
    		"shutdown": { 
    			"href": "http://localhost:8426/actuator/shutdown",
    			"templated": false
    		},
    		"configprops": { 
    			"href": "http://localhost:8426/actuator/configprops",
    			"templated": false
    		},
    		"env": { 
    			"href": "http://localhost:8426/actuator/env",
    			"templated": false
    		},
    		"env-toMatch": { 
    			"href": "http://localhost:8426/actuator/env/{toMatch}",
    			"templated": true
    		},
    		"loggers": { 
    			"href": "http://localhost:8426/actuator/loggers",
    			"templated": false
    		},
    		"loggers-name": { 
    			"href": "http://localhost:8426/actuator/loggers/{name}",
    			"templated": true
    		},
    		"heapdump": { 
    			"href": "http://localhost:8426/actuator/heapdump",
    			"templated": false
    		},
    		"threaddump": { 
    			"href": "http://localhost:8426/actuator/threaddump",
    			"templated": false
    		},
    		"metrics": { 
    			"href": "http://localhost:8426/actuator/metrics",
    			"templated": false
    		},
    		"metrics-requiredMetricName": { 
    			"href": "http://localhost:8426/actuator/metrics/{requiredMetricName}",
    			"templated": true
    		},
    		"scheduledtasks": { 
    			"href": "http://localhost:8426/actuator/scheduledtasks",
    			"templated": false
    		},
    		"mappings": { 
    			"href": "http://localhost:8426/actuator/mappings",
    			"templated": false
    		}
    	}
    }

1.  例如访问health信息
    
     *  [http://localhost:8426/actuator/health][http_localhost_8426_actuator_health]

{ 
        "status": "UP",
        "components": { 
            "diskSpace": { 
                "status": "UP",
                "details": { 
                    "total": 153276153856,
                    "free": 107921981440,
                    "threshold": 10485760
                }
            },
            "ping": { 
                "status": "UP"
            }
        }
    }

# 三、拓展health监控端点 #

1.  默认端点只有上面的端点信息，如果想要拓展端点信息则可以自定义或者拓展已有的端点信息
2.  需要继承**AbstractHealthIndicator**指示器，然后加上\*\*@Component\*\*加入容器
3.  继承类名称需要注意，如果是**XxxHealthIndicator**也就是结尾是**HealthIndicator**的注入监控的名称为xxx，首字母小写；如果非此结尾的则以类名首字母小写加入端点

import org.springframework.boot.actuate.health.AbstractHealthIndicator;
    import org.springframework.boot.actuate.health.Health;
    import org.springframework.stereotype.Component;
    
    @Component
    public class ExtendHealthIndicator extends AbstractHealthIndicator { 
        @Override
        protected void doHealthCheck(Health.Builder builder) throws Exception { 
            builder.up().withDetail("website", "www.codecoord.com");
            // builder.down().withDetail("website", "www.codecoord.com");
        }
    }

1.  重新启动，然后访问健康端点，此时可以看到新加的信息
    
     *  类名非**HealthIndicator**结尾所以类名首字母小写加入监控端点，此处为**XxxHealthIndicator**结尾情形

{ 
    	"status": "UP",
    	"components": { 
    		"diskSpace": { 
    			"status": "UP",
    			"details": { 
    				"total": 214750457856,
    				"free": 213597241344,
    				"threshold": 10485760,
    				"exists": true
    			}
    		},
    		"extend": { 
    			"status": "UP",
    			"details": { 
    				"website": "www.codecoord.com"
    			}
    		},
    		"ping": { 
    			"status": "UP"
    		}
    	}
    }

1.  更多监控指示器

![3aa24895249d5ea6954b9619b0b018db.png][]

# 四、自定义监控端点 #

1.  除了拓展端点，也可以自定义端口
2.  自定义端点类上需要使用\*\*@Endpoint(id = “name”)**注解，标识端点名称，然后同样需要注解**@Component \*\*将类加入spring
3.  在监控的方法上需要加上\*\*@ReadOperation \*\*, 可以通过GET方法进行调用
    
     *  http://localhost:9999/actuator/advanced

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
    import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
    import org.springframework.stereotype.Component;
    
    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    @Component
    @Endpoint(id = "advanced")
    public class ExtendsEndPoint { 
        @ReadOperation
        public List<Map<String, Object>> advancedHealth() { 
            List<Map<String, Object>> detailList = new ArrayList<>();
            Map<String, Object> detailMap = new HashMap<>(10);
            detailMap.put("name", "advanced");
            detailMap.put("desc", "自定义端点信息");
            detailMap.put("impl-类", "类使用注解@Endpoint(id = \"xxx\")");
            detailMap.put("impl-方法注解", "类使用注解@Endpoint(id = \"xxx\")");
            detailMap.put("impl-方法返回值类型", "方法返回值：@ReadOperation");
            detailMap.put("impl-参考", "com.codecoord.springboot.practice.actuator.ExtendsEndPoint");
            detailList.add(detailMap);
            return detailList;
        }
    }

1.  访问新端点
    
     *  [http://localhost:8426/actuator/advanced][http_localhost_8426_actuator_advanced]

[
    	{ 
    		"impl-方法注解": "类使用注解@Endpoint(id = \"xxx\")",
    		"name": "advanced",
    		"impl-参考": "com.codecoord.springboot.practice.actuator.ExtendsEndPoint",
    		"impl-方法返回值类型": "方法返回值：@ReadOperation",
    		"desc": "自定义端点信息",
    		"impl-类": "类使用注解@Endpoint(id = \"xxx\")"
    	}
    ]

[https_docs.spring.io_spring-boot_docs_current_reference_htmlsingle_production-ready]: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready
[http_localhost_8426_actuator_health]: http://localhost:8426/actuator/health
[3aa24895249d5ea6954b9619b0b018db.png]: /images/20220829/c988ee93ad9440429781e690ea67bd76.png
[http_localhost_8426_actuator_advanced]: http://localhost:8426/actuator/advanced