应用监控与报警

更新时间:2022-01-04 10:04:52

简介

e签宝为用户提供自定义的实时接口监控与报警规则,满足用户实际的业务监控需求。

配置流程

应用监控

操作路径

开发者可登录e签宝官网,点击“控制台”,进入 应用管理 > 我的应用列表,选择待查看监控的应用,点击右侧的“监控”按钮:

查看监控详情

(1)查看接口响应时长:

(2)查看接口调用次数:

(3)查看接口报错(5xx):

应用报警

操作路径

登录e签宝官网,点击“控制台”,进入 应用管理 > 我的应用列表,选择待查看监控的应用,点击右侧的“监控”按钮,选择“应用报警”,点击“新增报警”:

新增报警规则

用户通过实际业务需要,选择待监控的接口地址,配置报警规则,保存后报警规则即生效,产生报警e签宝将通过配置的规则中的通知对象进行通知。

操作界面如下所示:

名词解释

【报警名称】:支持用户自定义的名称;

【监控项】:选择监控的事项,接口响应时长、接口调用次数或接口报错(5xx);

【报警规则】:根据接口配置对应的报警规则,例如当接口响应时长在5分钟内大于5000ms,产生报警事件;

【沉默周期】:指报警发生后如果未恢复正常,间隔多久重复发送一次报警通知;

【通知时间】:设置发送报警短信通知的时间段;

【通知对象】:产生报警后的通知方式与通知对象,支持三种通知方式,短信通知邮件通知接口回调,最多支持设置5个通知对象;

提示

1. 设置发送短信通知对象,短信通知内容模板格式:

【e签宝】xx应用名称(51xxAppId)调用 xx接口调用次数在 x 分钟内的实际值为50次>30次,报警时间 xx-xx-xx

2. 设置接口回调,接口回调功能可以将e签宝发送的报警通知集成到开发者自身的业务通知系统中,报警事件产生后,e签宝将通过POST请求向开发者指定的公网可访问的URL中推送消息,回调通知事件请查看文档末附一

取消报警

用户想取消报警,可选择“禁用”报警规则,禁用后的报警规则可随时“开启”和“编辑”:

附一:接口回调通知

回调参数格式

参数名称

参数类型

类型

说明

condition

body

string

条件

period

body

string

监控周期

appName

body

string

应用名称

appId

body

string

应用AppId

eventTime

body

string

报警事件发生时间

actualValue

body

string

实际值

threshold

body

string

阈值

api

body

string

接口地址

monitorItem

body

string

监控项

回调示例

{
    "condition":">",
    "period":"5分钟",
    "appName":"xx企业应用",
    "appId":"511xxx",
    "eventTime":"2021-xx-xx 00:00:00",
    "actualValue":"1050次",
    "threshold":"1000次",
    "api":"/v1/accounts/createByThirdPartyUserId",
    "monitorItem":"接口调用次数"
}
我要纠错