Viewing API Call Logs

Updated on 2024-05-07 GMT+08:00

View PDF

Overview

View API call logs on the ROMA Connect console.

Procedure

Log in to the ROMA Connect console. On the Instances page, click View Console of an instance.
In the navigation pane on the left, choose API Connect > API Analysis.

Enable log analysis.

On the Access Logs tab page, click Configure Access Log.

In the Configure Access Log dialog box, configure log access information and click OK.

**Table 1** Parameters for configuring access logs
Parameter	Description
Collect Access Logs	Determine whether to enable logging. API call logs can be viewed only after you enable Collect Access Logs.
Log Group	Select the log group to which the log stream belongs. If no log group is available, click View Log Group to switch to the LTS console and create a log group. For details, see Creating a Log Group.
Log Stream	Select the log stream for storing the API call logs. If no log stream is available, click View Log Stream to switch to the LTS console and create a log stream. For details, see Creating a Log Stream.

After the log analysis function is enabled, view the call logs of all open APIs in real time on the console. For details about the log fields, see Log Field Description.
- In the upper right corner of the page, select a time segment.
- Click View Log to go to the LTS console to view log details and download logs locally.
  Custom fields in log details:
  - _resource_id: ROMA Connect instance ID
  - _service_type: source service

Log Field Description

No.	Field	Description
1	remote_addr	Client IP address
2	request_id	Request ID
3	api_id	API ID
4	user_id	Project ID provided by a requester for IAM authentication.
5	app_id	Application ID provided by a requester using App authentication
6	time_local	Request time
7	request_time	Request latency, in seconds
8	request_method	HTTP request method
9	host	Request domain name
10	router_uri	Request URI
11	server_protocol	Request protocol
12	status	Response code
13	bytes_sent	Response size (including the status line, response header, and response body), in bytes
14	request_length	Request length (including the start line, request header, and request body), in bytes
15	http_user_agent	User agent ID
16	http_x_forwarded_for	X-Forwarded-For header field
17	upstream_addr	Backend address
18	upstream_uri	Backend URI
19	upstream_status	Backend response code
20	upstream_connect_time	Time taken for establishing a connection with the backend
21	upstream_header_time	Duration from the beginning of the establishment of a connection to receiving the first byte from the backend, in seconds
22	upstream_response_time	Duration from the beginning of the establishment of a connection to receiving the last byte from the backend, in seconds
23	region_id	AZ ID
24	all_upstream_response_time	Duration from the beginning of the establishment of a connection to receiving the last byte from the backend, in seconds. When a retry occurs, the value is the total time used.
25	errorType	Request error type. Options: 0: non-throttling error 1: throttling error
26	auth_type	API authentication mode
27	access_model1	Authentication mode 1
28	access_model2	Authentication mode 2. When two-factor authentication is enabled, the custom authorizer ID is used.
29	inner_time	Internal processing duration of APIC, in seconds
30	proxy_protocol_vni	VPC endpoint virtual network ID
31	proxy_protocol_vpce_id	VPC endpoint ID
32	proxy_protocol_addr	Client IP address
33	body_bytes_sent	Size of the API request body, in bytes
34	api_name	API name
35	app_name	Name of the application used by the requester when App authentication is used
36	provider_app_id	ID of the application to which the API belongs
37	provider_app_name	Name of the application to which the API belongs
38	custom_data_log1	Custom log field 1
39	custom_data_log2	Custom log field 2
40	custom_data_log3	Custom log field 3
41	custom_data_log4	Custom log field 4
42	custom_data_log5	Custom log field 5
43	custom_data_log6	Custom log field 6
44	custom_data_log7	Custom log field 7
45	custom_data_log8	Custom log field 8
46	custom_data_log9	Custom log field 9
47	custom_data_log10	Custom log field 10
48	response_source	Request response source. Options: local: APIG remote: backend service