日志严重级别
日志level
键指定了一个严重性阈值,比如debug
或error
,必须满足这个阈值才能记录消息。
默认日志级别
在您的playbook中明确为level
键分配一个值是可选的。如果在您的playbook中未设置它,也没有使用--log-level选项或ANTORA_LOG_LEVEL变量指定,Antora会在运行时将值warn
分配给该键。应用默认值时,所有满足或超过warn
阈值的消息都会被记录。
level键
level
键配置在playbook中的运行时和日志键下。
runtime:
log:
level: error
level
键接受以下内置值:
- fatal
-
导致Antora突然关闭的灾难性错误。您的站点未生成。
如果在Antora配置playbook之前抛出致命错误,Antora只会将消息打印到标准错误(STERR)。错误消息不会按照用户配置的方式通过记录器路由。 - error
-
表示重要操作未能成功发生或未能成功完成的严重问题。错误可能不会导致Antora关闭,但您的站点可能未按预期生成或发布。
- warn
-
默认值。 不正确的AsciiDoc语法,比如缺少AsciiDoc属性、playbook或组件配置,以及其他可能影响生成站点的可用性、性能或外观的问题。
- info
-
强调Antora正常运行和里程碑的信息消息。
- debug
-
提供有关Antora活动、事件、警告和错误的详细上下文的诊断消息。当您需要有关警告或错误的额外信息时,此级别很有用。
- all
-
记录有关Antora操作的所有信息和详细信息以及这些操作的结果。
- silent
-
记录器被关闭,不记录任何消息。
满足或超过严重性阈值的消息将被记录。不满足严重性阈值的消息不会报告。
指定日志级别
让我们在playbook中为level
键分配值info
,如示例2所示。
runtime: (1)
log: (2)
level: info (3)
1 | 在您的playbook文件中,键入父键runtime ,后跟一个冒号(: ),然后按Enter。 |
2 | log 键是runtime 的子级。键入键的名称log ,后跟一个冒号(: ),然后按Enter。 |
3 | level 键是log 的子级。键入level ,后跟一个冒号和一个空格(: ),然后键入值info 。 |
当Antora运行并且level
被分配为info
时,满足或超过info
阈值的消息将被记录。不满足info
严重级别的消息不会报告。
日志级别选项
您不必直接修改playbook文件来设置level
键。您可以使用CLI中的--log-level
选项。
$ antora --log-level=debug antora-playbook.yml
--log-level
选项会覆盖分配给level
键或ANTORA_LOG_LEVEL环境变量的值。