spring-boot-actuator 微服务监控_/actuator/metrics默认密码

随着业务越来越复杂，从原来的单体架构向微服务架构跃进，微服务稍微一多，可控的因素就会变少，当出现问题的时候查起来的时候就比较麻烦，所以微服务监控就变得很有必要。一旦微服务出点差错，就会影响业务的进行，轻者流失部分利润，重则这个系统瘫痪，无法正常使用。因此，微服务的各项指标正常就至关重要。
像微服务的正常运行访问、使用内存情况、占用CPU多少，组件控件的使用情况等，监控各项指标，微服务现在主流还是Springboot，可以结合spring-boot-actuator框架来完成监控任务，spring-boot-actuator提供很多微服务的端点，可以通过Http接口访问来查看微服务的信息。

spring-actuator

项目依赖

Springboot项目可以使用spring-boot-starter-actuator包依赖
maven依赖如下：

<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-actuator</artifactId>
	</dependency>
</dependencies>
1
2
3
4
5
6

gradle依赖如下：

dependencies {
	compile("org.springframework.boot:spring-boot-starter-actuator")
}
1
2
3

端点

引用spring-boot-actuator包后，会提供默认的一些端口给使用者访问，访问方式有JMX和HTTP。JMX现在用的比较少，所以就说说HTTP的一些端点情况。访问的方式HTTP默认是/actuator/health的方式进行访问，这个前缀是通过配置修改的。

endpoint端点介绍

actuator的核心就是endpoint，每项endpoint都代表监控着某一项数据

开启端点方式：
通过management.endpoint.<id>.enabled 方式进行开启或关闭，例如：

management.endpoint.shutdown.enabled=true
1

如果您希望端点启用为opt-in而不是opt-out，则设置management.endpoints。默认启用的属性为false，并使用单个端点启用的属性来选择返回。下面的示例启用info端点并禁用所有其他端点:

management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true
1
2

*可用于选择所有端点。例如，要通过HTTP公开除了env和bean端点之外的所有内容，请使用以下属性:

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans
1
2

我使用的是Springboot2.0.2.release版本。启动微服务访问http://127.0.0.1:8080/actuator，返回的结果如下：

使用默认配置返回信息：

{
  "_links": {
    "self": {
      "href": "http://127.0.0.1:8080/actuator",
      "templated": false
    },
    "health": {
      "href": "http://127.0.0.1:8080/actuator/health",
      "templated": false
    },
    "info": {
      "href": "http://127.0.0.1:8080/actuator/info",
      "templated": false
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

修改配置之后返回结果如下：

{
  "_links": {
    "self": {
      "href": "http://127.0.0.1:8080/actuator",
      "templated": false
    },
    "auditevents": {
      "href": "http://127.0.0.1:8080/actuator/auditevents",
      "templated": false
    },
    "beans": {
      "href": "http://127.0.0.1:8080/actuator/beans",
      "templated": false
    },
    "health": {
      "href": "http://127.0.0.1:8080/actuator/health",
      "templated": false
    },
    "conditions": {
      "href": "http://127.0.0.1:8080/actuator/conditions",
      "templated": false
    },
    "shutdown": {
      "href": "http://127.0.0.1:8080/actuator/shutdown",
      "templated": false
    },
    "configprops": {
      "href": "http://127.0.0.1:8080/actuator/configprops",
      "templated": false
    },
    "env": {
      "href": "http://127.0.0.1:8080/actuator/env",
      "templated": false
    },
    "env-toMatch": {
      "href": "http://127.0.0.1:8080/actuator/env/{toMatch}",
      "templated": true
    },
    "info": {
      "href": "http://127.0.0.1:8080/actuator/info",
      "templated": false
    },
    "loggers": {
      "href": "http://127.0.0.1:8080/actuator/loggers",
      "templated": false
    },
    "loggers-name": {
      "href": "http://127.0.0.1:8080/actuator/loggers/{name}",
      "templated": true
    },
    "heapdump": {
      "href": "http://127.0.0.1:8080/actuator/heapdump",
      "templated": false
    },
    "threaddump": {
      "href": "http://127.0.0.1:8080/actuator/threaddump",
      "templated": false
    },
    "metrics": {
      "href": "http://127.0.0.1:8080/actuator/metrics",
      "templated": false
    },
    "metrics-requiredMetricName": {
      "href": "http://127.0.0.1:8080/actuator/metrics/{requiredMetricName}",
      "templated": true
    },
    "scheduledtasks": {
      "href": "http://127.0.0.1:8080/actuator/scheduledtasks",
      "templated": false
    },
    "httptrace": {
      "href": "http://127.0.0.1:8080/actuator/httptrace",
      "templated": false
    },
    "mappings": {
      "href": "http://127.0.0.1:8080/actuator/mappings",
      "templated": false
    }
  }
}
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

像我们自己的微服务，确实需要监控微服务的运行情况，但是如果被其他不怀好意的人知道了，利用了这里面的信息，给我们造成了不必要的损失就不好了，所以我们对这些功能还是要做一下权限校验，结合 Spring Security，做安全防护。

加入spring-boot-starter-security包引用。不做任何配置启动微服务。再访问http://127.0.0.1:8080/actuator，就会出现如下界面：

默认用户是user，密码是微服务启动时控制台打印的密码信息：

Using generated security password: ae4febb7-2a8d-4a1b-ab2e-bc96318219bf

登录就可以完成请求查看。

如果存在Spring Security，还可以设置缓存失效的时间：

management.endpoint.<name>.cache.time-to-live=10s
1

失效时间为十秒，name是actuator提供的端点名。
跨域访问：
我们实际的应用过程中难免会碰到跨域问题，同时端点访问也存在这样的问题，所以要允许跨域只需要完成以下配置：

management.endpoints.web.cors.allowed-origins=https://example.com
management.endpoints.web.cors.allowed-methods=GET,POST
1
2

spring-boot-actuator也提供了很好的延展性，除了自身框架上带的这些端点，还可以自己定义端点信息。使用 @Endpoint、 @JmxEndpoint、@WebEndpoint注解来暴露端点，使用@Endpoint注解的bean，可以通过JMX和HTTP两者访问，使用@JmxEndpoint注解的bean只能JMX方位，而使用@WebEndpoint的bean只能被HTTP访问。
以下是web端点的方法注解说明情况：

举个示例：

@Component
@WebEndpoint(id="sc")
public class TestHealthEndpoint{
    
    @ReadOperation
    public String get(@Selector String name) {
        return "happy";
    }
}
1
2
3
4
5
6
7
8
9

@Selector 的含义是让这个路径变成/actuator/sc/{name} 我们能从路径上获取一个入参。
监控微服务运行时检查信息：

我们简单地开启健康检查health，通过/actuator/health访问返回的结果只有一个UP。但是我们可以在这个返回结果里添加任何我们想监控的返回信息。运行内存信息、cpu运行信息，数据库连接信息等等。

actuator提供的一些监控信息：

也可以自定义去写这个健康检测：

自己编写实现类实现HealthIndicators。

示例：

@Component
public class MyHealthIndicator implements HealthIndicator {

	@Override
	public Health health() {
		int errorCode = check(); 
		if (errorCode != 0) {
			return Health.down().withDetail("Error Code", errorCode).build();
		}
		return Health.up().build();
	}

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