Sentinel（十七）之启动配置项

今天药忘吃喽~ 2023-01-08 06:28 189阅读 0赞

转载自  [启动配置项][Link 1]

## 配置方式 ##

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>代表输出至文件，<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>中提取默认值</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，若端口冲突会自动向下探测可用的端口。

[Link 1]: https://github.com/alibaba/Sentinel/wiki/%E5%90%AF%E5%8A%A8%E9%85%8D%E7%BD%AE%E9%A1%B9
[Spring Cloud Alibaba]: https://github.com/alibaba/spring-cloud-alibaba
[Spring Cloud Alibaba Sentinel]: https://github.com/alibaba/spring-cloud-alibaba/wiki/Sentinel