如何自定义GCP App Engine日志？添加HTTP查询与响应字段

方法1：通过结构化日志关联请求上下文 #

App Engine自动生成的请求日志会包含trace字段，你可以在代码里生成结构化日志时复用这个trace ID，让自定义日志与自动请求日志关联，同时嵌入查询参数、响应内容等字段。

以Python（Flask框架）为例，其他语言可参照对应日志库实现：

• 先获取当前请求的trace ID：

  from flask import request
  
  def get_trace_id():
      trace_header = request.headers.get('X-Cloud-Trace-Context')
      if trace_header:
          return trace_header.split('/')[0]
      return None
  

• 再生成包含自定义字段的结构化日志：

  from google.cloud import logging
  
  client = logging.Client()
  logger = client.logger('api-custom-logs')
  
  trace_id = get_trace_id()
  # 替换为你的项目ID
  project_id = "your-gcp-project-id"
  
  logger.log_struct(
      {
          'http_request': {
              'request_url': request.url,
              'query_params': request.args.to_dict(),
              'response_status': 200,
              'response_summary': '接口响应内容摘要'  # 避免存储敏感数据
          },
          'severity': 'INFO',
          'trace': f"projects/{project_id}/traces/{trace_id}"
      }
  )
  

在Logs Explorer中，你可以通过trace ID关联自动请求日志与自定义日志，也能直接过滤http_request.query_params等字段进行分析。

方法2：灵活环境下自定义请求日志格式 #

如果你的API运行在App Engine灵活环境，可通过app.yaml配置扩展自动请求日志的格式，直接加入查询参数、响应状态等字段：

runtime: python39
env: flex

logging:
  application_log_level: INFO
  request_log_format: >
    %(remote_addr)s - %(user)s [%(time_local)s] "%(request_method)s %(request_uri)s %(server_protocol)s"
    %(status)s %(body_bytes_sent)s "%(http_referer)s" "%(http_user_agent)s"
    "query_params=%(query_string)s" "response_time=%(request_time)s"

注意：App Engine标准环境不支持自定义请求日志格式，只能使用方法1。

关键注意事项 #

• 禁止在日志中存储敏感数据（如用户密码、认证令牌），需符合GCP数据合规要求。
• 结构化日志中的http_request字段会被Logs Explorer自动识别为标准HTTP日志结构，便于后续的过滤、统计操作。

内容的提问来源于stack exchange，提问作者Denny Ceccon