Viewing the Log Dashboard

Download

Focus Mode

Font Size

Last updated: 2026-09-22 18:32:11

AI-Translated

Scenarios
The cloud-native gateway provides an out-of-the-box CLS log dashboard. If you have enabled CLS log shipping, you can use the log analysis dashboard to quickly analyze access logs and error logs shipped to CLS. (Supported by Professional Edition only)
The log dashboard supports the following scenarios:
Status code analysis
Request quality analysis
Request duration analysis
Error log analysis
User behavior analysis
Business analysis
This document describes how to use the log dashboard feature of the Cloud Native Gateway.
Prerequisites
1. The cloud-native gateway instance has been created. For specific operations, see Create Cloud-Native Gateway.
2. CLS is activated.
3. Log shipping to CLS is enabled. For details, see Log Shipping to CLS.
4. The log format is JSON. If the log format is single-line text, change it to JSON. For specific operations, see Editing CLS Log Rules.
5. Fields listed in the following table are added to log rules since the dashboard depends on some log fields to display dashboard data.
Field Name
Field Value
status
$status
ups_status
$upstream_status
client
$remote_addr
req_time
$request_time
ups_rsp_time
$upstream_response_time
referer
$http_referer
method
$request_method
host
$host
uri
$uri
ups_ip
$upstream_addr
Operation Steps
1. Log in to the  TSF console.
2. In the left sidebar, click Cloud Native Gateway. Select the target gateway instance, go to the instance details page, select the Data Observation tab, and then click the Log Dashboard tab.
Supported Metrics and Their Meanings
Status Code Analysis
Metric Name
Metric Meaning
Client status code distribution
Distribution of status codes returned from the gateway to the client
Number of 2xx requests
Number of requests with the 2xx status code received by the client
Number of 5xx requests
Number of requests with the 5xx status code received by the client
Request failure rate trend
Trend of the gateway request failure rate
2xx error code ratio
Ratio of requests with the 2xx status code received by the client to the total number of requests
5xx error code ratio
Ratio of requests with the 5xx status code received by the client to the total number of requests
Backend service status code distribution
Distribution of status codes returned from the backend service to the gateway
Backend service failure count
Number of requests failed to be sent to the backend service (4xx and 5xx)
Backend service failure rate trend
Trend of the number of failed requests (4xx and 5xx) received by the backend service.
Request Quality Analysis
Metric Name
Metric Meaning
Total number of requests
Total number of requests, summed based on the selected time granularity
Request count trend
Trend of the number of requests
Request region distribution
Geographic distribution of clients' IP addresses
Request duration analysis
Metric Name
Metric Meaning
Request duration trend
Trend of the request duration
Backend response duration trend
Trend of the backend service response duration
Error Log Analysis
Metric Name
Metric Meaning
Error log quantity
Total number of error logs occurred within the selected time range
Error log trend
Trend of the total number of error logs within the selected time range
Error logs
Details of error logs occurred within the selected time range
User behavior analysis
Metric Name
Metric Meaning
HTTP Referer distribution
HTTP Referer distribution
Request method distribution
Request method distribution
Host distribution
Host distribution
Business Analysis
Metric Name
Metric Meaning
Top 10 APIs by the calling volume
Top 10 APIs by the calling volume within the selected time range
Top 10 APIs by the failure rate
Top 10 APIs by the failure rate within the selected time range
Top 10 services by the calling volume
Top 10 backend services by the calling volume within the selected time range
Top 10 services by the failure rate
Top 10 backend services by the failure rate within the selected time range
Top 10 request hosts
Top 10 hosts by request quantity within the selected time range

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Native Intelligent Gateway

Viewing the Log Dashboard

Scenarios

Prerequisites

Operation Steps

Supported Metrics and Their Meanings

Status Code Analysis

Request Quality Analysis

Request duration analysis

Error Log Analysis

User behavior analysis

Business Analysis

Help and Support

Field Name	Field Value
status	$status
ups_status	$upstream_status
client	$remote_addr
req_time	$request_time
ups_rsp_time	$upstream_response_time
referer	$http_referer
method	$request_method
host	$host
uri	$uri
ups_ip	$upstream_addr

Metric Name	Metric Meaning
Client status code distribution	Distribution of status codes returned from the gateway to the client
Number of 2xx requests	Number of requests with the 2xx status code received by the client
Number of 5xx requests	Number of requests with the 5xx status code received by the client
Request failure rate trend	Trend of the gateway request failure rate
2xx error code ratio	Ratio of requests with the 2xx status code received by the client to the total number of requests
5xx error code ratio	Ratio of requests with the 5xx status code received by the client to the total number of requests
Backend service status code distribution	Distribution of status codes returned from the backend service to the gateway
Backend service failure count	Number of requests failed to be sent to the backend service (4xx and 5xx)
Backend service failure rate trend	Trend of the number of failed requests (4xx and 5xx) received by the backend service.

Metric Name	Metric Meaning
Total number of requests	Total number of requests, summed based on the selected time granularity
Request count trend	Trend of the number of requests
Request region distribution	Geographic distribution of clients' IP addresses

Metric Name	Metric Meaning
Request duration trend	Trend of the request duration
Backend response duration trend	Trend of the backend service response duration

Metric Name	Metric Meaning
Error log quantity	Total number of error logs occurred within the selected time range
Error log trend	Trend of the total number of error logs within the selected time range
Error logs	Details of error logs occurred within the selected time range

Metric Name	Metric Meaning
HTTP Referer distribution	HTTP Referer distribution
Request method distribution	Request method distribution
Host distribution	Host distribution

Metric Name	Metric Meaning
Top 10 APIs by the calling volume	Top 10 APIs by the calling volume within the selected time range
Top 10 APIs by the failure rate	Top 10 APIs by the failure rate within the selected time range
Top 10 services by the calling volume	Top 10 backend services by the calling volume within the selected time range
Top 10 services by the failure rate	Top 10 backend services by the failure rate within the selected time range
Top 10 request hosts	Top 10 hosts by request quantity within the selected time range