Skip to content

Commit

Permalink
Mark add_docker-metadata process as unsupported in packetbeat (#39241) (
Browse files Browse the repository at this point in the history
#39273)

* Mark add_docker-metadata process as unsupported in packetbeat

* Update libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc

(cherry picked from commit 1199867)

Co-authored-by: David Kilfoyle <[email protected]>
  • Loading branch information
mergify[bot] and kilfoyle authored Apr 29, 2024
1 parent c86f33e commit 12d9312
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
<titleabbrev>add_docker_metadata</titleabbrev>
++++

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
Expand Down Expand Up @@ -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::[]

0 comments on commit 12d9312

Please sign in to comment.