Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

Log Analysis

Updated on 2023-12-20 GMT+08:00

This section describes how to obtain and analyze the API calling logs of a dedicated gateway.

Prerequisites

APIs have been called.

Procedure

  1. Go to the APIG console.
  2. Select a gateway at the top of the navigation pane.
  3. In the navigation pane, choose Monitoring & Analysis > Log Analysis.
  1. Click Configure Log Collection, and change Collect Logs to to enable log collection.
  1. Specify a log group and log stream, and click OK. For details about log groups and log streams, see section "Log Management" in the Log Tank Service User Guide.
  2. Click Log Fields to view the description of each log field. Then view and analyze logs by referring to the log field descriptions.
  3. To export logs, see section "Log Transfer" in the Log Tank Service User Guide.

    Fields in access logs are separated using spaces. The following table describes each log field.

    Table 1 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

    App ID provided by a requester for app authentication.

    6

    time_local

    Time when a request is received.

    7

    request_time

    Request latency.

    8

    request_method

    HTTP request method.

    9

    host

    Domain name.

    10

    router_uri

    Request URI.

    11

    server_protocol

    Request protocol.

    12

    status

    Response status code.

    13

    bytes_sent

    Response size in bytes, including the status line, header, and body.

    14

    request_length

    Request length in bytes, including the start line, header, and body.

    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 to establish a connection with the backend.

    21

    upstream_header_time

    Duration from the start of a connection to the first byte received from the backend.

    22

    upstream_response_time

    Duration from the start of a connection to the last byte received from the backend.

    23

    region_id

    Region ID.

    24

    all_upstream_response_time

    Duration from the start of a connection to the last byte received from the backend, in seconds. When a retry occurs, the value is the total time taken.

    25

    errorType

    API 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. Enabling two-factor authentication will use the custom authorizer ID.

    29

    inner_time

    APIG internal processing duration, 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

    API request body size, in bytes.

    34

    api_name

    API name.

    35

    app_name

    Name of the app used by a requester for authentication.

    36

    provider_app_id

    App ID of an API.

    37

    provider_app_name

    App name of an API.

    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

    Response source. Options:

    • local: APIG
    • remote: backend service

    51

    group_id

    Group ID.

    52

    apig_err_code

    Gateway error code.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback