专栏首页TECH flowerSpring Boot Admin简介及实践

Spring Boot Admin简介及实践

问题

在若干年前的单体应用时代,我们可以相对轻松地对整个业务项目进行健康检查、指标监控、配置管理等等项目治理。如今随着微服务的发展,我们将大型单体应用按业务模型进行划分,以此形成众多小而自治的微服务,我们品尝到了微服务的甜头:异常隔离、独立部署和发布、服务伸缩、便于协作开发...我们的项目服务更加解耦合,高可用。但与此同时这也给我们带来了很多挑战,众多服务的健康检查、指标监控问题、配置管理、日志聚合问题、异常排查问题等等。我们急切需要一些工具或者手段来尽可能地解决这些问题,从而让我们收获微服务的最大化利益。


来源背景

codecentric的Spring Boot Admin是一个社区项目,用于管理和监视您的Spring Boot®应用程序。这些应用程序在我们的Spring Boot Admin Client中注册(通过HTTP),或者是通过Spring Cloud®(例如Eureka,Consul)发现的。UI只是Spring Boot Actuator端点之上的Vue.js应用程序。


功能介绍

Spring Boot Admin提供了很多服务治理方面的功能,利用它能节省我们很多在治理服务方面的时间和精力Spring Boot Admin提供了如下功能(包括但不限于):

  • 显示健康状态及详细信息,如JVM和内存指标、数据源指标、缓存指标
  • 跟踪并下载日志文件
  • 查看jvm系统-和环境属性
  • 查看Spring启动配置属性
  • 方便loglevel管理
  • 查看线程转储
  • 视图http-traces
  • 查看http端点
  • 查看计划任务
  • 查看和删除活动会话(使用spring-session)
  • 状态更改通知(通过电子邮件、Slack、Hipchat…)
  • 状态变化的事件日志(非持久性)
  • ……(and more !)

搭建Spring Boot Admin Server

在编写本文的时候,Spring Boot Admin的最新版本为:2.2.2。接下来我将会用此版本来进行演示。 基础环境:Jdk 11、Maven、IntelliJ IDEA

引入依赖

由于Spring Boot Admin Server可以作为servlet或webflux应用程序运行,因此您需要对此进行决定并添加相应的Spring Boot Starter。在此示例中,我们使用Servlet Web Starter。

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

添加配置

通过在配置中添加@EnableAdminServer来引入Spring Boot Admin Server配置:

@Configuration
@EnableAutoConfiguration
@EnableAdminServer
public class SpringBootAdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootAdminApplication.class, args);
    }
}

此时我们通过浏览器访问:http://localhost:8080 可以看到我们可以访问到Spring Boot Admin Server的UI界面:


注册客户端

Spring boot Admin提供了多种注册客户端服务的方式,要在SBA(Spring Boot Admin)服务器上注册应用程序,您可以直接注册SBA客户端或使用Spring Cloud Discovery(例如Eureka,Consul等)。在SBA服务器端,还有一个使用静态配置的简单选项。本文将演示直接注册、使用Zookeeper、使用Kubernetes来注册发现客户端服务。

直接注册方式

引入依赖

使用直接注册方式,需要在客户端服务中引入依赖,从而做到直接与SBA服务端通信。

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-security</artifactId>
  </dependency>

根据开头所述Spring Boot Admin是基于Spring Boot Actuator之上的,所以我们需要引入Spring Boot Actuator相关依赖,关于Spring Boot Actuator,可以参考此篇文章。此外我们需要处理Actuator的安全性,所以引入Spring Security相关依赖。

添加配置

接下来我们在项目配置文件中添加相关配置

spring.boot.admin.client.url=http://localhost:8080  (1)
management.endpoints.web.exposure.include=*  (2)

1⃣️:要注册到其中的Spring Boot Admin Server的URL。2⃣️:与Spring Boot 2一样,默认情况下,大多数Actuator(端点)都不通过http公开,在这里我们公开了所有端点。对于生产,您应该仔细选择要公开的端点。

安全性配置

@Configuration
public static class SecurityPermitAllConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests().anyRequest().permitAll()
            .and().csrf().disable();
    }
}

