Splunk 日志记录驱动程序

splunk 日志记录驱动程序将容器日志发送到 Splunk Enterprise 和 Splunk Cloud 中的 HTTP 事件收集器。

用法

您可以将 Docker 日志记录配置为默认使用 splunk 驱动程序，或者针对每个容器单独配置。

要将 splunk 驱动程序用作默认日志记录驱动程序，请在 daemon.json 配置文件中将 log-driver 和 log-opts 键设置为适当的值，然后重新启动 Docker。例如：

{
  "log-driver": "splunk",
  "log-opts": {
    "splunk-token": "",
    "splunk-url": "",
    ...
  }
}

daemon.json 文件在 Linux 主机上位于 /etc/docker/，在 Windows Server 上位于 C:\ProgramData\docker\config\daemon.json。有关使用 daemon.json 配置 Docker 的更多信息，请参阅 daemon.json。

Note

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

要将 splunk 驱动程序用于特定容器，请在 docker run 命令中使用命令行标志 --log-driver 和 --log-opt：

$ docker run --log-driver=splunk --log-opt splunk-token=VALUE --log-opt splunk-url=VALUE ...

Splunk 选项

以下属性让您配置 Splunk 日志记录驱动程序。

• 要在 Docker 环境中配置 splunk 驱动程序，请编辑 daemon.json，使用键 "log-opts": {"NAME": "VALUE", ...}。
• 要为单个容器配置 splunk 驱动程序，请在 docker run 中使用标志 --log-opt NAME=VALUE ...。

如果 label 和 env 键之间存在冲突，则 env 的值优先。这两个选项都会向日志消息的属性添加额外的字段。

以下是为 Splunk Enterprise 实例指定的日志记录选项示例。该实例本地安装在运行 Docker 守护程序的同一台机器上。

使用 HTTPS 方案指定了根证书和通用名称 (Common Name) 的路径。这用于验证。SplunkServerDefaultCert 是由 Splunk 证书自动生成的。

$ docker run \
    --log-driver=splunk \
    --log-opt splunk-token=176FCEBF-4CF5-4EDF-91BC-703796522D20 \
    --log-opt splunk-url=https://splunkhost:8088 \
    --log-opt splunk-capath=/path/to/cert/cacert.pem \
    --log-opt splunk-caname=SplunkServerDefaultCert \
    --log-opt tag="{{.Name}}/{{.FullID}}" \
    --log-opt labels=location \
    --log-opt env=TEST \
    --env "TEST=false" \
    --label location=west \
    your/application

托管在 Splunk Cloud 上的 Splunk 实例的 splunk-url 格式为 https://http-inputs-XXXXXXXX.splunkcloud.com，不包含端口说明符。

消息格式

日志记录驱动程序有三种消息传递格式：inline（默认）、json 和 raw。

{
  "attrs": {
    "env1": "val1",
    "label1": "label1"
  },
  "tag": "MyImage/MyContainer",
  "source": "stdout",
  "line": "my message"
}

{
  "attrs": {
    "env1": "val1",
    "label1": "label1"
  },
  "tag": "MyImage/MyContainer",
  "source": "stdout",
  "line": "{\"foo\": \"bar\"}"
}

{
  "attrs": {
    "env1": "val1",
    "label1": "label1"
  },
  "tag": "MyImage/MyContainer",
  "source": "stdout",
  "line": "my message"
}

{
  "attrs": {
    "env1": "val1",
    "label1": "label1"
  },
  "tag": "MyImage/MyContainer",
  "source": "stdout",
  "line": {
    "foo": "bar"
  }
}

MyImage/MyContainer env1=val1 label1=label1 my message
MyImage/MyContainer env1=val1 label1=label1 {"foo": "bar"}

高级选项

Splunk 日志记录驱动程序允许您通过为 Docker 守护程序设置环境变量来配置一些高级选项。