Docker 日志驱动程序插件

本文档描述了 Docker 的日志驱动插件。

日志驱动使用户能够将容器日志转发到另一个服务进行处理。Docker 内置了几个日志驱动，但内置驱动无法满足所有用例。插件允许 Docker 支持广泛的日志记录服务，而无需将这些服务的客户端库嵌入到 Docker 的主代码库中。有关更多信息，请参阅插件文档。

创建一个日志记录插件

日志记录插件的主要接口使用与其他插件类型相同的 JSON+HTTP RPC 协议。请参阅示例插件以获取日志记录插件的参考实现。该示例包装了内置的 jsonfilelog 日志驱动程序。

LogDriver 协议

日志记录插件必须在插件激活期间注册为 LogDriver。一旦激活，用户就可以将该插件指定为日志驱动。

日志记录插件必须实现两个 HTTP 端点

/LogDriver.StartLogging

向插件发出信号，表示一个容器正在启动，插件应该开始接收该容器的日志。

日志将通过请求中定义的文件进行流式传输。在 Linux 上，此文件是一个 FIFO。目前在 Windows 上不支持日志记录插件。

请求

{
  "File": "/path/to/file/stream",
  "Info": {
          "ContainerID": "123456"
  }
}

File 是需要被消费的日志流的路径。每次调用 StartLogging 都应该提供一个不同的文件路径，即使是插件之前已经接收过日志的容器。该文件由 Docker 创建，名称是随机生成的。

Info 是关于被记录日志的容器的详细信息。这相当自由，但由以下结构定义定义

type Info struct {
	Config              map[string]string
	ContainerID         string
	ContainerName       string
	ContainerEntrypoint string
	ContainerArgs       []string
	ContainerImageID    string
	ContainerImageName  string
	ContainerCreated    time.Time
	ContainerEnv        []string
	ContainerLabels     map[string]string
	LogPath             string
	DaemonName          string
}

ContainerID 将始终随此结构提供，但其他字段可能为空或缺失。

响应

{
  "Err": ""
}

如果在此请求期间发生错误，请在响应的 Err 字段中添加一条错误消息。如果没有错误，您可以发送一个空响应（{}）或一个空的 Err 字段值。

此时，驱动程序应该正在从传入的文件中消费日志消息。如果消息未被消费，可能会导致容器在尝试写入其 stdio 流时阻塞。

日志流消息被编码为协议缓冲区。protobuf 定义位于 moby 仓库中。

由于协议缓冲区不是自定界的，您必须使用以下流格式从流中解码它们

[size][message]

其中 size 是一个 4 字节大端二进制编码的 uint32。size 在这里定义了下一条消息的大小。message 是实际的日志条目。

流编码器/解码器的参考 golang 实现可以在这里找到

/LogDriver.StopLogging

向插件发出信号，停止从定义的文件中收集日志。收到响应后，Docker 将删除该文件。您必须确保在响应此请求之前收集流上的所有日志，否则可能会丢失日志数据。

对此端点的请求并不意味着容器已被移除，只表示它已停止。

请求

{
  "File": "/path/to/file/stream"
}

响应

{
  "Err": ""
}

如果在此请求期间发生错误，请在响应的 Err 字段中添加一条错误消息。如果没有错误，您可以发送一个空响应（{}）或一个空的 Err 字段值。

可选端点

日志插件可以实现两个额外的日志端点

/LogDriver.Capabilities

定义日志驱动程序的功能。您必须实现此端点，Docker 才能利用任何已定义的功能。

请求

{}

响应

{
  "ReadLogs": true
}

支持的功能

• ReadLogs - 这告诉 Docker 该插件能够将日志读回给客户端。报告支持 ReadLogs 的插件必须实现 /LogDriver.ReadLogs 端点。

/LogDriver.ReadLogs

将日志读回给客户端。当调用 docker logs <container> 时使用。

为了让 Docker 使用此端点，插件必须在调用 /LogDriver.Capabilities 时指明。

请求

{
  "ReadConfig": {},
  "Info": {
    "ContainerID": "123456"
  }
}

ReadConfig 是用于读取的选项列表，它由以下 golang 结构定义

type ReadConfig struct {
	Since  time.Time
	Tail   int
	Follow bool
}

• Since 定义了应发送的最早的日志。
• Tail 定义了要读取的行数（例如，像命令 tail -n 10）
• Follow 表示客户端希望在读取现有日志后保持连接，以接收新的日志消息。

Info 是在 /LogDriver.StartLogging 中定义的相同类型。它应用于确定要读取哪组日志。

响应

{{ log stream }}

响应应该是使用与插件从 Docker 消费的消息相同的格式编码的日志消息。