Splunk 日志记录驱动程序

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

用法

您可以将 Docker 日志记录配置为默认使用驱动程序，也可以在 每个容器。splunk

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

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

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

注意

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

要使用特定容器的驱动程序，请使用命令行标志和：splunk--log-driverlog-optdocker run

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

Splunk 选项

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

• 要跨 Docker 环境配置驱动程序，请使用注册表项进行编辑。splunkdaemon.json"log-opts": {"NAME": "VALUE", ...}
• 要为单个容器配置驱动程序，请与标志 .splunkdocker run--log-opt NAME=VALUE ...

如果 和 键之间存在冲突，则 the 的值优先。这两个选项都会向 logging 消息。labelenvenv

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

根证书和公用名的路径是使用 HTTPS 指定的 方案。这用于验证。的 由 Splunk 证书自动生成。SplunkServerDefaultCert

$ 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 实例，其格式为 like 的 API 中，不包含 port 说明符。splunk-urlhttps://http-inputs-XXXXXXXX.splunkcloud.com

消息格式

有三种日志记录驱动程序消息格式：（默认）、 、 和。inlinejsonraw

{
  "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 日志记录驱动程序允许您通过设置 环境变量。