Skip to content
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

Jump to bottom

Update docs for metadata_processors #13650

Merged
merged 3 commits into from
Sep 19, 2019
Merged

Update docs for metadata_processors #13650

Changes from 2 commits
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
15 changes: 12 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,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 will detect an `in_cluster` environment and cache the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
At startup it will detect an `in_cluster` environment and cache the
At startup it detects an `in_cluster` environment and caches the

Present tense is usually preferred, otherwise it reads like something you haven't yet implemented and you're describing what it will do when you have!

However, perhaps it may be more accurate to say "If it detects an in_cluster environment, it caches the Kubernetes-related metadata"? I'm not sure of your exact meaning.

Kubernetes related metadata. If it's not able to detect a valid Kuberentes
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Kubernetes related metadata. If it's not able to detect a valid Kuberentes
Kubernetes-related metadata. If it's not able to detect a valid Kubernetes

configuration, the events will not be annotated with Kubernetes related
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
configuration, the events will not be annotated with Kubernetes related
configuration, the events are not annotated with Kubernetes-related

And again . . .

metadata. Events will be annotated only if a valid configuration was detected.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
metadata. Events will be annotated only if a valid configuration was detected.
metadata. Events are annotated only if a valid configuration is detected.

I'd also put the positive statement first "Events are only annotated if a valid configuration is detected",, then what happens if not.


Each event is annotated with:

* Pod Name
* Pod UID
Expand Down Expand Up @@ -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 will detect a docker environment and cache the metadata.
Copy link
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 events will be annotated with Docker metadata, only if a valid configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The events will be annotated with Docker metadata, only if a valid configuration
The events are annotated with Docker metadata, only if a valid configuration

was detected and the processor is able to reach Docker api.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
was detected and the processor is able to reach Docker api.
is detected and the processor is able to reach Docker API.

Not


Each event is annotated with:

* Container ID
* Name
Expand Down