为了简洁起见,我们暂时禁用安全性。查看有关如何处理端点的安全性,我会在后续文章中演示。此时我们同时运行SBA的服务端和客户端服务,再次访问http://localhost:8080,可以看到我们的客户端服务已经注册进去,并且可以看到客户端服务的一些信息。


Zookeeper服务发现方式

我们通过一些服务发现组件对客户端服务进行注册的时候,我们就可以忽略掉客户端服务了,即我们不需要在客户端服务中引入Spring Boot Admin相关依赖,因为服务端可以通过服务发现组件来自动发现客户端服务。

引入依赖

我们在SBA服务端以及客户端中引入Zookeeper相关依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-context</artifactId>
</dependency>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Hoxton.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

添加配置

在SBA服务端项目中添加Zookeeper相关配置

spring:
  cloud:
    zookeeper:
      connect-string: 你的Zookeeper地址
  boot:
    admin:
      discovery:
        instances-metadata:
          sba-register: true

因为Zookeeper中可能存在很多服务,而我们只想发现我们关注的服务,此时我们可以通过上述配置来实现,即我们只发现元数据为sba-register: true的客户端服务。在SBA客户端中添加Zookeeper相关配置

spring.cloud.zookeeper.connect-string=你的Zookeeper地址
spring.cloud.zookeeper.discovery.metadata.sba-register=true

对应SBA服务端的配置,我们指定了Zookeeper的地址,并且指定了该客户端服务的注册元数据为sba-register: true 此时我们同时运行SBA的服务端和客户端服务,再次访问SBA服务端地址,可以看到服务端已经通过Zookeeper自动发现客户端服务,并且可以看到客户端服务的一些信息。


Kubernetes服务发现方式

如果你是通过基于Kubernetes的容器化部署,Spring Boot Admin也提供了支持,基于Kubernetes的服务发现方式和Zookeeper方式实现大同小异

引入依赖

我们在Spring Boot Admin服务端项目中引入Kubernetes相关依赖

<dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-kubernetes-discovery</artifactId>
    </dependency>
</dependencies>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Hoxton.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Spring Cloud Kubernetes提供使用Kubernetes本机服务的Spring Cloud公共接口实现。此库的主要目标是促进在Kubernetes中运行的Spring Cloud和Spring Boot应用程序的集成。

添加配置

@SpringBootApplication
@EnableAdminServer
@EnableDiscoveryClient
@EnableScheduling
public class AdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}

@EnableDiscoveryClient注解表示启用基于Kubernetes的服务发现,@EnableScheduling注解是必须的,表示定期调用Kubernetes API来刷新正在运行的服务列表,并且仅在启动时执行一次。由于我们一直希望拥有最新的Pod列表(例如,在扩展应用程序实例数量之后),因此我们需要启用调度程序来负责监视服务目录的更改并相应地更新DiscoveryClient实例列表。

Kubenetes权限配置

Spring Boot Admin使用Spring Cloud Kubernetes,它需要额外的特权才能访问Kubernetes API。我们仅出于开发目的,将cluster-admin设置为ServiceAccount的默认角色。

$ kubectl create clusterrolebinding admin-default --clusterrole=cluster-admin --serviceaccount=default:default

此时我们同时运行SBA的服务端和客户端服务,再次访问SBA服务端,可以看到服务端已经通过Kubernetes自动发现客户端服务,并且可以看到客户端服务的一些信息。


总结

本文主要介绍了Spring Boot Admin(SBA)的诞生背景已经其带来的一些功能特性,在这个微服务遍地开花的时代SBA缓解了我们在微服务中遇到的许多棘手的问题。后面本文还用代码演示了如何在项目中引入并使用SBA。本文只涉及到了SBA的基础实践,我会在后续文章中详细演示更多SBA的高级功能,看看我们能从中受益多少。

本文的示例代码 SBA-client:https://github.com/cg837718548/sba-client-demo.git SBA-server:https://github.com/cg837718548/sba-server-demo.git

