基本介绍

服务端支持配置文件，所有的配置将会自动映射到配置对象中。配置对象如下：

  1. // GrpcServerConfig is the configuration for server.
  2. type GrpcServerConfig struct {
  3.     Address          string              // (optional) Address for server listening.
  4.     Name             string              // (optional) Name for current service.
  5.     Logger           *glog.Logger        // (optional) Logger for server.
  6.     LogPath          string              // (optional) LogPath specifies the directory for storing logging files.
  7.     LogStdout        bool                // (optional) LogStdout specifies whether printing logging content to stdout.
  8.     ErrorStack       bool                // (optional) ErrorStack specifies whether logging stack information when error.
  9.     ErrorLogEnabled  bool                // (optional) ErrorLogEnabled enables error logging content to files.
  10.     ErrorLogPattern  string              // (optional) ErrorLogPattern specifies the error log file pattern like: error-{Ymd}.log
  11.     AccessLogEnabled bool                // (optional) AccessLogEnabled enables access logging content to file.
  12.     AccessLogPattern string              // (optional) AccessLogPattern specifies the error log file pattern like: access-{Ymd}.log
  13. }

配置文件的自动读取逻辑与框架一致，详细介绍请参考章节： 配置管理

配置模板

一个完整的配置模板示例：

  1. grpc:
  2.   name:             "demo"  # 服务名称
  3.   address:          ":8000" # 自定义服务监听地址
  4.   logPath:          "./log" # 日志存储目录路径
  5.   logStdout:        true    # 日志是否输出到终端
  6.   errorLogEnabled:  true    # 是否开启错误日志记录
  7.   accessLogEnabled: true    # 是否开启访问日志记录
  8.   errorStack:       true    # 当产生错误时，是否记录错误堆栈
  10.   # 日志扩展配置(参数日志组件配置)
  11.   logger:
  12.     path:                  "/var/log/"   # 日志文件路径。默认为空，表示关闭，仅输出到终端
  13.     file:                  "{Y-m-d}.log" # 日志文件格式。默认为"{Y-m-d}.log"
  14.     prefix:                ""            # 日志内容输出前缀。默认为空
  15.     level:                 "all"         # 日志输出级别
  16.     stdout:                true          # 日志是否同时输出到终端。默认true
  17.     rotateSize:            0             # 按照日志文件大小对文件进行滚动切分。默认为0，表示关闭滚动切分特性
  18.     rotateExpire:          0             # 按照日志文件时间间隔对文件滚动切分。默认为0，表示关闭滚动切分特性
  19.     rotateBackupLimit:     0             # 按照切分的文件数量清理切分文件，当滚动切分特性开启时有效。默认为0，表示不备份，切分则删除
  20.     rotateBackupExpire:    0             # 按照切分的文件有效期清理切分文件，当滚动切分特性开启时有效。默认为0，表示不备份，切分则删除
  21.     rotateBackupCompress:  0             # 滚动切分文件的压缩比（0-9）。默认为0，表示不压缩
  22.     rotateCheckInterval:   "1h"          # 滚动切分的时间检测间隔，一般不需要设置。默认为1小时

其中的日志配置与 http server 一致，可以独立使用日志组件的配置项来配置 grpc server 的日志。关于日志组件的配置，可参考该文档详细了解： 日志组件-配置管理

在没有配置 address 的情况下， grpc server 将会使用本地网卡的所有 ip 地址加上 随机空闲端口 来启动（默认配置 :0）。如果想要指定 ip 但是使用随机空闲端口启动 grpc server，可以使用 ip:0 的格式来配置 address，例如： 192.168.1.1:0, 10.0.1.1:0。