Updated on 2023-11-10 GMT+08:00

Trace Structure

A trace consists of multiple key fields shown in Table 1.

  • This section describes the key trace fields displayed on the CTS console.
  • When some fields are displayed on the CTS console, their formats are optimized for easy understanding.
Table 1 Key trace fields

Field

Mandatory

Type

Description

time

Yes

Date

Time when a trace occurred

When the field is displayed on the console, its value is the local standard time (in GMT time), for example, Dec 8, 2016 11:24:04 GMT+08:00. However, this field is transmitted and stored as a timestamp in APIs. In this case, the value is the number of milliseconds since 00:00:00 on January 1, 1970 (GMT).

user

Yes

Structure

Cloud account used to perform an operation

The value is also displayed in the Operator column on the Trace List page.

This field is transmitted and stored as a string in APIs.

request

No

Structure

Requested operation

This field is transmitted and stored as a string in APIs.

response

No

Structure

Response to a request

This field is transmitted and stored as a string in APIs.

service_type

Yes

String

Operation source

resource_type

Yes

String

Resource type

resource_name

No

String

Resource name

resource_id

No

String

Unique resource ID

source_ip

Yes

String

IP address of the user that performed an operation

The value of this field is empty if the operation was triggered by system.

trace_name

Yes

String

Operation name

trace_rating

Yes

String

Trace status. The value can be normal, warning, or incident.

  • normal: The operation succeeded.
  • warning: The operation failed.
  • incident: The operation caused a serious consequence, for example, a node failure or service interruption.

trace_type

Yes

String

Operation type

There are three types of operations:

  • ConsoleAction: operations performed on the management console
  • SystemAction: operations triggered by system
  • ApiCall: operations triggered by calling API Gateway

api_version

No

String

Version of the cloud service API which was called to perform an operation

message

No

Structure

Remarks

record_time

Yes

Number

Time when the operation was recorded, in the form of a timestamp

trace_id

Yes

String

Unique operation ID

code

No

Number

HTTP return code, such as 200 or 400

request_id

No

String

ID of a recorded request

location_info

No

String

Information required for fault locating after a request error

endpoint

No

String

Endpoint in the detail page URL of the cloud resource on which a recorded operation was performed

resource_url

No

String

Detail page URL (excluding the endpoint) of the cloud resource on which a recorded operation was performed