From e598d6cb7bfecbabeff82a7f7e3495b00d290aa2 Mon Sep 17 00:00:00 2001 From: Chris Mark Date: Thu, 19 Sep 2019 10:04:14 +0300 Subject: [PATCH] Update docs for metadata_processors (#13650) --- libbeat/docs/processors-using.asciidoc | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/libbeat/docs/processors-using.asciidoc b/libbeat/docs/processors-using.asciidoc index 29d878134d63..4ec657286b12 100644 --- a/libbeat/docs/processors-using.asciidoc +++ b/libbeat/docs/processors-using.asciidoc @@ -1276,8 +1276,13 @@ section. === Add Kubernetes metadata The `add_kubernetes_metadata` processor annotates each event with relevant -metadata based on which Kubernetes pod the event originated from. Each event is -annotated with: +metadata based on which Kubernetes pod the event originated from. +At startup it detects an `in_cluster` environment and caches the +Kubernetes-related metadata. Events are only annotated if a valid configuration +is detected. If it's not able to detect a valid Kubernetes configuration, +the events are not annotated with Kubernetes-related metadata. + +Each event is annotated with: * Pod Name * Pod UID @@ -1360,7 +1365,11 @@ case you want to specify your own. === Add Docker metadata The `add_docker_metadata` processor annotates each event with relevant metadata -from Docker containers: +from Docker containers. At startup it detects a docker environment and caches the metadata. +The events are annotated with Docker metadata, only if a valid configuration +is detected and the processor is able to reach Docker API. + +Each event is annotated with: * Container ID * Name