Alibaba Sentinel 配置项总结,鉴权配置，配置使用说明

布满荆棘的人生 2022-12-13 04:57 433阅读 0赞

从 Sentinel 1.5.0 开始，控制台提供通用的鉴权接口 [AuthService][]，用户可根据需求自行实现。

从 Sentinel 1.6.0 起，Sentinel 控制台引入基本的**登录**功能，默认用户名和密码都是 `sentinel`。

用户可以通过如下参数进行配置：

*  `-Dsentinel.dashboard.auth.username=sentinel` 用于指定控制台的登录用户名为 `sentinel`；
 *  `-Dsentinel.dashboard.auth.password=123456` 用于指定控制台的登录密码为 `123456`；如果省略这两个参数，默认用户和密码均为 `sentinel`；
 *  `-Dserver.servlet.session.timeout=7200` 用于指定 Spring Boot 服务端 session 的过期时间，如 `7200` 表示 7200 秒；`60m` 表示 60 分钟，默认为 30 分钟；

同样也可以直接在 Spring properties 文件中进行配置。

> 注意：部署多台控制台时，session 默认不会在各实例之间共享，这一块需要自行改造。

## 控制台配置项 ##

控制台的一些特性可以通过配置项来进行配置，配置项主要有两个来源：`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

> **TIPS**
> 
> 本文基于Sentinel 1.6.2编写，未来Sentinel发布新版本后，各位看官可按照本文中的“参考文档”，自行查阅新版本的配置项目。

## Spring Cloud Alibaba Sentienl相关配置项 ##

> **TIPS**
> 
> 参考文档：`https://github.com/alibaba/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc`

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>含义</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>spring.cloud.sentinel.enabled</code></td> 
   <td>Sentinel自动化配置是否生效</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.eager</code></td> 
   <td>取消Sentinel控制台懒加载</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.transport.port</code></td> 
   <td>应用与Sentinel控制台交互的端口，应用本地会起一个该端口占用的HttpServer</td> 
   <td>8719</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.transport.dashboard</code></td> 
   <td>Sentinel 控制台地址</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.transport.heartbeat-interval-ms</code></td> 
   <td>应用与Sentinel控制台的心跳间隔时间</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.transport.client-ip</code></td> 
   <td>客户端IP</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.filter.order</code></td> 
   <td>Servlet Filter的加载顺序。Starter内部会构造这个filter</td> 
   <td>Integer.MIN_VALUE</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.filter.url-patterns</code></td> 
   <td>数据类型是数组。表示Servlet Filter的url pattern集合</td> 
   <td><code>/*</code></td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.filter.enabled</code></td> 
   <td>Enable to instance CommonFilter</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.metric.charset</code></td> 
   <td>metric文件字符集</td> 
   <td>UTF-8</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.metric.file-single-size</code></td> 
   <td>Sentinel metric 单个文件的大小</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.metric.file-total-count</code></td> 
   <td>Sentinel metric 总文件数量</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.log.dir</code></td> 
   <td>Sentinel 日志文件所在的目录</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.log.switch-pid</code></td> 
   <td>Sentinel 日志文件名是否需要带上pid</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.servlet.block-page</code></td> 
   <td>自定义的跳转 URL，当请求被限流时会自动跳转至设定好的 URL</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>spring.cloud.sentinel.flow.cold-factor</code></td> 
   <td><a href="https://github.com/alibaba/Sentinel/wiki/%E9%99%90%E6%B5%81---%E5%86%B7%E5%90%AF%E5%8A%A8" rel="nofollow">冷启动因子</a></td> 
   <td>3</td> 
  </tr> 
 </tbody> 
</table>

配置说明如下：  
System.setProperty("project.name", "sentinel-demo");  
System.setProperty("csp.sentinel.dashboard.server", "localhost:8080");

相当于：应用中配置 JVM 启动参数  
\-Dproject.name=sentinel-demo -Dcsp.sentinel.dashboard.server=localhost:8080

**后有之前缓存应用项目时，要控制台中的机器列表去移除无效的 机器。**

## Alibaba Sentinel启动配置项 ##

> **TIPS**
> 
> 参考文档：`https://github.com/alibaba/Sentinel/wiki/启动配置项`

### sentinel-core 配置项 ###

<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</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.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.statistic.max.rt</code></td> 
   <td>最大的有效响应时长（ms），超出此值则按照此值记录</td> 
   <td><code>int</code></td> 
   <td>4900ms</td> 
   <td>否</td> 
   <td>1.4.1 引入</td> 
  </tr> 
 </tbody> 
</table>

其中 `project.name` 项用于指定应用名（appName）。若未指定，则默认从 `sun.java.command` 中解析出对应的类名作为应用名。**实际项目使用中建议指定应用名**。

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

### 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>中提取默认值</td> 
  </tr> 
  <tr> 
   <td><code>csp.sentinel.api.port</code></td> 
   <td>本地启动 HTTP API Server 的端口号</td> 
   <td><code>int</code></td> 
   <td><code>null</code></td> 
   <td>是，且不可冲突</td> 
  </tr> 
 </tbody> 
</table>

### 使用说明 ###

所有参数均可通过 JVM -D 参数指定。除 `project.name` 以及日志的配置项（如 `csp.sentinel.log.dir`）之外，其余参数还可通过 properties 文件指定，路径为 `${user_home}/logs/csp/${project.name}.properties`。

优先级顺序：JVM -D 参数的优先级**最高**，若 properties 和 JVM 参数中有相同项的配置，以 JVM -D 参数配置的为准。

# #

========================

**附上：启动配置项 原文**

## 配置方式 ##

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` 和日志相关配置项）。

> 注：若您的应用为 Spring Boot 或 Spring Cloud 应用，您可以使用 [Spring Cloud Alibaba][]，通过 Spring 配置文件来指定配置，详情请参考 [Spring Cloud Alibaba Sentinel 文档][Spring Cloud Alibaba Sentinel]。

## 配置项列表 ##

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

基础配置项

<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 函数的类名作为应用名。**实际项目使用中建议手动指定应用名**。

日志相关配置项

<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` 来保证不同实例日志的独立性。

### 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，若端口冲突会自动向下探测可用的端口。

[AuthService]: https://github.com/alibaba/Sentinel/blob/master/sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/auth/AuthService.java
[Spring Cloud Alibaba]: https://github.com/alibaba/spring-cloud-alibaba
[Spring Cloud Alibaba Sentinel]: https://github.com/alibaba/spring-cloud-alibaba/wiki/Sentinel