Nacos 使用了什么日志框架？如何配置和查看日志？

Nacos 使用的日志框架

Nacos 主要使用 SLF4j (Simple Logging Facade for Java) 作为日志门面（API），并选择 Logback 作为其底层的日志实现。

• SLF4j: 这是一个日志抽象层，允许开发者在代码中使用统一的接口进行日志记录，而底层的具体日志实现（如 Logback, Log4j2, JUL等）可以在部署时灵活替换。Nacos 源代码中我们会看到 org.slf4j.Logger 的使用。
• Logback: 是 Log4j 框架的改进版本，由 Log4j 的创始人设计，性能更好，配置更灵活。Nacos 默认捆绑并使用 Logback 来处理 SLF4j 的日志请求，并将日志输出到指定位置。

如何配置 Nacos 日志

Nacos 的日志行为主要通过其配置文件进行控制。

1. 配置文件位置:
   Nacos Server 的日志配置文件位于 Nacos 安装目录下的 conf 文件夹中，文件名为：
   nacos-logback.xml

2. 配置文件内容 (关键部分解析):
   打开 nacos-logback.xml 文件，你会看到标准的 Logback 配置结构。主要包含以下几个部分：

   • <property>: 定义变量，方便在配置文件中复用。例如，定义日志路径、日志格式等。

     <property name="LOG_HOME" value="${nacos.home}/logs" />
     <property name="INFO_LOG_PATTERN" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level [%thread] [%logger{50}] - %msg%n" />
     

     • ${nacos.home} 是 Nacos 服务器的根目录，通常由启动脚本设置。日志默认输出到 ${nacos.home}/logs 目录下。
     • INFO_LOG_PATTERN 定义了日志输出的格式。

   • <appender>: 定义日志输出目的地和方式。常见的 Appender 有：

     • ConsoleAppender: 输出到控制台（标准输出）。
     • RollingFileAppender: 输出到文件，并根据策略（如时间、大小）进行滚动切割。Nacos 默认配置了多个 File Appender，用于输出不同级别或模块的日志。

     <!-- 输出到控制台 -->
     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
             <pattern>${INFO_LOG_PATTERN}</pattern>
             <charset>UTF-8</charset>
         </encoder>
     </appender>
     
     <!-- 输出到 nacos.log 文件，按天滚动 -->
     <appender name="NACOS_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_HOME}/nacos.log</file>
         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
             <fileNamePattern>${LOG_HOME}/nacos.log.%d{yyyy-MM-dd}</fileNamePattern>
             <maxHistory>7</maxHistory> <!-- 保留最近7天的日志 -->
         </rollingPolicy>
         <encoder>
             <pattern>${INFO_LOG_PATTERN}</pattern>
             <charset>UTF-8</charset>
         </encoder>
     </appender>
     

     Nacos 可能还会配置其他 Appender，如 config-client.log, naming-client.log, config-server.log, naming-server.log 等，用于记录特定模块的日志（虽然新版本可能倾向于统一输出到 nacos.log 并通过 Logger 区分）。还会有 access_log.log 用于记录 HTTP 访问日志。

   • <logger>: 定义特定包或类的日志级别。可以为 Nacos 的不同模块设置不同的日志级别，方便调试。

     <!-- 控制 Nacos 核心配置模块的日志级别 -->
     <logger name="com.alibaba.nacos.config" level="INFO" additivity="false">
         <appender-ref ref="CONFIG_LOG"/> <!-- 假设有一个名为 CONFIG_LOG 的 Appender -->
         <appender-ref ref="CONSOLE"/>
     </logger>
     
     <!-- 控制 Nacos 核心命名模块的日志级别 -->
     <logger name="com.alibaba.nacos.naming" level="INFO" />
     
     <!-- 可以为特定类设置 DEBUG 级别 -->
     <logger name="com.alibaba.nacos.core.cluster.ServerMemberManager" level="DEBUG" />
     

     • name: 指定包名或类名。
     • level: 设置日志级别 (TRACE, DEBUG, INFO, WARN, ERROR, OFF)。子包会继承父包的级别，除非显式指定。
     • additivity="false": 表示该 logger 的日志不再向上传递给 root logger，避免重复记录。

   • <root>: 根 Logger，配置全局默认的日志级别和 Appender。所有未被 <logger> 明确指定的日志记录器都会继承 root 的设置。

     <root level="INFO">
         <appender-ref ref="NACOS_LOG" />
         <appender-ref ref="CONSOLE" />
     </root>
     

     这里设置了全局默认日志级别为 INFO，并将日志同时输出到 NACOS_LOG (文件) 和 CONSOLE (控制台)。

