📝 日志配置指南

📖 简介

日志系统是应用程序的重要组成部分，它帮助我们追踪系统运行状态、排查问题和监控性能。本指南将帮助您了解如何在Go Gateway中配置和使用日志功能。

为什么需要日志？

问题排查和调试
系统运行状态监控
安全审计和追踪
性能分析和优化

⚙️ 基础配置

日志级别配置

yaml

log:
  level: debug  # 日志级别
  max-size: 100 # 日志文件最大大小（MB）
  max-backups: 100 # 最大保留的旧日志文件数量
  max-age: 100 # 最大保留天数

配置参数说明

参数名	类型	说明	默认值	是否必填
level	String	日志级别，可选值：debug/info/warn/error	info	否
max-size	Integer	单个日志文件最大大小，单位：MB	100	否
max-backups	Integer	最大保留的旧日志文件数量	100	否
max-age	Integer	日志文件最大保留天数	100	否

敏感信息脱敏配置

yaml

log:
  sensitive: # 脱敏配置
    field-rules: # 脱敏规则
    - field-names: # 字段名列表
      - password
      - idCard
      - phone
      - email
      type: password # 脱敏类型
    max-length: 100 # 单个参数值最大长度

脱敏配置参数说明

参数名	类型	说明	默认值	是否必填
field-rules	Array	脱敏规则列表	-	是
field-names	Array	需要脱敏的字段名列表	-	是
type	String	脱敏类型，详见下方脱敏类型支持表格	-	是
max-length	Integer	单个参数值最大长度，超过此长度将被截断	-	否

脱敏类型支持

系统支持以下脱敏类型：

脱敏类型	说明	示例
mobile	手机号	138****8888
idcard	身份证号	110***********1234
bankcard	银行卡号	6222********1234
email	邮箱	t***@example.com
password	密码	********
name	名称	张**
address	地址	北京市海淀区***
ip	IP地址	192.168..
creditcode	社会统一信用代码	9111***********1234
passport	护照号码	E********
militaryid	军官证号码	军********
businesslicense	营业执照号码	9111***********1234
carnumber	车牌号码	京A*****
wechatid	微信号	wxid_****
qq	QQ号	123****

注意事项

确保敏感字段配置完整
定期检查脱敏规则是否满足安全要求
注意日志文件的安全存储

请求和响应日志配置

日志级别说明

请求和响应日志仅在日志级别为 debug 时生效。如需启用，请确保配置：

yaml

log:
  request: # 请求日志配置
    enabled: true # 是否启用请求日志
    urls: # 允许记录请求日志的URL列表
    - /api/**
    - /web/**
    forbid-urls: # 禁止记录请求日志的URL列表
    - /api/health
    - /api/metrics
  response: # 响应日志配置
    enabled: true # 是否启用响应日志
    urls: # 允许记录响应日志的URL列表
    - /api/**
    - /web/**
    forbid-urls: # 禁止记录响应日志的URL列表
    - /api/health
    - /api/metrics

请求和响应配置参数说明

参数名	类型	说明	默认值	是否必填
request.enabled	Boolean	是否启用请求日志	false	否
request.urls	Array	允许记录请求日志的URL列表	-	否
request.forbid-urls	Array	禁止记录请求日志的URL列表	-	否
response.enabled	Boolean	是否启用响应日志	false	否
response.urls	Array	允许记录响应日志的URL列表	-	否
response.forbid-urls	Array	禁止记录响应日志的URL列表	-	否

URL匹配规则

支持通配符匹配，如 /api/**
支持精确匹配，如 /api/health
支持多个URL配置，使用数组形式
优先级：forbid-urls > urls

注意事项

请求和响应日志可能包含敏感信息，请确保配置了适当的脱敏规则
建议只记录必要的URL，避免日志量过大
对于高频访问的接口，建议配置到forbid-urls中
定期检查日志内容，确保没有敏感信息泄露

🆘 技术支持

如果遇到问题：

检查日志配置文件
查看系统日志
分析错误信息
联系技术支持团队

重要提示

定期备份重要日志
确保日志存储安全
遵守数据保护规范
及时处理异常日志

📝 日志配置指南 ​

📖 简介 ​

⚙️ 基础配置 ​

日志级别配置 ​

敏感信息脱敏配置 ​

请求和响应日志配置 ​

🆘 技术支持 ​

📝 日志配置指南

📖 简介

⚙️ 基础配置

日志级别配置

敏感信息脱敏配置

请求和响应日志配置

🆘 技术支持