Skip to content

Update docs for metadata_processors #13650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrsMark merged 3 commits into from
Sep 19, 2019
Merged

Update docs for metadata_processors #13650

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
048365c
Update docs
ChrsMark Sep 12, 2019
f1bbf33
Improve docs
ChrsMark Sep 13, 2019
505bb83
Improve phrasing
ChrsMark Sep 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions libbeat/docs/processors-using.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1276,8 +1276,18 @@ 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 will detect an `in_cluster` environment and cache the Kubernetes related metadata.

@jsoriano jsoriano Sep 12, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should more explicitly say that it will get Kubernetes-related metadata only if it finds a working configuration. Same thing for docker.


The simple configuration below enables the processor.

[source,yaml]
-------------------------------------------------------------------------------
processors:
- add_kubernetes_metadata: ~
-------------------------------------------------------------------------------

@jsoriano jsoriano Sep 12, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is no need to add sample configuration, there is already some configuration examples some lines below.


Each event is annotated with:

* Pod Name
* Pod UID
Expand Down Expand Up @@ -1360,7 +1370,17 @@ 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 will detect a docker environment and cache the metadata.

@Titch990 Titch990 Sep 13, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
from Docker containers. At startup it will detect a docker environment and cache the metadata.
from Docker containers. At startup it detects a Docker environment and caches the metadata.


The simple configuration below enables the processor.

[source,yaml]
-------------------------------------------------------------------------------
processors:
- add_docker_metadata: ~
-------------------------------------------------------------------------------

@jsoriano jsoriano Sep 12, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, I think there is no need to add another configuration example.


Each event is annotated with:

* Container ID
* Name
Expand Down