Spring Cloud Alibaba教程第五弹 Sentinel控制台

深碍√TFBOYSˉ_ 2022-12-14 13:53 314阅读 0赞

**写在前面的话**

更多Spring与微服务相关的教程请戳这里 [火力全开系列 Spring与微服务教程合集 持续更新][Spring_]

# 1、Sentinel控制台 #

Sentinel 提供一个轻量级的开源控制台。并且，阿里云上提供企业级的控制台：AHAS Sentinel 控制台

Sentinel 控制台包含如下功能:

*  查看机器列表以及健康情况：收集 Sentinel 客户端发送的心跳包，用于判断机器是否在线。
 *  监控 (单机和集群聚合)：通过 Sentinel 客户端暴露的监控 API，定期拉取并且聚合应用监控信息，最终可以实现秒级的实时监控。
 *  规则管理和推送：统一管理推送规则。
 *  鉴权：生产环境中鉴权非常重要。这里每个开发者需要根据自己的实际情况进行定制。

注意：Sentinel 控制台目前仅支持单机部署

# 1.1、安装控制台 #

首先，获取控制台的jar文件，[https://github.com/alibaba/Sentinel/releases][https_github.com_alibaba_Sentinel_releases]

启动控制台命令：

java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar

用户名和密码是sentinel

控制台的一些特性可以通过配置项来进行配置，配置项主要有两个来源：`System.getProperty()` 和 `System.getenv()`，同时存在时后者可以覆盖前者。通过环境变量进行配置时，因为不支持 . 所以需要将其更换为 \_。

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>最小值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>auth.enabled</td> 
   <td>boolean</td> 
   <td>true</td> 
   <td>-</td> 
   <td>是否开启登录鉴权，仅用于日常测试，生产上不建议关闭</td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.auth.username</td> 
   <td>String</td> 
   <td>sentinel</td> 
   <td>-</td> 
   <td>登录控制台的用户名，默认为&nbsp;<code>sentinel</code></td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.auth.password</td> 
   <td>String</td> 
   <td>sentinel</td> 
   <td>-</td> 
   <td>登录控制台的密码，默认为&nbsp;<code>sentinel</code></td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.app.hideAppNoMachineMillis</td> 
   <td>Integer</td> 
   <td>0</td> 
   <td>60000</td> 
   <td>是否隐藏无健康节点的应用，距离最近一次主机心跳时间的毫秒数，默认关闭</td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.removeAppNoMachineMillis</td> 
   <td>Integer</td> 
   <td>0</td> 
   <td>120000</td> 
   <td>是否自动删除无健康节点的应用，距离最近一次其下节点的心跳时间毫秒数，默认关闭</td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.unhealthyMachineMillis</td> 
   <td>Integer</td> 
   <td>60000</td> 
   <td>30000</td> 
   <td>主机失联判定，不可关闭</td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.autoRemoveMachineMillis</td> 
   <td>Integer</td> 
   <td>0</td> 
   <td>300000</td> 
   <td>距离最近心跳时间超过指定时间是否自动删除失联节点，默认关闭</td> 
  </tr> 
  <tr> 
   <td>sentinel.dashboard.unhealthyMachineMillis</td> 
   <td>Integer</td> 
   <td>60000</td> 
   <td>30000</td> 
   <td>主机失联判定，不可关闭</td> 
  </tr> 
  <tr> 
   <td>server.servlet.session.cookie.name</td> 
   <td>String</td> 
   <td>sentinel_dashboard_cookie</td> 
   <td>-</td> 
   <td>控制台应用的 cookie 名称，可单独设置避免同一域名下 cookie 名冲突</td> 
  </tr> 
 </tbody> 
</table>

配置示例：

*  命令行方式：java -Dsentinel.dashboard.app.hideAppNoMachineMillis=60000
 *  Java 方式：System.setProperty("sentinel.dashboard.app.hideAppNoMachineMillis", "60000");
 *  环境变量方式：sentinel\_dashboard\_app\_hideAppNoMachineMillis=60000

## 1.2、客户端接入 ##

### 1.2.1、pom.xml ###

<dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-transport-simple-http</artifactId>
                <version>1.8.0</version>
            </dependency>

## 1.2.2、启动配置项 ##

Sentinel 提供如下的配置方式：

*  JVM -D 参数方式
 *  properties 文件方式（1.7.0 版本开始支持）

注意点：

*  其中，`project.name` 参数只能通过 JVM -D 参数方式配置（since 1.8.0 取消该限制），其它参数支持所有的配置方式
 *  优先级顺序：JVM -D 参数的优先级最高。若 properties 和 JVM 参数中有相同项的配置，以 JVM 参数配置的为准。
 *  用户可以通过 `-Dcsp.sentinel.config.file` 参数配置 properties 文件的路径，支持 classpath 路径配置（如 `classpath:sentinel.properties`）。默认 Sentinel 会尝试从 `classpath:sentinel.properties` 文件读取配置，读取编码默认为 UTF-8
 *  1.7.0 以下版本可以通过旧的 `${user_home}/logs/csp/${project.name}.properties` 配置文件进行配置（除 `project.name` 和日志相关配置项）

**启动配置项分类（具体查看第三节、控制台客户端配置项列表）：**

*  sentinel-core 的配置项
 *              基础配置项
 *              日志相关配置项
 *  sentinel-transport-common 的配置项

### 1.2.3、触发客户端初始化 ###

确保客户端有访问量，Sentinel 会在客户端首次调用的时候进行初始化，开始向控制台发送心跳包。

注意：您还需要根据您的应用类型和接入方式引入对应的适配依赖，否则即使有访问量也不能被 Sentinel 统计。

# 2、控制台客户端配置项列表 #

## 2.1、sentinel-core 的配置项 ##

### 2.1.1、基础配置项 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>含义</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>是否必需</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>project.name</code></td> 
   <td>指定应用的名称</td> 
   <td><code>String</code></td> 
   <td><code>null</code></td> 
   <td>否</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.app.type</code></td> 
   <td>指定应用的类型</td> 
   <td><code>int</code></td> 
   <td>0 (<code>APP_TYPE_COMMON</code>)</td> 
   <td>否</td> 
   <td>1.6.0 引入</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.metric.file.single.size</code></td> 
   <td>单个监控日志文件的大小</td> 
   <td><code>long</code></td> 
   <td>52428800 (50MB)</td> 
   <td>否</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.metric.file.total.count</code></td> 
   <td>监控日志文件的总数上限</td> 
   <td><code>int</code></td> 
   <td>6</td> 
   <td>否</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.statistic.max.rt</code></td> 
   <td>最大的有效响应时长（ms），超出此值则按照此值记录</td> 
   <td><code>int</code></td> 
   <td>4900</td> 
   <td>否</td> 
   <td>1.4.1 引入</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.spi.classloader</code></td> 
   <td>SPI 加载时使用的 ClassLoader，默认为给定类的 ClassLoader</td> 
   <td><code>String</code></td> 
   <td><code>default</code></td> 
   <td>否</td> 
   <td>若配置&nbsp;<code>context</code>&nbsp;则使用 thread context ClassLoader。1.7.0 引入</td> 
  </tr> 
 </tbody> 
</table>

其中 `project.name` 项用于指定应用名（appName）。若未指定，则默认解析 main 函数的类名作为应用名。**实际项目使用中建议手动指定应用名**。

### 2.1.2、日志相关配置项 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>含义</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>是否必需</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>csp.sentinel.log.dir</code></td> 
   <td>Sentinel 日志文件目录</td> 
   <td><code>String</code></td> 
   <td><code>${user.home}/logs/csp/</code></td> 
   <td>否</td> 
   <td>1.3.0 引入</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.log.use.pid</code></td> 
   <td>日志文件名中是否加入进程号，用于单机部署多个应用的情况</td> 
   <td><code>boolean</code></td> 
   <td><code>false</code></td> 
   <td>否</td> 
   <td>1.3.0 引入</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.log.output.type</code></td> 
   <td>Record 日志输出的类型，<code>file</code>&nbsp;代表输出至文件，<code>console</code>&nbsp;代表输出至终端</td> 
   <td><code>String</code></td> 
   <td><code>file</code></td> 
   <td>否</td> 
   <td>1.6.2 引入</td> 
  </tr> 
 </tbody> 
</table>

注意：若需要在单台机器上运行相同服务的多个实例，则需要加入 -Dcsp.sentinel.log.use.pid=true 来保证不同实例日志的独立性。

##    2.2、sentinel-transport-common 的配置项 ##

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>含义</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>是否必需</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>csp.sentinel.dashboard.server</code></td> 
   <td>控制台的地址，指定控制台后客户端会自动向该地址发送心跳包。地址格式为：<code>hostIp:port</code></td> 
   <td><code>String</code></td> 
   <td><code>null</code></td> 
   <td>是</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.heartbeat.interval.ms</code></td> 
   <td>心跳包发送周期，单位毫秒</td> 
   <td><code>long</code></td> 
   <td><code>null</code></td> 
   <td>非必需，若不进行配置，则会从相应的&nbsp;<code>HeartbeatSender</code>&nbsp;中提取默认值</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.api.port</code></td> 
   <td>本地启动 HTTP API Server 的端口号</td> 
   <td><code>int</code></td> 
   <td>8719</td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.heartbeat.client.ip</code></td> 
   <td>指定心跳包中本机的 IP</td> 
   <td><code>String</code></td> 
   <td>-</td> 
   <td>若不指定则通过&nbsp;<code>HostNameUtil</code>&nbsp;解析；该配置项多用于多网卡环境</td> 
  </tr> 
 </tbody> 
</table>

注：csp.sentinel.api.port 可不提供，默认为 8719，若端口冲突会自动向下探测可用的端口

[Spring_]: https://blog.csdn.net/xl_1803/article/details/109462842
[https_github.com_alibaba_Sentinel_releases]: https://github.com/alibaba/Sentinel/releases