Controlador de registro Splunk

El controlador de registro splunk envía los registros de los contenedores al HTTP Event Collector (Colector de eventos HTTP) en Splunk Enterprise y Splunk Cloud.

Uso

Puedes configurar el sistema de registro de Docker para que utilice el controlador splunk de forma predeterminada o por contenedor.

Para usar el controlador splunk como el controlador de registro predeterminado, establece las claves log-driver y log-opts con los valores adecuados en el archivo de configuración daemon.json y reinicia Docker. Por ejemplo:

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

Para obtener más información sobre cómo configurar Docker mediante daemon.json, consulta daemon.json.

Note

Si usas Docker Desktop, edita la configuración del demonio a través del panel de Docker Desktop. Abre Settings y selecciona Docker Engine. Para más detalles, consulta Configuración de Docker Engine.

Note

Las opciones de configuración de log-opts en el archivo de configuración daemon.json deben proporcionarse como cadenas. Los valores booleanos y numéricos (como el valor para splunk-gzip o splunk-gzip-level) deben, por lo tanto, estar entre comillas (").

Para utilizar el controlador splunk para un contenedor específico, utiliza las opciones de la línea de comandos --log-driver y --log-opt con docker run:

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

Opciones de Splunk

Las siguientes propiedades te permiten configurar el controlador de registro Splunk.

• Para configurar el controlador splunk en todo el entorno de Docker, edita el archivo daemon.json con la clave "log-opts": {"NOMBRE": "VALOR", ...}.
• Para configurar el controlador splunk para un contenedor individual, utiliza docker run con la opción --log-opt NOMBRE=VALOR ....

Si ocurre una colisión entre las claves de label y env, el valor de env tiene prioridad. Ambas opciones añaden campos adicionales a los atributos de un mensaje de registro.

A continuación se muestra un ejemplo de las opciones de registro especificadas para la instancia de Splunk Enterprise. La instancia está instalada localmente en la misma máquina en la que se ejecuta el demonio de Docker.

La ruta al certificado raíz y el Nombre Común (Common Name) se especifican utilizando un esquema HTTPS. Esto se utiliza para la verificación. El certificado SplunkServerDefaultCert se genera automáticamente a partir de los certificados de 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=/ruta/al/certificado/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 \
    tu/aplicacion

La opción splunk-url para las instancias de Splunk alojadas en Splunk Cloud tiene un formato similar a https://http-inputs-XXXXXXXX.splunkcloud.com y no incluye un especificador de puerto.

Formatos de mensaje

Existen tres formatos de mensajería para el controlador de registro: inline (predeterminado), json y 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"}

Opciones avanzadas

El controlador de registro Splunk te permite configurar algunas opciones avanzadas estableciendo variables de entorno para el demonio de Docker.