增加 actuate 示例

roydonGuo · Dec 20, 2019 · c5fd04b · c5fd04b
1 parent 66ec3e1
commit c5fd04b
Show file tree

Hide file tree

Showing 13 changed files with 193 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@
 
 * [《芋道 Spring Boot 安全框架 Spring Security 入门》](http://www.iocoder.cn/Spring-Boot/Spring-Security/?github) 对应 [lab-01](https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-01) 。
 * [《芋道 Spring Boot 授权框架 Spring Security OAuth2 入门》](http://www.iocoder.cn/Spring-Security/OAuth2-learning/?github) 对应 [lab-02](https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-02) 。
-* 《芋道 Spring Boot Shiro 入门》计划中...
+* [《芋道 Spring Boot 安全框架 Shiro 入门》](http://www.iocoder.cn/Spring-Boot/Shiro/?github) 对应 [lab-33](https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-33) 。
 
 ## 定时任务与异步任务
 
@@ -51,6 +51,10 @@
 * [《芋道 Spring Boot 消息队列 RabbitMQ 入门》](http://www.iocoder.cn/Spring-Boot/RabbitMQ/?github) 对应 [lab-04](https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-04) 。
 * [《芋道 Spring Boot 消息队列 ActiveMQ 入门》](http://www.iocoder.cn/Spring-Boot/ActiveMQ/?github) 对应 [lab-32](https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-32) 。
 
+## 监控管理
+
+
+
 ## 性能测试
 
 * [《性能测试 —— Tomcat、Jetty、Undertow 基准测试》](http://www.iocoder.cn/Performance-Testing/Tomcat-Jetty-Undertow-benchmark/?github) 对应 [lab-05](https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-05) 。
@@ -65,10 +69,6 @@
 
 如下是草稿目录，未来需要整理下
 
-# lab-01
-
-空
-
 # lab-05
 
 TODO

diff --git a/...bitmq-demo-orderly/target/classes/META-INF/lab-04-rabbitmq-demo-concurrency.kotlin_module b/...bitmq-demo-orderly/target/classes/META-INF/lab-04-rabbitmq-demo-concurrency.kotlin_module
diff --git a/...-demo-orderly/target/test-classes/META-INF/lab-04-rabbitmq-demo-concurrency.kotlin_module b/...-demo-orderly/target/test-classes/META-INF/lab-04-rabbitmq-demo-concurrency.kotlin_module
diff --git a/lab-34/lab-34-actuator-demo-health/pom.xml b/lab-34/lab-34-actuator-demo-health/pom.xml
@@ -0,0 +1,29 @@
+<?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">
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.2.2.RELEASE</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>lab-34-actuator-demo-health</artifactId>
+
+    <dependencies>
+        <!-- 实现对 Spring MVC 的自动化配置 -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <!-- 实现对 Actuator 的自动化配置 -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/...uator-demo-health/src/main/java/cn/iocoder/springboot/lab34/actuatordemo/Application.java b/...uator-demo-health/src/main/java/cn/iocoder/springboot/lab34/actuatordemo/Application.java
@@ -0,0 +1,13 @@
+package cn.iocoder.springboot.lab34.actuatordemo;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}
diff --git a/...h/src/main/java/cn/iocoder/springboot/lab34/actuatordemo/actuate/DemoHealthIndicator.java b/...h/src/main/java/cn/iocoder/springboot/lab34/actuatordemo/actuate/DemoHealthIndicator.java
@@ -0,0 +1,29 @@
+package cn.iocoder.springboot.lab34.actuatordemo.actuate;
+
+import org.springframework.boot.actuate.health.AbstractHealthIndicator;
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.stereotype.Component;
+
+@Component
+public class DemoHealthIndicator extends AbstractHealthIndicator {
+
+    @Override
+    protected void doHealthCheck(Health.Builder builder) {
+        // 较差是否健康
+        boolean success = checkSuccess();
+
+        // 如果健康，则标记状态为 UP
+        if (success) {
+            builder.up().build();
+            return;
+        }
+
+        // 如果不健康，则标记状态为 DOWN
+        builder.down().withDetail("msg", "我就是做个示例而已");
+    }
+
+    private boolean checkSuccess() {
+        return false;
+    }
+
+}
diff --git a/lab-34/lab-34-actuator-demo-health/src/main/resources/application.yaml b/lab-34/lab-34-actuator-demo-health/src/main/resources/application.yaml
@@ -0,0 +1,23 @@
+management:
+  endpoint:
+    # Health 端点配置项，对应 HealthProperties 配置类
+    health:
+      enabled: true # 是否开启。默认为 true 开启。
+      show-details: ALWAYS # 何时显示完整的健康信息。默认为 NEVER 都不展示。可选 WHEN_AUTHORIZED 当经过授权的用户；可选 ALWAYS 总是展示。
+      status:
+        http-mapping: # 设置不同健康状态对应的响应状态码
+          DOWN: 403
+  health:
+    # DiskSpaceHealthIndicator 配置项，对应 DiskSpaceHealthIndicatorProperties
+    diskspace:
+      enabled: true # 是否开启。默认为 true 开启。
+      path: . # 目录。默认为 . 当前目录。
+      threshold: # 剩余空间的阀值。默认为 10M 。
+  endpoints:
+    # Actuator HTTP 配置项，对应 WebEndpointProperties 配置类
+    web:
+      base-path: /actuator # Actuator 提供的 API 接口的根目录。默认为 /actuator
+      exposure:
+        include: '*' # 需要开放的端点。默认值只打开 health 和 info 两个端点。通过设置 * ，可以开放所有端点。
+        exclude: # 在 include 的基础上，需要排除的端点。通过设置 * ，可以排除所有端点。
+
diff --git a/lab-34/lab-34-actuator-demo-health/target/classes/application.yaml b/lab-34/lab-34-actuator-demo-health/target/classes/application.yaml
@@ -0,0 +1,23 @@
+management:
+  endpoint:
+    # Health 端点配置项，对应 HealthProperties 配置类
+    health:
+      enabled: true # 是否开启。默认为 true 开启。
+      show-details: ALWAYS # 何时显示完整的健康信息。默认为 NEVER 都不展示。可选 WHEN_AUTHORIZED 当经过授权的用户；可选 ALWAYS 总是展示。
+      status:
+        http-mapping: # 设置不同健康状态对应的响应状态码
+          DOWN: 403
+  health:
+    # DiskSpaceHealthIndicator 配置项，对应 DiskSpaceHealthIndicatorProperties
+    diskspace:
+      enabled: true # 是否开启。默认为 true 开启。
+      path: . # 目录。默认为 . 当前目录。
+      threshold: # 剩余空间的阀值。默认为 10M 。
+  endpoints:
+    # Actuator HTTP 配置项，对应 WebEndpointProperties 配置类
+    web:
+      base-path: /actuator # Actuator 提供的 API 接口的根目录。默认为 /actuator
+      exposure:
+        include: '*' # 需要开放的端点。默认值只打开 health 和 info 两个端点。通过设置 * ，可以开放所有端点。
+        exclude: # 在 include 的基础上，需要排除的端点。通过设置 * ，可以排除所有端点。
+
diff --git a/lab-34/lab-34-actuator-demo/pom.xml b/lab-34/lab-34-actuator-demo/pom.xml
@@ -0,0 +1,29 @@
+<?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">
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.2.2.RELEASE</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>lab-34-acturator-demo</artifactId>
+
+    <dependencies>
+        <!-- 实现对 Spring MVC 的自动化配置 -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <!-- 实现对 Actuator 的自动化配置 -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/...-34-actuator-demo/src/main/java/cn/iocoder/springboot/lab34/actuatordemo/Application.java b/...-34-actuator-demo/src/main/java/cn/iocoder/springboot/lab34/actuatordemo/Application.java
@@ -0,0 +1,13 @@
+package cn.iocoder.springboot.lab34.actuatordemo;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}
diff --git a/lab-34/lab-34-actuator-demo/src/main/resources/application.yaml b/lab-34/lab-34-actuator-demo/src/main/resources/application.yaml
@@ -0,0 +1,8 @@
+management:
+  endpoints:
+    # Actuator HTTP 配置项，对应 WebEndpointProperties 配置类
+    web:
+      base-path: /actuator # Actuator 提供的 API 接口的根目录。默认为 /actuator
+      exposure:
+        include: '*' # 需要开放的端点。默认值只打开 health 和 info 两个端点。通过设置 * ，可以开放所有端点。
+        exclude: # 在 include 的基础上，需要排除的端点。通过设置 * ，可以排除所有端点。
diff --git a/lab-34/pom.xml b/lab-34/pom.xml
@@ -0,0 +1,20 @@
+<?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">
+    <parent>
+        <artifactId>labs-parent</artifactId>
+        <groupId>cn.iocoder.springboot.labs</groupId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>lab-34</artifactId>
+    <packaging>pom</packaging>
+    <modules>
+        <module>lab-34-actuator-demo</module>
+        <module>lab-34-actuator-demo-health</module>
+    </modules>
+
+
+</project>
diff --git a/pom.xml b/pom.xml
@@ -42,6 +42,7 @@
         <module>lab-31</module>
         <module>lab-32</module>
         <module>lab-33</module>
+        <module>lab-34</module>
     </modules>