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字段的空值。

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

日志流消息被编码为协议缓冲区。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 时使用此功能。

为了让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消费的消息相同的格式编码的日志消息。