Pilote de logging Splunk

Le pilote de logging splunk envoie les logs de conteneur au collecteur d'événements HTTP dans Splunk Enterprise et Splunk Cloud.

Utilisation

Vous pouvez configurer le logging Docker pour utiliser le pilote splunk par défaut ou sur une base par conteneur.

Pour utiliser le pilote splunk comme pilote de logging par défaut, définissez les clés log-driver et log-opts aux valeurs appropriées dans le fichier de configuration daemon.json et redémarrez Docker. Par exemple :

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

Le fichier daemon.json se trouve dans /etc/docker/ sur les hôtes Linux ou C:\ProgramData\docker\config\daemon.json sur Windows Server. Pour plus d'informations sur la configuration de Docker en utilisant daemon.json, voir daemon.json.

Note

Les options de configuration log-opts dans le fichier de configuration daemon.json doivent être fournies sous forme de chaînes. Les valeurs booléennes et numériques (telles que la valeur pour splunk-gzip ou splunk-gzip-level) doivent donc être entourées de guillemets (").

Pour utiliser le pilote splunk pour un conteneur spécifique, utilisez les drapeaux en ligne de commande --log-driver et log-opt avec docker run :

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

Options Splunk

Les propriétés suivantes vous permettent de configurer le pilote de logging Splunk.

• Pour configurer le pilote splunk à travers l'environnement Docker, modifiez daemon.json avec la clé, "log-opts": {"NAME": "VALUE", ...}.
• Pour configurer le pilote splunk pour un conteneur individuel, utilisez docker run avec le drapeau, --log-opt NAME=VALUE ....

S'il y a collision entre les clés label et env, la valeur de env prend la précédence. Les deux options ajoutent des champs supplémentaires aux attributs d'un message de logging.

Ci-dessous est un exemple des options de logging spécifiées pour l'instance Splunk Enterprise. L'instance est installée localement sur la même machine sur laquelle le daemon Docker fonctionne.

Le chemin vers le certificat racine et le nom commun est spécifié en utilisant un schéma HTTPS. Ceci est utilisé pour la vérification. Le SplunkServerDefaultCert est automatiquement généré par les certificats 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

Le splunk-url pour les instances Splunk hébergées sur Splunk Cloud est dans un format comme https://http-inputs-XXXXXXXX.splunkcloud.com et n'inclut pas de spécificateur de port.

Formats de message

Il y a trois formats de message du pilote de logging : inline (par défaut), json, et 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"}

Options avancées

Le pilote de logging Splunk vous permet de configurer quelques options avancées en définissant des variables d'environnement pour le daemon Docker.