客户端启动参数

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

客户端启动参数

名称含义类型默认值备注
-Dproject.name指定应用的名称,会显示在AHAS应用防护的应用列表中。StringMain函数所在的类全名非必需,建议配置。
-Dcsp.sentinel.app.type指定应用的类型。Int0 (APP_TYPE_COMMON)非必需,1.3.0+版本支持,一般不需要手动配置。
-Dcsp.sentinel.metric.file.single.size单个监控日志文件的大小。Long52428800(50MB)非必需
-Dcsp.sentinel.metric.file.total.count监控日志文件的总数上限。Int6非必需
-Dcsp.sentinel.statistic.max.rt最大的有效响应时长(ms),超出此值则按照此值记录。Int4900非必需
-Dcsp.sentinel.log.dirSentinel日志文件目录。String${user.home}/logs/csp/非必需
-Dcsp.sentinel.log.use.pid日志文件名中是否加入进程号,用于单机部署多个应用的情况。Booleanfalse非必需
-Dcsp.sentinel.log.output.typeRecord日志输出的类型,file代表输出至文件,console代表输出至终端。Stringfile非必需,1.3.6+版本支持。
-Dcsp.sentinel.heartbeat.interval.ms心跳包发送周期,单位ms。Long5ms非必需,若不进行配置,则会从相应的HeartbeatSender中提取默认值。
-Dcsp.sentinel.web.servlet.block.page限流页。Stringnull非必需
-Dcsp.sentinel.url.clean.config.pathURL收敛规则配置文件路径。String非必需
-Dcsp.sentinel.url.suffix.exclude.pattern收敛的URL后缀。Stringpng,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-prefixWeb埋点带上HTTP method前缀(since 1.5.3)false

Java Agent启动参数

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

参数控制的插件默认状态
ahas.sentinel.agent.plugin.web.spring.enabledSpring Web插件开启
ahas.sentinel.agent.plugin.mybatis.enabledMyBatis插件开启
ahas.sentinel.agent.plugin.dubbo.enabledDubbo插件开启
ahas.sentinel.agent.plugin.grpc.enabledgRPC插件开启
ahas.sentinel.agent.plugin.gateway.enabledAPI gateway插件开启
ahas.sentinel.agent.plugin.web.servlet.enabledWeb 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