3. 修改配置:

   • 直接编辑 conf/nacos-logback.xml 文件。
   • 修改日志级别: 找到对应的 <logger> 或 <root> 标签，修改 level 属性的值。例如，将 <root level="INFO"> 改为 <root level="DEBUG"> 可以看到更详细的日志输出。
   • 修改日志路径: 修改 <property name="LOG_HOME" ...> 中的 value 或者直接修改 <appender> 中的 <file> 标签。
   • 修改滚动策略: 修改 <rollingPolicy> 下的配置，如 fileNamePattern (滚动文件名格式) 和 maxHistory (最大保留文件数/天数)。

4. 生效配置:
   Logback 支持自动扫描配置文件变更。默认情况下，Nacos (Logback) 会定期检查 nacos-logback.xml 是否有修改。如果检测到修改，会自动重新加载配置，无需重启 Nacos 服务。这个扫描间隔可以在 <configuration> 标签中通过 scan="true" scanPeriod="30 seconds" (示例) 来设置或确认。如果未生效或希望立即生效，重启 Nacos Server 是最保险的方法。

如何查看 Nacos 日志

1. 日志文件位置:
   默认情况下，Nacos 的日志文件位于 Nacos 安装目录下的 logs 文件夹中 (${nacos.home}/logs/)。

2. 主要日志文件:

   • nacos.log: 这是最主要的 Nacos 运行日志文件，包含了大部分 INFO 及以上级别的信息、警告和错误。根据配置，它可能会按天或按大小滚动（如 nacos.log.2023-10-27）。
   • access_log.log: 记录了所有对 Nacos HTTP API 的访问请求，类似于 Nginx 或 Tomcat 的访问日志，包含请求方法、路径、状态码、耗时等信息。对于排查谁在何时访问了 Nacos 非常有用。
   • 其他可能的日志文件 (取决于 nacos-logback.xml 配置): 如 config-server.log, naming-server.log 等，可能包含特定模块的详细日志。

3. 查看方法:

   • 实时查看 (Linux/macOS): 使用 tail 命令可以实时监控日志文件的追加内容。

     tail -f ${nacos.home}/logs/nacos.log  # 实时查看主日志
     tail -f ${nacos.home}/logs/access_log.log # 实时查看访问日志
     tail -n 500 -f ${nacos.home}/logs/nacos.log # 实时查看最后500行并持续跟踪
     

   • 分页查看 (Linux/macOS): 使用 less 命令可以方便地浏览和搜索大型日志文件。

     less ${nacos.home}/logs/nacos.log
     # 在 less 中，按 / 输入关键词可搜索，按 n 查找下一个，按 Shift+G 跳到文件末尾，按 g 跳到文件开头，按 q 退出
     

   • 搜索关键字 (Linux/macOS): 使用 grep 命令可以查找包含特定错误信息或关键字的日志行。

     grep 'ERROR' ${nacos.home}/logs/nacos.log # 查找包含 ERROR 的行
     grep 'com.alibaba.nacos.naming' ${nacos.home}/logs/nacos.log # 查找命名服务相关的日志
     cat ${nacos.home}/logs/nacos.log | grep 'WARN' # 另一种方式
     

   • Windows: 可以使用类似 Get-Content -Path nacos.log -Wait (PowerShell) 或其他文本编辑器/查看工具 (如 Notepad++, VS Code, tail for Windows 等) 来查看。
   • 集群环境: 如果 Nacos 以集群模式部署，每个 Nacos 节点都会在自己的服务器上生成独立的日志文件。在生产环境中，通常会使用集中式日志收集系统（如 ELK Stack - Elasticsearch, Logstash, Kibana 或 EFK - Elasticsearch, Fluentd, Kibana；或者 Loki + Promtail + Grafana）将所有节点的日志汇总到一处，方便统一查询和分析。

Nacos 使用 SLF4j + Logback 进行日志管理，通过 conf/nacos-logback.xml 进行配置，日志默认输出到 logs/ 目录下，主要关注 nacos.log 和 access_log.log，并可以使用标准的命令行工具或日志查看软件进行查看。在集群环境下推荐使用集中式日志系统。