文档首页/ 消息通知服务 SMN/ 用户指南/ 消息传输日志
更新时间：2024-07-30 GMT+08:00
查看PDF
分享

消息传输日志

操作场景

如果您想了解您发布至主题的消息的发送情况，您可以使用消息传输日志功能。该功能支持查看短信、邮件、FunctionGraph（函数）、HTTP、HTTPS等协议的消息发送情况。配置消息传输日志时需要您对接云日志服务，并且已经创建需要关联的云日志组和日志流。关于云日志服务的详细配置和操作方法，请参见《云日志服务用户指南》。

配置云日志

  1. 在“云日志服务”页面创建日志组。
    1. 登录管理控制台。
    2. 在管理控制台左上角单击图标，选择区域和项目。
    3. 在页面左上角单击图标，选择“管理与监管” > “云日志服务”。

      进入云日志服务页面。

    4. 在左侧导航栏，选择“日志管理”。

      进入日志管理页面。

    5. 单击“创建日志组”，在弹出框内，输入日志组名称。
    6. 单击“确定”，创建完成。
  2. 在“云日志服务”界面创建日志流。
    1. 选择已创建的日志组名称，进入该日志组页面。
    2. 单击“创建日志流”，在弹出框内，输入日志流名称。
    3. 单击“确定”，创建完成。

配置消息传输日志

在“消息通知服务”页面配置消息传输日志。

  1. 在创建主题页面配置。
    1. 登录管理控制台。
    2. 在管理控制台左上角单击图标，选择区域和项目。
    3. 在页面左上角单击图标，选择“管理与监管” > “消息通知服务”。

      进入消息通知服务页面。

    4. 在左侧导航栏，选择“主题管理”> “主题”。

      进入主题页面。

    5. 在主题页面，单击需要配置的主题名称。
    6. 在该主题详情页面的“消息传输日志”页签，单击“配置访问日志”。
      图1 消息传输日志
    7. 单击“启动日志记录”，选择您在“云日志服务”中创建的云日志组和日志流。
      图2 配置消息传输日志
    8. 单击“确定”，配置完成。

查看访问日志

当您配置了消息传输日志，可以查看消息传输日志的详细信息。

日志显示格式如下：

{"message_id":"$message_id","project_id":"$project_id","topic_urn":"$topic_urn","subscriber_urn":"$subscriber_urn","protocol_name":"$protocol_name","endpoint":"$endpoint","status":"$status","http_code":$http_code,"create_time":"$create_time","send_time":"$send_time"}

不支持修改日志格式。日志字段说明如表1所示。

表1 字段说明

参数

参数类型

描述

message_id

String

消息ID。

project_id

String

项目ID。

topic_urn

String

Topic的唯一的资源标识

subscriber_urn

String

订阅者的唯一资源标识。

protocol_name

String

不同协议对应不同的endpoint（接受消息的接入点）。目前支持的协议包括：

“email”：邮件传输协议，endpoint为邮箱地址。

“sms”：短信传输协议，endpoint为手机号码。

“functiongraph” FunctionGraph（函数）传输协议，endpoint为一个函数

“functionstage”：。FunctionStage（工作流）传输协议，endpoint为一个函数工作流

“http”、“https”：HTTP/HTTPS传输协议，endpoint为URL。

endpoint

String

接受消息的接入点。

status

String

消息状态。目前包括以下状态：

“DELIVERED”：已送达。

“FAIL_DELIVERED”：发送失败。

“REJECTS”：已拒绝。触发流控机制。

http_code

Integer

HTTP返回码，仅支持HTTP/HTTPS协议消息。

create_time

String

消息创建时间。时间格式为UTC时间，YYYY-MM-DDTHH:MM:SSZ。

send_time

String

消息发送时间。时间格式为UTC时间，YYYY-MM-DDTHH:MM:SSZ。

日志示例

{"message_id":"1ae49922602a42fc83acb9689a2eb5f4","project_id":"5a9f32e4f1ec4bbe9695ff9da51c2925","topic_urn":"urn:smn:regionid:5a9f32e4f1ec4bbe9695ff9da51c2925:demo","subscriber_urn":"urn:smn:regionid:5a9f32e4f1ec4bbe9695ff9da51c2925:demo:b55c3c6fa7cd471b9f24818d530a8740","protocol_name":"https","endpoint":"https://127.0.0.1:443/https","status":"DELIVERED","http_code":200,"create_time":"2022-11-01T00:00:00Z","send_time":"2022-11-01T00:00:10Z"}

以上日志示例对应的字段如下：

表2 日志示例对应的字段

参数

示例

message_id

1ae49922602a42fc83acb9689a2eb5f4

project_id

5a9f32e4f1ec4bbe9695ff9da51c2925

topic_urn

urn:smn:regionid:5a9f32e4f1ec4bbe9695ff9da51c2925:demo

subscriber_urn

urn:smn:regionid:5a9f32e4f1ec4bbe9695ff9da51c2925:demo:b55c3c6fa7cd471b9f24818d530a8740

protocol_name

https

endpoint

https://127.0.0.1:443/https

status

DELIVERED

http_code

200

create_time

2022-11-01T00:00:00Z

send_time

2022-11-01T00:00:10Z