Splunk 日誌驅動程式

splunk 記錄驅動程式會將容器記錄發送到 Splunk Enterprise 和 Splunk Cloud 中的 HTTP 事件收集器 (HTTP Event Collector)。

使用方式

您可以將 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。

注意

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 驅動程式，請使用帶有 --log-opt NAME=VALUE ... 旗標的 docker run 指令。

如果 label 和 env 鍵之間發生衝突，則以 env 的值為準。這兩個選項都會將額外的欄位新增至記錄訊息的屬性中。

以下是為 Splunk Enterprise 執行個體指定的記錄選項範例。該執行個體安裝在本機，即執行 Docker 常駐程式 (daemon) 的同一台機器上。

根憑證和通用名稱的路徑是使用 HTTPS 配置指定的。這用於驗證。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 常駐程式設定環境變數來配置一些進階選項。