4.7. 日志
平台使用 Logback 框架来处理日志。
参考 CUBA 应用程序日志 指南学习如何集成、配置、查看日志以及如何使用外部工具分析日志。 |
日志的输出,采用 SLF4J API:取到当前类的一个 logger,然后调用 logger 的方法打印日志,示例:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Foo {
// create logger
private static Logger log = LoggerFactory.getLogger(Foo.class);
private void someMethod() {
// output message with DEBUG level
log.debug("invoked someMethod");
}
}
- 日志配置
-
日志配置在
logback.xml
文件中定义。-
在开发阶段,快速部署之后,可以在项目的
deploy/app_home
目录找到该文件。日志文件都创建在deploy/app_home/logs
目录。注意,
deploy
目录不包含在版本控制中,并且可以随时创建和删除,所以在deploy/app_home/logback.xml
内做的改动很容易丢失。如果需要对开发环境的日志配置做持久的改动,创建
etc/logback.xml
(可以复制原始的deploy/app_home/logback.xml
文件,再做必要的改动)。该文件会每次在 Studio 运行应用或者执行deploy
Gradle 任务时复制到deploy/app_home
:my_project/ deploy/ app_home/ logback.xml ... etc/ logback.xml - if exists, will be automatically copied to deploy/app_home
-
当创建 WAR 或者 UberJAR 包时,可以在 buildWar 或 buildUberJar 任务的
logbackConfigurationFile
参数指定logback.xml
的相对路径。如果未指定该参数,默认的输出至控制台日志配置会被包含进 WAR/UberJAR。注意,开发环境创建的
etc/logback.xml
不会默认给 WAR/UberJar 使用,必须显式指定一个日志配置文件,示例:my_project/ etc/ logback.xml war-logback.xml
build.gradletask buildWar(type: CubaWarBuilding) { // ... logbackConfigurationFile = 'etc/war-logback.xml' }
-
生产环境,可以在 应用程序主目录 放置
logback.xml
文件重写 WAR 或者 UberJAR 中嵌入的日志配置。应用程序主目录的
logback.xml
文件只有在命令行设置了app.home
Java 系统参数之后才会被识别。所以如果应用程序主目录是使用自动的tomcat/work/app_home
或~/.app_home
的话,这个配置不会生效。
-
- logback.xml 的结构
-
logback.xml
文件结构如下:-
appender
元素定义了日志的 “输出设备”。主要的 appenders 有FILE - 文件
和CONSOLE - 终端
。ThresholdFilter
的level
参数定义了消息的阈值。文件输出的默认值是DEBUG
,终端输出的默认值是INFO
。也就是说ERROR
,WARN
,INFO
和DEBUG
消息会输出到文件,但是只有ERROR
,WARN
和INFO
级别的消息输出到终端。内嵌的
file
参数定义了文件输出目标文件的路径。 -
logger
元素定义了编码打印消息的 logger 参数。Logger 名称是有级别的,比如对于com.company.sample
logger 的设置也会影响com.company.sample.core.CustomerServiceBean
和com.company.sample.web.CustomerBrowse
的 logger,前提是这两个类没有显式的声明他们各自的 logger 参数。日志的打印级别是通过
level
属性来定义最低级别。比如,如果定义的是INFO
级别,那么DEBUG
和TRACE
类型的消息就不会被日志记录。需要注意的一点就是,在 appender 里面设置的级别也会影响日志的打印。
可以在 web 客户端的 Administration > Server Log 界面快速修改正在运行的服务的 logger 级别和 appender 的阈值。任何对日志的改动只会影响正在运行的服务,设置并不会保存在文件里。这个界面也支持从日志目录 (tomcat/logs)查看和加载 Tomcat 服务的日志。
-
- Log 消息格式
-
平台会自动添加以下信息到基于文件的日志消息中:
-
application – 打印消息的应用程序名称。这个信息可以帮助定位消息是从哪个 block 打印的(Middleware, Web Client),因为这两个模块写的是同一个日志文件。
-
user – 调用打印消息代码的登录用户名。用来在日志里跟踪具体用户的行为。如果打印消息的代码没有被特定用户的会话调用,就不会在日志里添加用户信息。
比如,下面这个消息是被
admin
会话下调用的中间件(app-core
)代码写入的:16:12:20.498 DEBUG [http-nio-8080-exec-7/app-core/admin] com.haulmont.cuba.core.app.DataManagerBean - loadList: ...
-