全部产品

工程日志

本文将介绍 SOFABoot 日志的默认设置、日志存放目录、中间件服务日志、应用日志、日志兼容性,以及如何查看日志。

默认设置

  • 日志门面:默认为 SLF4J(Simple Logging Facade for Java)

  • 日志实现:默认通过 Logback 实现

中间件日志

关于各个中间件的日志详细信息,参见 中间件日志

应用日志

假设用工程原型创建的工程依赖信息为下述内容:

  • groupIdcom.alipay.sofa

  • artifactIdAPPNAME

则当前应用相关的日志信息为:

  • 应用名:为artifactId 对应的值 APPNAME

  • 日志配置文件:为工程创建时自动生成的 logback-spring.xml

  • 日志目录:为 ./logs/APPNAME

  • 默认日志:common-default.log

  • 默认错误日志:common-error.log

关于应用的日志配置解决方案,可以参考 日志配置 文档。

日志兼容性

SOFABoot 支持的日志框架:

  • 默认日志框架: SLF4J + Logback 日志框架

  • 支持框架:SLF4J + Log4j 2(推荐)或 SLF4J + Log4j

日志存放目录

  • 配置方式:通过 config/application.properties 配置文件中的 logging.path 属性来配置日志输出位置。

  • 默认日志输出位置:./logs

    • 本地存放目录

      • 日志放在可部署模块下。可部署模块指使用 spring-boot-maven-plugin 打包的模块,例如 SOFABoot Web 工程中的 web 模块,或 SOFABoot Core 工程中的 service 模块。

      • 在本地 IDE 运行时,日志文件默认输出在当前工程根目录的 logs 文件夹中。

    • 云端存放目录:当应用发布部署到 SOFAStack 平台时,技术栈会在 /home/admin 目录下运行上传的 fat Jar 文件,此时日志文件输出在 /home/admin/logs 目录下。可以通过 ps aux|grep java 命令查看应用是否正确启动,如有错误,可以通过查看日志排查故障。

  • 如无特殊需求,不建议修改日志目录的输出配置。

本地日志查看

  • 查看 SOFABoot 启动日志:即查看根目录下 logs/projectName_XXX/projectName_XXX-default.log,内容参考如下:

2020-05-0617:01:38.803[main] WARN  com.taobao.remoting -Server start success:9,877
2020-05-0617:01:38.814[main] INFO  o.s.scheduling.concurrent.ThreadPoolTaskExecutor-InitializingExecutorService
2020-05-0617:01:38.816[main] INFO  o.s.scheduling.concurrent.ThreadPoolTaskExecutor-InitializingExecutorService
2020-05-0617:01:39.001[main] INFO  com.alipay.APPNAME.test.usercases.BeanTest-StartingBeanTest on DESKTOP-5VJGIEM with PID 2200(started by wb-zxh661647 in C:\Users\wb-zxh661647\Desktop\testProject\SOFABoot_Enterprise\SOFABootCoreDemo_Enterprise_new\SOFABoot_coreDemo\SOFABoot_coreDemo-service)
2020-05-0617:01:39.001[main] INFO  com.alipay.APPNAME.test.usercases.BeanTest-No active profile set, falling back to default profiles:default
2020-05-0617:01:43.989[main] INFO  o.s.scheduling.concurrent.ThreadPoolTaskExecutor-InitializingExecutorService'applicationTaskExecutor'
2020-05-0617:01:45.763[main] INFO  o.s.b.actuate.endpoint.web.EndpointLinksResolver-Exposing4 endpoint(s) beneath base path '/actuator'
2020-05-0617:01:49.120[main] INFO  com.alipay.APPNAME.test.usercases.BeanTest-StartedBeanTest in 36.602 seconds (JVM running for38.081)
2020-05-0617:01:49.525[Thread-3] WARN  com.taobao.remoting -Server closed:9,877
2020-05-0617:01:49.528[Thread-10] INFO  o.s.scheduling.concurrent.ThreadPoolTaskExecutor-Shutting down ExecutorService'applicationTaskExecutor'
  • 查看报错日志:即查看工程根目录下 logs/projectName_XXX/common-error.log。如有报错,说明 SOFABoot 启动失败,根据错误提示解决问题,直至没有报错。