本文分享自微信公众号 - TECH flower(tech-flower),作者:东溪陈姓少年

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-05-11

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Spring Boot Admin最佳实践

    在Spring Boot Actuator中提供很多像health、metrics等实时监控接口,可以方便我们随时跟踪服务的性能指标。Spring Boot默认...

    迹_Jason
  • Spring Boot 应用监控:Actuator与 AdminSpring Boot 应用监控:Actuator与 Admin

    在企业级应用中,对系统进行运行状态监控通常是必不可少的。Spring Boot提供了 Actuator 模块实现应用的监控与管理,对应的起步依赖是spring-...

    一个会写诗的程序员
  • Spring Boot & Swagger

    十毛
  • Spring Boot 2 快速教程:WebFlux 集成 Mongodb(四)

    上一讲用 Map 数据结构内存式存储了数据。这样数据就不会持久化,本文我们用 MongoDB 来实现 WebFlux 对数据源的操作。

    程序员泥瓦匠
  • Spring Boot Actuator详解与深入应用(三):Prometheus+Grafana应用监控

    本文系《Spring Boot Actuator详解与深入应用》中的第三篇。在前两篇文章,我们主要讲了Spring Boot Actuator 1.x与 2.x...

    aoho求索
  • 【建议收藏】缺少 Vue3 和 Spring Boot 的实战项目经验?我这儿有啊!

    缺少 Vue3 和 Spring Boot 的实战项目经验?缺少学习项目和练手项目?我这儿有啊!

    程序员十三
  • 【建议收藏】缺少 Vue3 和 Spring Boot 的实战项目经验?我这儿有啊!

    缺少 Vue3 和 Spring Boot 的实战项目经验?缺少学习项目和练手项目?我这儿有啊!

    程序员十三
  • 对没有监控的微服务Say No!

    目录: 一、监控简介 二、监控策略 三、总结 一、监控简介 微服务的特点决定了功能模块的部署是分布式的,大部分功能模块都是运行在不同的机器上,彼此通过服务调用...

    yuanyi928
  • Spring Boot Admin:微服务应用监控

    SpringBoot应用可以通过Actuator来暴露应用运行过程中的各项指标,Spring Boot Admin通过这些指标来监控SpringBoot应用,然...

    macrozheng
  • spring-boot-route(十九)spring-boot-admin监控服务

    SpringBootAdmin不是Spring官方提供的模块,它包含了Client和Server两部分。server部分提供了用户管理界面,client即为被监...

    Java旅途
  • 微服务中一个监控Spring Boot的神器

    你是不是在一个月黑风高的晚上想过这么一件事情,就是想把spring boot actuator的那些endpoint可视化,是不是想着自己搞一个UI。 每当你有...

    ImportSource
  • 为什么说 Java 程序员到了必须掌握 Spring Boot 的时候?

    纯洁的微笑
  • 为什么说 Java 程序员到了必须掌握 Spring Boot 的时候?

    说起 Spring Boot 我们不得不先了解一下 Spring 这个企业,不仅因为 Spring Boot 来源于 Spirng 大家族,而且 Spring ...

    Java帮帮
  • Spring Boot 2 快速教程:WebFlux 集成 Thymeleaf 、 Mongodb 实践(六)

    本小章节,主要还是总结下上面两讲的操作,并实现下复杂查询的小案例。那么没装 MongoDB 的可以进行下面的安装流程。

    程序员泥瓦匠
  • Sprint Boot Admin

    首先建立一个Spring Boot Admin Server,只需要两步,非常简单

    十毛
  • Spring Boot & MyBatis

    十毛
  • 重学SpringBoot系列应用程序监控管理

    Spring Boot作为构建微服务节点的方案,一定要提供全面而且细致的监控指标,使微服务更易于管理!微服务不同于单体应用,微服务的每个服务节点都单独部署,独立...

    大忽悠爱学习
  • SpringBoot - 构建监控体系03_使用 Admin Server 管理 Spring 应用程序

    通过引入 Actuator 组件,我们为 Spring Boot 应用程序添加了系统监控功能。基于 Actuator 暴露的各种 HTTP 端点,开发人员可以获...

    小小工匠
  • SpringCloud微服务开源项目

    Cloud微服务化开发平台,具有统一授权、认证后台管理系统,其中包含具备用户管理、资源权限管理、网关API

    ruochen

扫码关注云+社区

领取腾讯云代金券