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。

注意

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 驅動程式，請使用金鑰 "log-opts": {"NAME": "VALUE", ...} 編輯 daemon.json。
• 若要設定個別容器的 splunk 驅動程式，請使用帶有旗標 --log-opt NAME=VALUE ... 的 docker run。

如果 label 和 env 鍵之間發生衝突，則 env 的值優先。這兩個選項都會將其他欄位新增到日誌訊息的屬性中。

以下是為 Splunk Enterprise 執行個體指定的日誌選項範例。該執行個體安裝在執行 Docker 守護行程式的同一台機器上。

使用 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 守護行程式的環境變數來設定一些進階選項。