You need to enable JavaScript to run this app.
导航
错误新增报警
最近更新时间:2023.11.23 17:10:20首次发布时间:2022.10.14 17:14:02

该页面用于监测新增的错误,并进行报警,帮助您关注和查看不同版本中新增的错误。

新建报警任务

操作步骤

  1. 登录应用性能监控全链路版控制台

  2. 单击目标应用下的webpro端监控

  3. 在控制台左上角选择全部功能 > 错误新增报警

  4. 在错误新增报警页面,单击新建报警任务
    图片

    参数说明:

    配置区域

    参数

    说明

    报警基本信息

    报警任务名称

    自定义名称,用于标识报警任务。

    报警级别

    支持Warning、Fatal两个级别。

    • Warning:警告
    • Fatal:严重

    报警说明

    描述该报警任务的目的以及发生报警后的处理方案或其他信息。

    制定报警策略

    报警类型

    已支持的报警类型:JS错误静态资源错误请求错误

    报警策略

    • 报警策略生效的版本。
      • 最新版本:选择最新版本,错误首次出现,则报警。
        示例场景:历史版本为1.0,最新版本为2.0。历史版本1.0中有一个已知错误。
        策略配置为最新版本,那么这个已知错误不会报警。
      • 指定版本:选择指定的版本。在指定的版本中,错误首次出现,则报警。
        示例场景:历史版本为1.0,最新版本为2.0。历史版本1.0中有一个已知错误。
        指定版本包括2.0、不包括1.0,那么这个已知错误会报警。
      • 全部版本:选择全部版本,需要配置错误在几天内首次出现,则报警。
        示例场景:历史版本为1.0,最新版本为2.0。历史版本1.0中有一个已知错误。
        策略配置为全部版本中错误在7天内首次出现则报警,那么这个已知错误不会报警。
    • 筛选条件:添加筛选条件。
    • 样本量阈值:上报的样本量达到一定数量,才会触发报警,避免样本过少,报警不具有代表性。
    • 用户量阈值:上报的用户数达到一定数量,才会触发报警,避免用户过少,报警不具有代表性。

    配置通知受众

    报警方式

    支持通过飞书邮件企业微信钉钉报警回调进行报警。

    飞书webhook

    输入飞书webhook。当报警方式选择飞书时,此项必填。
    webhook配置详见如何进行webhook配置?

    飞书需要@的人

    按照User ID或者Open ID配置报警通知的飞书用户。当报警方式选择飞书时,此项选填。
    User ID和Open ID的获取方法,请参见如何获取User ID、Open ID和Union ID

    注意

    通知的个人必须和群机器人在一个群里。
    请确保User ID和Open ID正确,否则,通知将无法推送给该用户。

    邮件通知组

    配置邮件通知的接收组。当报警方式选择邮件时,此项必填。

    企业微信webhook

    输入企业微信webhook。当报警方式选择企业微信时,此项必填。
    webhook配置详见如何进行webhook配置?

    企业微信需要@的人

    按照手机号或者User ID配置报警通知的企业微信用户。当报警方式选择企业微信时,此项选填。

    注意

    通知的个人必须和群机器人在一个群里。

    钉钉webhook

    输入钉钉webhook。当报警方式选择钉钉时,此项必填。
    webhook配置详见如何进行webhook配置?

    钉钉需要@的人

    按照手机号或者User ID配置报警通知的钉钉用户。当报警方式选择钉钉时,此项选填。
    User ID的获取方法,请参见User ID

    注意

    通知的个人必须和群机器人在一个群里。

    报警回调webhook

    输入报警回调webhook。当报警方式选择报警回调时,此项必填。

结果验证

报警任务新建完成后,在各通知平台上查看报警信息。以下是飞书webhook的示例报警信息。

错误类型

报警信息

静态资源错误

图片

JS错误

图片

请求错误

图片

报警返回

request body字段

request body中以JSON格式包含回调信息,具体字段:

字段

类型

示例值

说明

title

string

APMPlus报警

错误新增报警任务的名称。

content

object

-

错误新增报警任务触发后回调的内容。

  • 1:没有返回内容。
  • 有返回内容,具体请参见content数据结构

content数据结构

字段

类型

示例值

说明

alert_param

object

-

错误新增报警任务里配置的参数。具体请参见alert_param数据结构

alert_result

object

-

错误新增报警的返回结果。具体请参见alert_result数据结构

aid

int

123456

App ID。

alert_param数据结构

字段

类型

示例值

说明

alert_language

string

zh

错误新增报警的语言。

alarm_level

string

warning

错误新增报警的级别。

  • warning:警告
  • fatal:严重

alert_strategy

object

-

错误新增报警的策略。

callback_urls

array

-

错误新增报警任务配置的报警回调。

dingding_at_conf

object

-

错误新增报警任务配置的钉钉账号信息。

dingding_webhooks

array

-

错误新增报警任务配置的钉钉webhook地址。

feedback_duty_name

string

-

返回任务名称。

id

int

766

错误新增报警ID。

is_close

boolean

false

是否关闭报警。

  • true:开启
  • false:关闭

lark_at_conf

object

-

错误新增报警任务配置的飞书账号信息。

lark_webhooks

array

-

错误新增报警任务配置的飞书webhook地址。

mail_groups

array

-

错误新增报警任务配置的邮件通知组。

methods

array

-

错误新增报警的通知方式。

  • callback_url:报警回调
  • we_chat_webhook:企业微信
  • dingding_webhook:钉钉
  • lark_webhook:飞书
  • mail_group:邮件

name

array

\u8c03

报警策略列表。

note

string

-

报警多策略关系。

  • and:同时满足所有策略
  • or:满足任一策略

we_chat_webhooks

array

-

错误新增报警任务配置的企业微信webhook地址。

wechat_at_conf

array

-

错误新增报警任务配置的企业微信账号信息。

alert_result数据结构

字段

类型

示例值

说明

detail_link

string

https://console.bytedance.net/apmplus/webpro/data_search?aid=123456&end_time=1693309723&ev_type=js_error&filter_id=xxx&start_time=1693309123

错误新增报警的链接。单击链接可以跳转到控制台该新增错误的报警信息页面。

details

object

-

新增错误报警的详细信息。

history_link

string

https://console.bytedance.net/apmplus/webpro/alarm_new_error/detail?aid=123456&rule_id=xxx&rule_name=xxx&status=true&time=xxx

历史错误报警的链接。

sample_count

int

1

样本数。

strategy

string

JS\u9519\u8bef

错误新增报警的类别。

user_count

int

1

用户数。

错误新增报警列表

错误新增报警列表展示了检测新增错误的报警任务,包括任务名称、创建人、报警级别、报警方式、报警规则摘要、最近更新时间、最近一个月报警次数、监控状态。
图片

  • 单击任务名称,可以在任务详情中快速添加筛选条件。
  • 报警规则摘要列,可以查看指定版本的版本号。
  • 操作列,单击编辑,可以重新配置该错误新增报警任务。
  • 操作列,单击报警详情,可以查看该错误新增报警的请求错误详情。

请求错误详情

请求错误详情页面展示了报警情况概览和报警历史列表。
图片

  • 报警情况概览:展示了所选时间范围内报警情况的趋势图。
  • 报警列表:展示了历史报警内容、报警时间、报警详情、报警方式和创建人。
  • 报警详情:单击可以跳转到数据探索。
    • JS错误报警:可以查看该issue_id在JS Errors中的详细数据。
    • 静态资源错误报警:可以查看该issue_id在Resource Errors中的详细数据。
    • 请求错误报警:可以查看该请求路径和请求状态码在Requests中的详细数据。