Skip to content

日志

全局默认日志记录通过log选项配置。

log:
  level: info
  format: json
  output: stderr
  rotation:
    maxSize: 100
    maxAge: 10
    maxBackups: 3
    localTime: false
    compress: false

级别

日志支持的级别有:

  • fatal - 致命错误，当输出此级别的日志后程序将退出。
  • error - 一般性错误，程序正常运行。
  • warn - 需要注意的警告信息。
  • info - 一般信息。
  • debug - 比info级别输出更多信息，用于开发或使用过程中定位问题。
  • trace - 比debug级别输出更多信息，用于开发调试。

默认级别为info。

命令行

命令行下可以通过-D参数设置debug级别，或者通过环境变量GOST_LOGGER_LEVEL来设置相应的级别。

格式

支持json和text两种格式，默认为json格式。

输出

支持的输出方式有：

  • none - 丢弃日志，不输出任何信息。
  • stderr - 标准错误流。
  • stdout - 标准输出流。
  • /path/to/file - 指定的文件路径。

默认输出到标准错误流(stderr)。

Rotation

通过配置rotation选项可以对日志进行切分，备份和压缩。当output为文件时有效。

maxSize (int, default=100)
文件存储大小，单位为MB。
maxAge (int)
备份日志文件保存天数，默认不根据时间清理旧文件。
maxBackups (int)
备份日志文件数量，默认保存所有文件。
localTime (bool, default=false)
备份文件名是否使用本地时间格式。默认使用UTC时间。
compress (bool, default=false)
备份文件是否(使用gzip)压缩。

日志记录器

日志记录器是一个日志记录实例的配置定义，除了默认的全局日志记录外，可以额外再定义任意多个不同的日志记录实例。

loggers:
- name: logger-0
  log:
    level: info
    format: text
    output: stderr
- name: logger-1
  log:
    level: debug
    format: json
    output: /path/to/file
    rotation:
      maxSize: 100
      maxAge: 10
      maxBackups: 3
      localTime: false
      compress: false

日志记录器可以用在服务级别，为每个服务单独配置日志记录策略。

services:
- name: service-0
  addr: :8000
  logger: logger-0
  handler:
    type: auto
  listener:
    type: tcp
- name: service-1
  addr: :8001
  logger: logger-1
  handler:
    type: auto
  listener:
    type: tcp
loggers:
- name: logger-0
  log:
    level: info
    format: text
    output: stderr
- name: logger-1
  log:
    level: debug
    format: json
    output: /path/to/file
    rotation:
      maxSize: 100
      maxAge: 10
      maxBackups: 3
      localTime: false
      compress: false

日志记录器组

也可以通过日志记录器组来组合使用多个日志记录器。

services:
- name: service-0
  addr: :8000
  loggers:
  - logger-0
  - logger-1
  handler:
    type: auto
  listener:
    type: tcp
loggers:
- name: logger-0
  log:
    level: info
    format: text
    output: stderr
- name: logger-1
  log:
    level: debug
    format: json
    output: /path/to/file
    rotation:
      maxSize: 100
      maxAge: 10
      maxBackups: 3
      localTime: false
      compress: false

Comments