一. 介绍
GitHub: https://github.com/codecentric/spring-boot-admin
官方文档： http://codecentric.github.io/spring-boot-admin/1.5.7/ （此文档为1.5.7版本的文档）
the applications register with our spring boot admin client (via http) or are discovered using spring cloud ® (e.g. eureka, consul).
官方文档中介绍中提到，使用spring boot admin监控，需要一个spring boot admin server服务，其他被监控的服务即为一个spring boot admin client，或者是通过spring cloud中的服务注册发现组件如：eureak,consul来进行监控服务，这样就不需要特意设置相关被监控的服务作为一个client，只需注册到eureka或者consul中即可。
注：本文是基于spring cloud eureka做为服务注册发现组件来实现对服务的监控。提前是存在了eureka的服务。 另：没有使用eureka的需要在被监控服务中引入client的jar,具体情况请参考上面的官方文档。*
二.创建spring boot admin server服务
首先创建一个spirng boot项目，可以通过 http://start.spring.io/ 快速搭建。
1、添加spring boot admin server 依赖
pom.xml
|
1
2
3
4
5
6
7
|
<dependencies> <dependency> <groupid>de.codecentric</groupid> <artifactid>spring-boot-admin-starter-server</artifactid> <version>1.5.7</version> </dependency></dependencies> |
2、服务启动类添加 @enableadminserver 注解开启监控
|
1
2
3
4
5
6
7
8
|
@configuration@enableautoconfiguration@enableadminserverpublic class springbootadminapplication { public static void main(string[] args) { springapplication.run(springbootadminapplication.class, args); }} |
3、将spring boot admin server 注册到eureka
添加eureka依赖
pom.xml
|
1
2
3
4
|
<dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-eureka</artifactid> </dependency> |
服务启动类添加 @enablediscoveryclient 开启服务发现
|
1
2
3
4
5
6
7
8
9
|
@configuration@enableautoconfiguration@enablediscoveryclient@enableadminserverpublic class springbootadminapplication { public static void main(string[] args) { springapplication.run(springbootadminapplication.class, args); }} |
添加eureka服务注册配置
|
1
2
3
4
5
6
7
8
9
10
11
12
|
eureka: instance: leaserenewalintervalinseconds: 10 client: registryfetchintervalseconds: 5 serviceurl: defaultzone: http://10.1.3.54:8761/eureka/# 关闭spring boot actuator的安全，否则敏感路径访问是401management: security: enabled: false |
启动项目，访问ip:port 即进入管理的页面
如图：
图中显示的这些项目都是已经注册到eureka上的服务，通过将spring boot admin server注册到eureka上来监控项目。
三.配置设置
1、登录ui
admin管理服务没有任何的安全措施，任何人知道ip和port就能访问，这就很不安全，而spring boot admin也提供了登录页面。需要和spring security 配合使用。
添加spring boot admin ui依赖：
|
1
2
3
4
5
|
<dependency> <groupid>de.codecentric</groupid> <artifactid>spring-boot-admin-server-ui-login</artifactid> <version>1.5.7</version></dependency> |
添加spring security依赖：
|
1
2
3
4
|
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-security</artifactid></dependency> |
在项目启动类中添加配置代码：
|
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
|
package com.aspire.springbootadmin;import de.codecentric.boot.admin.config.enableadminserver;import org.springframework.boot.springapplication;import org.springframework.boot.autoconfigure.enableautoconfiguration;import org.springframework.cloud.client.discovery.enablediscoveryclient;import org.springframework.context.annotation.configuration;import org.springframework.security.config.annotation.web.builders.httpsecurity;import org.springframework.security.config.annotation.web.configuration.websecurityconfigureradapter;@configuration@enableautoconfiguration@enablediscoveryclient@enableadminserverpublic class springbootadminapplication { public static void main(string[] args) { springapplication.run(springbootadminapplication.class, args); } @configuration public static class securityconfig extends websecurityconfigureradapter { @override protected void configure(httpsecurity http) throws exception { // page with login form is served as /login.html and does a post on /login http.formlogin().loginpage("/login.html").loginprocessingurl("/login").permitall(); // the ui does a post on /logout on logout http.logout().logouturl("/logout"); // the ui currently doesn't support csrf http.csrf().disable(); // requests for the login page and the static assets are allowed http.authorizerequests() .antmatchers("/login.html", "/**/*.css", "/img/**", "/third-party/**") .permitall(); // ... and any other request needs to be authorized http.authorizerequests().antmatchers("/**").authenticated(); // enable so that the clients can authenticate via http basic for registering http.httpbasic(); } }} |
添加配置文件
|
1
2
3
4
5
6
|
security: user: name: admin password: 123123 basic: enabled: false |
再次访问会出现一个登陆页面
输入配置中配置的用户名和密码点击login登录。进入后导航栏上也会多出一个退出按钮。点击后即返回到登录页面。
2、client应用的版本信息
想要在application列表中显示版本，使用maven的 build-info 插件,在pom.xml文件添加插件
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<build> <plugins> <plugin> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-maven-plugin</artifactid> <executions> <execution> <goals> <goal>build-info</goal> </goals> </execution> </executions> </plugin> </plugins></build> |
如图：没有添加的就没有显示。
3、client应用jmx bean管理
要在管理界面中与jmx-beans进行交互，您必须在应用程序中包含 jolokia 。 添加pom依赖：
|
1
|
|
|
1
2
3
4
|
<dependency> <groupid>org.jolokia</groupid> <artifactid>jolokia-core</artifactid></dependency> |
添加后在监控的应用detial菜单里就可以看到jmx菜单
4、client应用添加日志log
在client应用的properties中配置如下：
|
1
2
|
logging: path: /xxx/xxx/xxx/ |
指定日志输出路径，然后就可以显示日志了：
5、hystrix ui支持
spring boot admin还可以集成hystrix展示。 前提是client端需要开启hystrix才可以。
在spring boot admin server 添加依赖
|
1
2
3
4
5
|
<dependency> <groupid>de.codecentric</groupid> <artifactid>spring-boot-admin-server-ui-hystrix</artifactid> <version>1.4.6</version></dependency> |
在server的配置文件中添加endpoints节点
点击开启了hystrix的client，点击hystrix菜单既能看到hystrix信息
6.turbine ui 支持
spring boot admin还可以集成turbine展示。
加入依赖：
|
1
2
3
4
5
|
<dependency> <groupid>de.codecentric</groupid> <artifactid>spring-boot-admin-server-ui-turbine</artifactid> <version>1.5.7</version></dependency> |
配置turbine的cluster和location，clusters为turbin服务中配置的clusters一致，location需要指定注册到eureka中的turbine服务名称，例如你的turbine服务名称为turbine-server,配置就为下所示。（其实spring boot admin server本身就可以当做turbine服务，如果之前就存在了turbine服务的话就可以直接在这里配置。若不存在turbine服务，就在spring boot admin server添加turbine相关依赖和配置，这样spring boot admin server也就成了turbine服务。）
|
1
2
3
|
spring.boot.admin.turbine: clusters: default location: turbine-server |
最后在配置文件中添加turbine.stream的endpoint
界面
导航栏中会多出turbine的tab，点击就能看到turbine信息
7.邮件通知
spring boot admin 同时支持邮件通知。
添加依赖
|
1
2
3
4
|
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-mail</artifactid></dependency> |
添加spring邮件配置(这里记一个小坑，开始使用的是qq邮箱，结果死活连不上qq邮箱的smtp服务器，查了下原因是腾讯那边把公司内网ip给禁止了，结果连上4g网就没有问题了。)
|
1
2
3
4
5
6
|
spring: mail: host: mmmail.aspire-tech.com password: xxxxx port: 25 username: xxxx |
添加spring boot admin邮件配置
|
1
2
3
4
5
6
7
|
boot: admin: notify: mail: to: xxxx@aspirecn.com from: chufule@aspirecn.com enabled: true |
效果如图，监控的服务启动，停止都会有邮件通知。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持服务器之家。
原文链接：https://www.jianshu.com/p/8e43726cc7cd?
