From 79b1528b7bfbf5152041db8f4ab497af6afa06e2 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 29 Apr 2024 12:03:30 -0400 Subject: [PATCH] Mark add_docker-metadata process as unsupported in packetbeat (#39241) (#39272) * Mark add_docker-metadata process as unsupported in packetbeat * Update libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc (cherry picked from commit 11998672ace0b4e652bfe2edb437bc851880ec7f) Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> --- .../add_docker_metadata/docs/add_docker_metadata.asciidoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc b/libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc index 53292667f13b..616582101733 100644 --- a/libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc +++ b/libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc @@ -5,6 +5,11 @@ add_docker_metadata ++++ +ifeval::["{beatname_lc}"=="packetbeat"] +There is currently extremely limited capability for using {beatname_lc} to monitor and coexist with containers, for example Docker, Podman, or Kubernetes. Using the `add_docker_metadata` processor with {beatname_lc} is not recommended nor supported. +endif::[] + +ifeval::["{beatname_lc}"!="packetbeat"] The `add_docker_metadata` processor annotates each event with relevant metadata 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 @@ -88,3 +93,4 @@ forget metadata for a container, 60s by default. `labels.dedot`:: (Optional) Default to be false. If set to true, replace dots in labels with `_`. +endif::[] \ No newline at end of file