将应用接入AHAS应用防护时,您可以在启动命令中修改客户端启动参数来控制客户端行为。本文分别介绍了AHAS支持的客户端启动参数、SDK启动参数和Java Agent启动参数。

客户端启动参数

名称 含义 类型 默认值 备注
-Dproject.name 指定应用的名称,会显示在AHAS应用防护的应用列表中。 String Main函数所在的类全名 非必需,建议配置。
-Dcsp.sentinel.app.type 指定应用的类型。 Int 0 (APP_TYPE_COMMON) 非必需,1.3.0+版本支持,一般不需要手动配置。
-Dcsp.sentinel.metric.file.single.size 单个监控日志文件的大小。 Long 52428800(50MB) 非必需
-Dcsp.sentinel.metric.file.total.count 监控日志文件的总数上限。 Int 6 非必需
-Dcsp.sentinel.statistic.max.rt 最大的有效响应时长(ms),超出此值则按照此值记录。 Int 4900 非必需
-Dcsp.sentinel.log.dir Sentinel日志文件目录。 String ${user.home}/logs/csp/ 非必需
-Dcsp.sentinel.log.use.pid 日志文件名中是否加入进程号,用于单机部署多个应用的情况。 Boolean false 非必需
-Dcsp.sentinel.log.output.type Record日志输出的类型,file代表输出至文件,console代表输出至终端。 String file 非必需,1.3.6+版本支持。
-Dcsp.sentinel.heartbeat.interval.ms 心跳包发送周期,单位ms。 Long 5s 非必需,若不进行配置,则会从相应的HeartbeatSender中提取默认值。
-Dcsp.sentinel.web.servlet.block.page 限流页。 String null 非必需
-Dcsp.sentinel.url.clean.config.path URL收敛规则配置文件路径。 String 非必需
-Dcsp.sentinel.url.suffix.exclude.pattern 收敛的URL后缀。 String png,gif,mjs,css,htm,html,jpg,jpeg,map,ico,ttf,woff 非必需
说明 列表中的版本信息即ahas-sentinel-client的版本。

SDK启动参数

AHAS支持的Spring Boot starter配置项如下表。

说明 以下配置项需配置到application.properties配置文件中。
配置项 描述 默认值
spring.cloud.ahas.sentinel.aspectj.enabled 自动开启注解支持 true
spring.cloud.ahas.sentinel.mybatis.enabled 自动开启MyBatis埋点支持 true
spring.cloud.ahas.sentinel.web.enabled 自动开启Spring Web埋点支持 true
spring.cloud.ahas.sentinel.web.http-method-prefix Web埋点带上HTTP method前缀(since 1.5.3) false

Java Agent启动参数

传入参数方式:-D参数。

参数 控制的插件 默认状态
ahas.sentinel.agent.plugin.web.spring.enabled Spring Web插件 开启
ahas.sentinel.agent.plugin.mybatis.enabled MyBatis插件 开启
ahas.sentinel.agent.plugin.dubbo.enabled Dubbo插件 开启
ahas.sentinel.agent.plugin.grpc.enabled gRPC插件 开启
ahas.sentinel.agent.plugin.gateway.enabled API gateway插件 开启
ahas.sentinel.agent.plugin.web.servlet.enabled Web Servlet插件 关闭
ahas.sentinel.agent.plugin.db.enabled 所有JDBC插件 关闭
ahas.sentinel.agent.plugin.cache.enabled 所有cache插件 关闭
ahas.sentinel.agent.plugin.mq.enabled 所有MQ client插件 关闭

示例:

-Dahas.sentinel.agent.plugin.web.servlet.enabled=false