配置日志驱动

Docker 包含多种日志机制，可帮助你从运行的容器和服务中 获取信息。这些机制被称为日志驱动程序。每个 Docker 守护进程都有一个默认的日志驱动程序，每个容器都会使用它，除非你配置它使用不同的日志驱动程序，或简称日志驱动程序。

默认情况下，Docker 使用 json-file 日志驱动程序，它将容器日志作为 JSON 内部缓存。除了使用 Docker 附带的日志驱动程序外，你还可以实现和使用 日志驱动程序插件。

提示：使用 local 日志驱动程序来防止磁盘耗尽

默认情况下，不会执行日志轮转。因此，默认的 json-file 日志驱动程序 日志驱动程序存储的日志文件可能会导致大量磁盘空间用于生成大量输出的容器，从而导致磁盘空间耗尽。

Docker 保留 json-file 日志驱动程序（不进行日志轮转）作为默认设置，以保持与旧版 Docker 的向后兼容性，以及 Docker 用作 Kubernetes 运行时的场景。

对于其他情况，建议使用 local 日志驱动程序，因为它默认执行日志轮转，并使用更有效的文件格式。请参阅下面的 配置默认日志驱动程序 部分，了解如何配置 local 日志驱动程序作为默认驱动程序，以及 本地文件日志驱动程序 页面，以详细了解 local 日志驱动程序。

配置默认日志驱动程序

要配置 Docker 守护进程以默认使用特定日志驱动程序，请在 daemon.json 配置文件中将 log-driver 的值设置为日志驱动程序的名称。有关详细信息，请参阅 dockerd 参考手册 中的“守护进程配置文件”部分。

默认日志驱动程序为 json-file。以下示例将默认日志驱动程序设置为 local 日志驱动程序

{
  "log-driver": "local"
}

如果日志驱动程序具有可配置选项，你可以在 daemon.json 文件中以 JSON 对象形式设置它们，其键为 log-opts。以下示例在 json-file 日志驱动程序上设置四个可配置选项

{
  "log-driver": "json-file",
  "log-opts": {
    "max-size": "10m",
    "max-file": "3",
    "labels": "production_status",
    "env": "os,customer"
  }
}

重新启动 Docker 以使更改对新创建的容器生效。现有容器不会自动使用新的日志记录配置。

注意

daemon.json 配置文件中的 log-opts 配置选项必须作为字符串提供。因此，布尔值和数值（例如上面示例中的 max-file 的值）必须用引号 (") 括起来。

如果未指定日志驱动程序，则默认值为 json-file。要查找 Docker 守护进程的当前默认日志驱动程序，请运行 docker info 并搜索 Logging Driver。你可以在 Linux、macOS 或 Windows 上的 PowerShell 上使用以下命令

$ docker info --format '{{.LoggingDriver}}'

json-file

注意

更改守护进程配置中的默认日志驱动程序或日志驱动程序选项只会影响配置更改后创建的容器。现有容器将保留创建时使用的日志驱动程序选项。要更新容器的日志驱动程序，必须使用所需选项重新创建容器。请参阅下面的 配置容器的日志驱动程序 部分，了解如何查找容器的日志驱动程序配置。

配置容器的日志驱动程序

启动容器时，可以使用 --log-driver 标志配置它使用与 Docker 守护进程的默认值不同的日志驱动程序。如果日志驱动程序具有可配置选项，可以使用 --log-opt <NAME>=<VALUE> 标志的一个或多个实例设置它们。即使容器使用默认日志驱动程序，它也可以使用不同的可配置选项。

以下示例使用 none 日志驱动程序启动一个 Alpine 容器。

$ docker run -it --log-driver none alpine ash

要查找运行容器的当前日志驱动程序，如果守护进程使用 json-file 日志驱动程序，请运行以下 docker inspect 命令，将容器名称或 ID 替换为 <CONTAINER>

$ docker inspect -f '{{.HostConfig.LogConfig.Type}}' <CONTAINER>

json-file

配置从容器到日志驱动程序的日志消息传递模式

Docker 提供两种模式来将消息从容器传递到日志驱动程序

• (默认) 从容器到驱动程序的直接阻塞传递
• 非阻塞传递，将日志消息存储在中间的每个容器缓冲区中，供驱动程序使用

non-blocking 消息传递模式可防止应用程序因日志反压而阻塞。当 STDERR 或 STDOUT 流阻塞时，应用程序很可能会以意想不到的方式失败。

警告

当缓冲区已满时，不会排队新的消息。删除消息通常优先于阻止应用程序的日志写入过程。

mode 日志选项控制是否使用 blocking（默认）或 non-blocking 消息传递。

max-buffer-size 日志选项控制当 mode 设置为 non-blocking 时用于中间消息存储的缓冲区大小。max-buffer-size 默认值为 1 兆字节。

以下示例使用非阻塞模式和 4 兆字节缓冲区启动一个 Alpine 容器，其日志输出为非阻塞模式。

$ docker run -it --log-opt mode=non-blocking --log-opt max-buffer-size=4m alpine ping 127.0.0.1

在日志驱动程序中使用环境变量或标签

某些日志驱动程序会将容器的 --env|-e 或 --label 标志的值添加到容器的日志中。此示例使用 Docker 守护进程的默认日志驱动程序（在以下示例中为 json-file）启动一个容器，但设置环境变量 os=ubuntu。

$ docker run -dit --label production_status=testing -e os=ubuntu alpine sh

如果日志驱动程序支持，这会在日志输出中添加其他字段。以下输出由 json-file 日志驱动程序生成

"attrs":{"production_status":"testing","os":"ubuntu"}

支持的日志驱动程序

支持以下日志驱动程序。请参阅每个驱动程序文档的链接，了解其可配置选项（如果适用）。如果使用 日志驱动程序插件，你可能会看到更多选项。

日志驱动程序的局限性

• 读取日志信息需要解压缩轮转的日志文件，这会导致磁盘使用量暂时增加（直到读取轮转文件中的日志条目）以及解压缩期间 CPU 使用量增加。
• Docker 数据目录所在的宿主存储容量决定了日志文件信息的最大大小。