SBA可以通过客户端上报，也可以通过配置中心自动获取上报信息。

目前统一采用nacos注册中心方式获取服务地址并获取上报信息。

SBA环境搭建

客户端

客户端指需要使用arthas的微服务。具体操作如下：

1.添加监控maven依赖

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

2.配置监控信息

  1. management.metrics.tags.application=${spring.application.name}
  2. management.auditevents.enabled=true
  3. management.endpoint.auditevents.enabled=true
  4. management.endpoint.auditevents.cache.time-to-live=5
  5. management.endpoints.web.exposure.include=*
  6. management.endpoint.health.enabled=true
  7. management.endpoint.health.show-details=always
  8. management.endpoint.beans.enabled=true
  9. management.endpoint.beans.cache.time-to-live=0ms
  10. management.endpoint.shutdown.enabled=true

其中有其他很多属性和配置方式，请参照官方文档

3.即时日志配置

如果要在SBA监控中输出实时日志，添加一下配置

  1. ###springbootAdmin 开启日志打印
  2. management.endpoint.logfile.enabled=true
  3. management.endpoint.logfile.external-file=/opt/logs/xy-rbac/xy-rbac.log
  4. management.endpoint.logfile.cache.time-to-live=0ms

服务端

服务端指SBA的监控平台。具体操作如下：

1.创建一个标准的springboot项目并添加依赖

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  5. <dependency>
  6.     <groupId>de.codecentric</groupId>
  7.     <artifactId>spring-boot-admin-starter-server</artifactId>
  8.     <version>${spring-boot-admin-starter-server.version}</version>
  9. </dependency>
  10. <dependency>
  11.     <groupId>org.springframework.boot</groupId>
  12.     <artifactId>spring-boot-starter-actuator</artifactId>
  13. </dependency>
  14. <dependency>
  15.     <groupId>org.springframework.boot</groupId>
  16.     <artifactId>spring-boot-starter-security</artifactId>
  17. </dependency>
  18. <dependency>
  19.     <groupId>com.alibaba.cloud</groupId>
  20.     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  21. </dependency>

2.开启服务端监控功能

  1. @EnableWebSecurity
  2. @EnableAdminServer
  3. @SpringBootApplication
  4. @EnableDiscoveryClient
  5. public class ApmAdminApplication {
  7.     public static void main(String[] args) {
  8.         SpringApplication.run(ApmAdminApplication.class, args);
  9.     }
  11. }

3.配置spring security安全框架

  1. /**
  2.  * @author jack.li
  3.  */
  4. @Configuration
  5. public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {
  7.     private final String adminContextPath;
  9.     public SecuritySecureConfig(AdminServerProperties adminServerProperties) {
  10.         this.adminContextPath = adminServerProperties.getContextPath();
  11.     }
  13.     @Override
  14.     protected void configure(HttpSecurity http) throws Exception {
  15.         SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
  16.         successHandler.setTargetUrlParameter("redirectTo");
  17.         // successHandler.setDefaultTargetUrl(adminContextPath + "/");
  19.         http.authorizeRequests()
  20.                 .antMatchers(adminContextPath + "/assets/**").permitAll()
  21.                 .antMatchers(adminContextPath + "/login").permitAll()
  22.                 .antMatchers(adminContextPath + "/actuator/**").permitAll()
  23.                 //    .antMatchers(adminContextPath + "/instances/**").permitAll()
  24.                 .anyRequest().authenticated()
  25.                 .and()
  26.                 .formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
  27.                 .logout().logoutUrl(adminContextPath + "/logout").and()
  28.                 .httpBasic().and()
  29.                 .csrf().disable();
  30.     }
  31. }

效果如下：

SBA - 图1SBA - 图2

SBA - 图3

SBA集成Arthas 控制台

客户端

客户端指需要使用arthas的微服务。具体操作如下：

1.添加maven依赖

  1. <dependency>
  2.     <groupId>com.taobao.arthas</groupId>
  3.     <artifactId>arthas-spring-boot-starter</artifactId>
  4.     <version>3.5.4</version>
  5. </dependency>

版本号根据各自项目需要做调整

2.配置arthas console

  1. ## 客户端连接的唯一标识
  2. arthas.agent-id=xy-rbac
  3. ## 使用tunnel-server所在服务器ip
  4. arthas.tunnel-server=ws://127.0.0.1:7777/ws

服务端

服务端指SBA的监控平台。具体操作如下：

