GetTraceLog--应用性能监控全链路版-火山引擎

文档中心

导航

GetTraceLog

最近更新时间：2024.12.06 11:55:09首次发布时间：2022.10.14 11:52:07

查询单点日志。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=AppTraceLogs&Version=2022-10-12

ServiceName : apmplus_openapi
Region : cn-beijing 
X-App-Ids : xxx
Content-Type : application/json

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AppTraceLogs`	接口名称。当前 API 的名称为 `AppTraceLogs`。
Version	String	是	`2022-10-12`	接口版本。当前 API 的版本为 `2022-10-12`。

Body

参数	类型	是否必选	示例值	描述
id_type	String	是	`bddid`	trace ID类型。 bddid：设备ID ssid：session ID user_id：用户ID
id_value	String	是	`12345`	trace ID值。
start_time	Long	是	`1668415078`	trace起始时间，长度为10位，单位为秒（s）。
end_time	Long	是	`1668415678`	trace终止时间，长度为10位，单位为秒（s）。
log_types	Array of Integer	否	`15`	查询日志类型。 1：崩溃日志 4：卡顿日志 6：启动日志 15：事件日志

返回参数

参数	类型	示例值	描述
data	Object of TraceLogResonseData	`-`	trace详情。
error_msg	String	`""`	错误信息，成功为`""`。
error_no	Integer	`0`	错误码，成功为0。

TraceLogResonseData

参数	类型	示例值	描述
control	Object of Control	`-`	下一次trace起始信息。
trace_logs	Array of Log	`-`	trace日志。

Control

参数	类型	示例值	描述
next_timestamp	Long	`1668415078000`	下次load的时间戳。

Log

参数	类型	示例值	描述
os	String	`iOS`	操作系统。
tag	JSON Map	`null`	标签。
data	String	`-`	日志内容，可能是文本，也可能是json对象。
type	String	`crash`	日志类型。
label	String	`native崩溃`	日志标签。
header	JSON Map	`-`	日志头。
event_id	String	`7fc361f****2b2436`	事件ID。
issue_id	String	`-`	issue ID。
crash_type	String	`-`	崩溃类型。
raw_log_key	String	`[perf_log]event_log_iOS_12345_7fc361f****2b2436`	日志密钥。
dump_tos_key	String	`-`	跳转密钥。
event_timestamp	Long	`1668443877607`	事件发生微秒时间戳。
server_timestamp	Long	`1668606448000`	服务端接受日志的微秒时间戳。

Tag

参数	类型	示例值	描述
key	String	`-`	标签定义的key。
value	String

Header

参数	类型	示例值	描述
key	String	`-`	日志头的key。
value	String

请求示例

POST https://open.volcengineapi.com?Action=AppTraceLogs&Version=2022-10-12
{
    "id_type": "user_id",
    "id_value": "test_dddd",
    "start_time": 1658811276,
    "end_time": 1658840076,
    "log_types": [
        15
    ]
}

返回示例

{
    "err_detail": "",
    "data": {
        "trace_logs": [
            {
                "event_timestamp": 1658838421438,
                "server_timestamp": 1658838423000,
                "label": "事件分析",
                "type": "app_event",
                "header": null,
                "data": "{\n    \"aid\": \"12345\",\n    \"app_version\": \"1.0.2\",\n    \"dimension\": {\n        \"sdkType\": \"E\"\n    },\n    \"event_name\": \"sdk_event\",\n    \"extraValue\": {\n        \"extra1\": \"extravalue\"\n    },\n    \"inapp_time\": 0.21227025985717773,\n    \"metrics\": {\n        \"sdkVersionCode\": 50203\n    },\n    \"network_type\": 4,\n    \"os_version\": \"15.5\",\n    \"sdk_version\": \"1.0.2\",\n    \"seq_no_type\": 139,\n    \"session_id\": \"92D4139B-A1FE-4FF2-B392-67A29440FD42\",\n    \"timestamp\": 1658838421438,\n    \"update_version_code\": \"1\"\n}",
                "tag": null,
                "raw_log_key": "[perf_log]event_log_iOS_12345_7fc361f****2b2436",
                "os": "iOS",
                "event_id": "7fc361f****2b2436",
                "issue_id": "",
                "crash_type": "",
                "dump_tos_key": ""
            }
        ],
        "control": {
            "next_timestamp": 1658837175000
        }
    },
    "error_msg": "",
    "error_no": 0
}

错误码

本接口无特有的错误码。更多信息请参见错误码。