报警通知
当系统发生异常时，自动触发通知，把异常错误消息推送给接收端，目前支持钉钉和企业微信接收异常消息，提前发现系统问题。
服务端使用说明
引用依赖
引入报警服务端依赖和注册中心依赖
mysql存储消息服务
<dependency>
<groupId>com.wueasy</groupId>
<artifactId>wueasy-alarm-server-db</artifactId>
<version>最新版本</version>
</dependency>
mongodb存储消息服务
<dependency>
<groupId>com.wueasy</groupId>
<artifactId>wueasy-alarm-server-mongodb</artifactId>
<version>最新版本</version>
</dependency>
如果是spirng cloud需要引入注册中心客户端
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
修改配置文件
spring应用名称必须为
wueasy-alarm
spring:
application:
name: wueasy-alarm
注册中心配置
spring cloud注册中心
eureka:
instance:
prefer-ip-address: true
lease-expiration-duration-in-seconds: 15 #服务过期时间配置,超过这个时间没有接收到心跳EurekaServer就会将这个实例剔除
lease-renewal-interval-in-seconds: 5 #服务刷新时间配置，每隔这个时间会主动心跳一次
client:
registryFetchIntervalSeconds: 5 #client刷新本地缓存时间
serviceUrl:
defaultZone: http://127.0.0.1:8000/eureka/
feign:
client:
config:
default:
connectTimeout: 5000 #连接超时时间
readTimeout: 5000 #请求与响应的时间间隔阈值
rpc注册中心
wueasy:
zk :
servers : 127.0.0.1:2181
sessionTimeout : 3000
connectionTimeout : 5000
数据库配置
保存报警消息记录，可以选择mongodb或者mysql
mongodb配置
wueasy :
data:
mongodb:
alarm:
uri: mongodb://127.0.0.1:27017/alarm
mysql配置
spring:
datasource:
type: com.zaxxer.hikari.HikariDataSource
url: jdbc:mysql://127.0.0.1:3306/alarm?serverTimezone=Asia/Shanghai&useSSL=false&useUnicode=true&characterEncoding=utf-8
driver-class-name: com.mysql.cj.jdbc.Driver
username: alarm
password: 123456
hikari:
minimum-idle: 5 #池中最小空闲连接数量，默认值10
idle-timeout: 30000 #一个连接idle状态的最大时长（毫秒），超时则被释放（retired），缺省:10s
maximum-pool-size: 15 # 池中最大连接数（包括空闲和正在使用的连接）
auto-commit: true # 是否自动提交池中返回的连接
pool-name: HikariCP # 连接池的名字
max-lifetime: 120000 # 连接池中连接的最大生命周期
connection-timeout: 30000 # 连接超时时间。默认值为30s
connection-test-query: SELECT 1 # 测试连接
redis配置
控制消息推送间隔
wueasy :
data:
redis:
alarm:
database : 11 #数据库索引（默认为0）
host : 127.0.0.1 #服务器地址
port : 6379 #服务器连接端口
password : 123456 #服务器连接密码（默认为空）
pool : #连接池配置
maxIdle : 8 # 连接池中的最大空闲连接，默认值也是8。
minIdle : 0 #连接池中的最小空闲连接，默认值也是0。
maxTotal : 2000 # 如果赋值为-1，则表示不限制；如果pool已经分配了maxActive个jedis实例，则此时pool的状态为exhausted(耗尽)。
maxWaitMillis : 1000 # 等待可用连接的最大时间，单位毫秒，默认值为-1，表示永不超时。如果超过等待时间，则直接抛出JedisConnectionException
timeout : 3000 #连接超时时间（毫秒）
报警推送配置
只能配置推送到一个服务（钉钉或企业微信），可以配置多个群机器人（提高并发量）
server-type：服务类型，支持rpc和springcloud服务，可选：springcloud，rpc，rpc_springcloud
robot-type：机器人类型，可选：dingtalk，weixin
wueasy :
alarm:
server-type: springcloud #服务类型
robot-type: dingtalk #机器人类型
dingtalk-robots: #钉钉推送群机器人配置列表
- access-token: 123 #钉钉推送群access-token，通过推送地址中参数获取
secret: 123 #签名值，群组推送必须设置为签名方式
weixin-robots: #微信推送群机器人配置列表
- key: 123 #企业微信群机器人key，通过推送地址中参数获取
客户端使用说明
处理把本地的错误消息，发送给报警服务端，只需要引入依赖即可。
spring cloud使用说明
需要先引入依赖，然后使用注解标注需要预警的接口
引入依赖包
<dependency>
<groupId>com.wueasy</groupId>
<artifactId>wueasy-alarm-client-cloud</artifactId>
<version>最新版本</version>
</dependency>
注解说明
@Alarm报警注解，需要在方法上，name接口名称，author作者名称，timeoutEnabled是否启用超时预警，timeout超时时间，单位毫秒，descript描述@AlarmParam报警参数注解，需要在参数上，enabled是否启用，禁用后将不会输出参数
使用示例
@Alarm(name = "测试接口",author = "fallsea")： 给方法设置报警信息@AlarmParam(enabled = false) HttpServletRequest request：禁止某些参数输出日志，有些参数是不能转换的，需要设置
@Alarm(name = "测试接口",author = "fallsea")
public Result<String> test(@RequestParam("name")String name,@AlarmParam(enabled = false) HttpServletRequest request,String name2)
{
return new Result<String>().setData(name);
}
rpc使用说明
rpc只需要引入依赖即可
<dependency>
<groupId>com.wueasy</groupId>
<artifactId>wueasy-alarm-client-rpc</artifactId>
<version>最新版本</version>
</dependency>
配置说明
从
6.1.0版本开始，增加报警配置参数，可以通过参数启用报警信息。
wueasy :
alarm:
enabled: true #是否启用报警，默认启用
timeout-enabled: true #接口告警是否启用，默认启用
timeout: 1s #告警提醒时间，默认1秒
thread-pool: #线程池配置
core-pool-size: 4 #核心线程数量，默认4个
max-pool-size: 20 #最大线程数量，默认20
queue-capacity: 1000 #队列容量，默认1000
keep-alive-seconds: 300 #线程活动时间，单位秒，默认300秒