Splunk 로깅 드라이버

Splunk 로깅 드라이버 (Splunk logging driver)

splunk 로깅 드라이버는 Splunk Enterprise와 Splunk Cloud의 HTTP Event Collector로 컨테이너 로그를 보내요.

출처: 문서

본문

사용법 (Usage)

Docker 로깅이 기본으로 또는 컨테이너별로 splunk 드라이버를 사용하도록 구성할 수 있어요.

splunk 드라이버를 기본 로깅 드라이버로 사용하려면 daemon.json 구성 파일에서 log-driver와 log-opts 키를 적절한 값으로 설정하고 Docker를 재시작해요. 예를 들어:

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

daemon.json으로 Docker를 구성하는 것에 대한 자세한 내용은 daemon.json을 참고하세요.

Note Docker Desktop을 사용한다면 Docker Desktop Dashboard를 통해 데몬 구성을 편집해요. Settings를 열고 Docker Engine을 선택해요. 자세한 내용은 Docker Engine 설정을 참고하세요.

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 options)

다음 속성들을 사용해 Splunk 로깅 드라이버를 구성해요.

• Docker 환경 전체에서 splunk 드라이버를 구성하려면 "log-opts": {"NAME": "VALUE", ...} 키로 daemon.json을 편집해요.
• 개별 컨테이너에 splunk 드라이버를 구성하려면 --log-opt NAME=VALUE ... 플래그로 docker run을 사용해요.

label과 env 키 사이에 충돌이 있으면 env 값이 우선해요. 두 옵션 모두 로깅 메시지의 속성에 추가 필드를 더해요.

아래는 Splunk Enterprise 인스턴스에 대해 지정된 로깅 옵션의 예시예요. 인스턴스는 Docker 데몬이 실행 중인 것과 같은 머신에 로컬로 설치돼 있어요. 루트 인증서 경로와 Common Name은 HTTPS scheme을 사용해 지정돼요. 이는 검증에 사용돼요. 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 같은 형식이며 포트 지정자를 포함하지 않아요.

메시지 형식 (Message formats)

inline(기본값), json, raw의 세 가지 로깅 드라이버 메시징 형식이 있어요.

기본 형식은 각 로그 메시지가 문자열로 임베드되는 inline이에요. 예를 들어:

{
  "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\"}"
}

메시지를 json 객체로 형식화하려면 --log-opt splunk-format=json을 설정해요. 드라이버는 모든 줄을 JSON 객체로 파싱하려 시도하고 이를 임베드된 객체로 보내요. 메시지를 파싱할 수 없으면 inline으로 보내요. 예를 들어:

{
  "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"
  }
}

메시지를 raw로 형식화하려면 --log-opt splunk-format=raw를 설정해요. 속성(환경 변수와 라벨)과 태그가 메시지 앞에 붙어요. 예를 들어:

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

고급 옵션 (Advanced options)

Splunk 로깅 드라이버를 사용하면 Docker 데몬용 환경 변수를 설정해 몇 가지 고급 옵션을 구성할 수 있어요.

더 알아보기 (Learn more)

• 로깅 개요
• 로그 태그 옵션
• Splunk HTTP Event Collector 문서