1.下载启动arthas console

在官网下载arthas-tunnel-server-3.5.4-fatjar.jar

通过如下命令启动即可：

  1. java -jar arthas-tunnel-server-3.5.4-fatjar.jar

其启动参数根据需要自行解决。

2.配置扩展UI

  1. spring.boot.admin.ui.external-views[0].label=Arthas Console
  2. spring.boot.admin.ui.external-views[0].url=http://localhost:8080/
  3. spring.boot.admin.ui.external-views[0].order=1800
  4. spring.boot.admin.ui.external-views[0].iframe=true

external-views以List的方式配置。

效果如下：

SBA - 图4

自定义报警

SBA提供了基于mail的报警，但是mail的延迟太高，不易及时处理，所以需要自定义一个报警。直接贴代码：

  1. /**
  2.  * <p>自定义报警</p >
  3.  *
  4.  * @author jack.li
  5.  * @version 1.0
  6.  * @date 2021/10/27 12:39 下午
  7.  */
  8. @Slf4j
  9. public class XyStatusChangeNotifier extends AbstractStatusChangeNotifier {
  11.     private final MessageComponent messageComponent;
  13.     public XyStatusChangeNotifier(InstanceRepository repository, final MessageComponent messageComponent) {
  14.         super(repository);
  15.         this.messageComponent = messageComponent;
  16.     }
  18.     @Override
  19.     protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {
  22.         if (event instanceof InstanceStatusChangedEvent) {
  24.             InstanceStatusChangedEvent statusChangedEvent = (InstanceStatusChangedEvent) event;
  26.             boolean down = statusChangedEvent.getStatusInfo().isDown();
  27.             boolean offline = statusChangedEvent.getStatusInfo().isOffline();
  28.             boolean up = statusChangedEvent.getStatusInfo().isUp();
  29.             boolean unknown = statusChangedEvent.getStatusInfo().isUnknown();
  30.             //TODO
  31.         }
  33.         String serviceName = instance.getRegistration().getName();
  34.         String serviceUrl = instance.getRegistration().getServiceUrl();
  35.         String status = instance.getStatusInfo().getStatus();
  36.         Map<String, Object> details = instance.getStatusInfo().getDetails();
  37.         StringBuilder str = new StringBuilder();
  38.         str.append("监控报警 : 【" + serviceName + "】");
  39.         str.append("【服务地址】" + serviceUrl);
  40.         str.append("【状态】" + status);
  41.         str.append("【详情】" + JSONObject.toJSONString(details));
  42.         log.info(">>>>>>>>sent message:" + str.toString());
  43.         return Mono.fromRunnable(() -> messageComponent.send(MessageType.Alarm_Message, str.toString()));
  44.     }
  46. }
  1. /**
  2.  * <p>description</p >
  3.  *
  4.  * @author jack.li
  5.  * @version 1.0
  6.  * @since 2021/10/27 1:31 下午
  7.  */
  8. @Configuration
  9. @RequiredArgsConstructor(onConstructor = @__(@Autowired))
  10. public class AlarmConfig {
  12.     private final MessageComponent messageComponent;
  14.     @Bean
  15.     public XyStatusChangeNotifier statusChangeNotifierToLark(InstanceRepository repository) {
  16.         return new XyStatusChangeNotifier(repository, messageComponent);
  17.     }
  19.     /**
  20.      * 当服务不可用时，需要持续发告警消息。以下仅定义服务状态为{"DOWN", "OFFLINE"}时持续告警
  22.     @Primary
  23.     @Bean(initMethod = "start", destroyMethod = "stop")
  24.     public RemindingNotifier remindingNotifier(InstanceRepository repository) {
  25.         RemindingNotifier notifier = new RemindingNotifier(statusChangeNotifierToLark(repository), repository);
  26.         notifier.setReminderStatuses(new String[]{"DOWN", "OFFLINE"});
  27.         notifier.setEnabled(true);
  28.         notifier.setReminderPeriod(Duration.ofSeconds(60));
  29.         notifier.setCheckReminderInverval(Duration.ofSeconds(60));
  30.         return notifier;
  31.     }
  33.     /**
  34.      * 开启web http trace跟踪
  35.      *
  36.      * @return
  37.      */
  38.     @Bean
  39.     public InMemoryHttpTraceRepository getInMemoryHttpTrace() {
  40.         return new InMemoryHttpTraceRepository();
  41.     }
  42. }

可暴露端点列表

SBA - 图5