查看 Message Desk 函数日志

2024-09-05

本文档主要介绍新版 Message Desk 中产生的函数日志

1. 简介

与其他 DataFlux Func 中执行的函数一样，当配置了函数日志上报至观测云后，新版 Message Desk 的日志同样可以方便地在观测云平台查询。

有关如何配置函数日志上报到观测云，以及上报的各字段说明，请参考 手册 / 部署和维护 / 上报自观测数据到观测云

2. 基础查询

Message Desk 会上报完整的日志，并允许通过不同需要来查询日志

• 如需要查询单条发送情况，请根据「消息结果日志」方式查询日志
• 如需要查询消息发送函数任务本身的日志，请根据「函数执行日志」方式查询日志

消息结果日志函数执行日志

关键字段：

字段	类型	说明
message_type	enum	消息任务类型，详细见下文 X. 消息类型
message_type_name	enum	消息任务类型中文名，详细见下文 X. 消息类型
exception_type	str	错误类型，如：邮件地址列入黑名单 "AddressInBlackList"
exception_text	str	错误信息
与消息类型相关的其他字段	-

在观测云「日志查看器」中，填写如下过滤条件，即可筛选出所有 Message Desk 的消息发送日志：

source:MD_send_result

如果需要查看特定类型消息的日志，增加 message_tye 过滤条件，如：

source:MD_send_result message_type:mail

如果需要查看指定集群的日志，增加 site_name 过滤条件，如：

source:MD_send_result site_name:cn1

如果只想查看错误日志，增加 status 过滤条件，如：

source:MD_send_result -status:ok

关键字段：

字段	类型	说明
message_type	enum	消息任务类型，详细见下文 X. 消息类型
message_type_name	enum	消息任务类型中文名，详细见下文 X. 消息类型
exception_type	str	错误类型，如：邮件发送错误 "MailSendingFailure"
exception_text	str	错误信息

在观测云「日志查看器」中，填写如下过滤条件，即可筛选出所有 Message Desk 的执行日志：

source:DFF_task_record_func script_id:message_desk__api

如果需要查看特定类型消息的日志，增加 message_tye 过滤条件，如：

source:DFF_task_record_func script_id:message_desk__api message_type:mail

如果需要查看指定集群的日志，增加 site_name 过滤条件，如：

source:DFF_task_record_func script_id:message_desk__api site_name:cn1

如果只想查看错误日志，增加 status 过滤条件，如：

source:DFF_task_record_func script_id:message_desk__api -status:ok

3. 常用查询条件

以下为常用的查询条件，请将查询条件复制到观测云「日志查看器」过滤栏中进行搜索

消息结果日志

全部邮件钉钉飞书企业微信HTTP 请求极光推送短信

不同消息类型支持额外的字段，具体请选择一种消息类型

全部消息发送结果：

source:MD_send_result

消息发送失败结果：

source:MD_send_result -status:ok

此消息类型额外支持的字段：

字段	类型	说明
address	str	邮件地址
title	str	标题
attachment	str JSON	附件信息 仅包含附件的邮件存在此字段
error	str	邮件失败原因 仅失败邮件存在此字段

全部发送结果：

source:MD_send_result message_type:mail

指定邮件地址：

source:MD_send_result message_type:mail address:zyl@jiagouyun.com

搜索邮件地址（使用*搜索）：

source:MD_send_result message_type:mail address:*jiagouyun*

消息发送失败结果：

source:MD_send_result message_type:mail -status:ok

此消息类型额外支持的字段：

字段	类型	说明
webhook	str	机器人 Webhook 地址
title	str	消息标题
status_code	str	响应状态码
response	str	响应内容

全部发送结果：

source:MD_send_result message_type:dingtalk

指定 Webhook 地址：

source:MD_send_result message_type:dingtalk webhook:https\://oapi.dingtalk.com/robot/send?access_token=xxxxx*

消息发送失败结果：

source:MD_send_result message_type:dingtalk -status:ok

此消息类型额外支持的字段：

字段	类型	说明
webhook	str	机器人 Webhook 地址
title	str	消息标题
status_code	str	响应状态码
response	str	响应内容

全部发送结果：

source:MD_send_result message_type:feishu

指定 Webhook 地址：

source:MD_send_result message_type:feishu webhook:https\://open.feishu.cn/open-apis/bot/v2/hook/xxxxx

消息发送失败结果：

source:MD_send_result message_type:feishu -status:ok

此消息类型额外支持的字段：

字段	类型	说明
webhook	str	机器人 Webhook 地址
status_code	str	响应状态码
response	str	响应内容

全部发送结果：

source:MD_send_result message_type:wechat

指定 Webhook 地址：

source:MD_send_result message_type:wechat webhook:https\://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxx

消息发送失败结果：

source:MD_send_result message_type:wechat -status:ok

此消息类型额外支持的字段：

字段	类型	说明
method	str	请求方法，如："GET"
url	str	请求 URL
status_code	str	响应状态码
response	str	响应内容

全部发送结果：

source:MD_send_result message_type:httpRequest

指定 URL 地址：

source:MD_send_result message_type:httpRequest url:http\://guance.com/api/v1/xxxxx

消息发送失败结果：

source:MD_send_result message_type:httpRequest -status:ok

此消息类型额外支持的字段：

字段	类型	说明
title	str	消息标题
api_url	str	请求 API URL
status_code	str	响应状态码
response	str	响应内容

全部发送结果：

source:MD_send_result message_type:jiguang

消息发送失败结果：

source:MD_send_result message_type:jiguang -status:ok

此消息类型额外支持的字段：

字段	类型	说明
mobiles	str	逗号分隔的手机号
template_code	str	短信模板
status_code	str	响应状态码
response	str	响应内容

全部发送结果：

source:MD_send_result message_type:sms

指定手机号：

注意：批量发送短信为单次阿里云 API 调用，且手机号为逗号分隔字符串，因此需要添加*避免遗漏

source:MD_send_result message_type:sms mobiles:*18600000000*

消息发送失败结果：

source:MD_send_result message_type:sms -status:ok

函数执行日志

全部邮件钉钉飞书企业微信HTTP 请求极光推送短信

全部函数执行日志：

source:DFF_task_record_func script_set_id:message_desk

函数执行失败日志：

source:DFF_task_record_func script_set_id:message_desk -status:ok

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_mail*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_mail* -status:ok

阿里云邮件失败记录定期同步日志：

这里是「阿里云平台能查询到的发送失败记录」，不是「定期同步执行失败」

source:DFF_task_record_func func_id:message_desk__api_internal.sync_black_list

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_dingtalk*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_dingtalk* -status:ok

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_feishu*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_feishu* -status:ok

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_wechat*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_wechat* -status:ok

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_http_request*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_http_request* -status:ok

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_jiguang*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_jiguang* -status:ok

函数执行日志：

source:DFF_task_record_func func_id:message_desk__api.send_sms*

函数执行失败日志：

source:DFF_task_record_func func_id:message_desk__api.send_sms* -status:ok

X. 消息类型

Message Desk 支持的消息类型 / 名称，与对应的 message_type、message_type_name 值如下：

消息类型名称 message_type_name	消息类型 message_type
邮件	"mail"
钉钉机器人	"dingtalk"
飞书机器人	"feishu"
企业微信机器人	"wechat"
HTTP 请求	"httpRequest"
极光推送	"jiguang"
短信	"sms"