日志配置项

最近更新时间:2019-08-20 12:06:09

日志配置项用于指定采集日志的规则,包括日志的采集路径和日志解析格式(功能待发布)。用户可以在 TSF 控制台上创建日志配置项,然后将配置项发布到部署组上。同一个部署组可以关联多个日志配置项。

默认日志配置项

TSF 提供默认日志配置项,格式是 Spring Boot。日志路径包括三部分,相对于应用启动路径:

  • ./*.log
  • ./log/*.log
  • ./logs/*.log

用户可以在微服务应用的配置文件中配置 logging.file 为上述任意一个路径,然后在创建部署组时,选择默认日志配置项 default-log-config

说明:

默认日志配置项仅适用于虚拟机部署的应用。

创建日志配置项

  1. 登录 TSF 控制台
  2. 在左侧导航栏,单击【日志服务】>【日志配置】进入日志配置页面。
  3. 在日志配置页左上角,单击【新建配置】,在弹出框中填写日志配置项信息。
    • 名称:日志配置名称,不超过60个字符。
    • 日志格式:目前支持 Spring Boot、自定义 Logback、自定义 Log4j 和 无解析规则。
      • Spring Boot:如果应用程序使用默认的 Spring Boot 日志,则选择 Spring Boot 日志格式。
      • 自定义 Logback :如果应用程序使用 logback 日志配置,设置日志格式为 logback,然后设置解析规则(对应 logback 中的 pattern)。参考 Logback 中关于 Pattern 的介绍。
      • 自定义 Log4j :如果应用程序使用 log4j 日志配置,设置日志格式为 log4j,然后设置解析规则(对应 log4j 中的 PatternLayout)。需要进一步填写解析规则,可以参考 Log4j 中关于 PatternLayout 的介绍。
      • 无解析规则:指一行日志内容为一条完整的日志。日志服务在采集的时候,将使用换行符 \n 来作为一条日志日志的结束符。为了统一结构化管理,每条日志都会存在一个默认的键值 __CONTENT__,但日志数据本身不再进行日志结构化处理,也不会提取日志字段,日志属性的时间项由日志采集的时间决定。
    • 日志路径:可填写一个或者多个日志路径。目前支持绝对路径具体到日志文件,如/data/log/2017.log,文件名称允许使用数字、字母、横杠(-)、下划线(_)、通配符(*)和小数点(.)。日志文件必须具有文件后缀,文件名和目录支持通配符,如 /data/log/*.log/var/log/*/*.log
    • 描述:日志配置项的描述信息。
  4. 单击【提交】完成创建。

修改日志配置项

  1. 登录 TSF 控制台
  2. 在左侧导航栏,单击【日志服务】>【日志配置】进入日志配置页面。
  3. 单击目标日志配置项 ID,进入详情页,在基本信息标签页单击【编辑】。
  4. 按照字段内容进行修改,完成后单击【提交】保存修改。
    说明:

    如果日志配置项绑定了虚拟机应用部署组,修改后的日志配置项实时生效;如果日志配置项绑定了容器应用部署组,修改后需要重启部署组后更新后的日志配置项才生效。

部署组关联日志配置项

部署组关联日志配置项有两个入口:

  • 用户可以在创建应用时将日志配置项关联到应用。
  • 在日志配置项列表,右侧操作栏中单击【发布配置】。

创建部署组时选择日志配置项

  1. 登录 TSF 控制台
  2. 在左侧导航栏,单击【部署组】。
  3. 在页面左上角,单击【新建部署组】,在弹出框中选择关联的日志配置项。
    • 新建虚机部署组:
    • 新建容器部署组:
  4. 单击【保存&下一步】。
  5. 部署应用。
    • 虚机部署组:在当前集群下选择实例,单击【部署应用】。选择程序包,单击【完成】,日志配置项即可生效。
    • 容器部署组:选择镜像,单击【保存并启动】部署应用,使日志配置项生效。

日志配置项列表,发布配置

  1. 登录 TSF 控制台
  2. 在左侧导航栏,单击【日志服务】>【日志配置】进入日志配置页面。。
  3. 在日志配置项列表,右侧操作栏中单击【发布配置】。
  4. 选择要绑定的部署组。
  5. 单击【提交】。

删除日志配置项

当日志配置项没有被其他部署组关联时,才可以删除日志配置项。

  1. 登录 TSF 控制台
  2. 在左侧导航栏,单击单击【日志服务】>【日志配置】进入日志配置页面。
  3. 在日志配置列表,单击右侧操作列的【删除】。
  4. 在删除确认框中单击【确认】,完成删除。