Add docs for autodiscover #5868

exekias · 2017-12-13T00:06:14Z

This PR adds documentation for #5245

tsg · 2017-12-13T14:28:50Z

filebeat/docs/autodiscover-docker-config.asciidoc

+              exclude_lines: ["^\\s+[\\-`('.|_]"]  # drop asciiart lines
+-------------------------------------------------------------------------------------
+
+This will launch `redis` prospector for all containers running a image with `redis` in its name.


By "this" you mean the above? Seems to start the docker prospector for Redis logs, not the redis prospector. Or the below which seems to start the redis module :).

You are right 😇 , it launches the docker prospector for the redis container, will fix that, thanks!

dedemorton

Nice first cut! I'd like to do a more in-depth edit of the content later on, but it's a good first cut for the initial release.

dedemorton · 2017-12-13T18:51:45Z

libbeat/docs/shared-autodiscover.asciidoc

+Autodiscover allows you to watch for system changes and dynamically adapt settings to them, as they happen.
+This is specially useful when running your infrastructure on containers.
+
+When you run an application on containers it becomes a moving target to the monitoring system, Autodiscover


comma splice. Change the comma to a period here:

...monitoring system. Autodiscover...

dedemorton · 2017-12-13T18:55:44Z

libbeat/docs/shared-autodiscover.asciidoc

+This is specially useful when running your infrastructure on containers.
+
+When you run an application on containers it becomes a moving target to the monitoring system, Autodiscover
+allows you to automatically detect what's running and update settings to monitor it.


It would be good to add a specific example here. Might be tricky since this is shared content, but worth exploring because I think we are being too vague here. (We can solve this later)

dedemorton · 2017-12-13T18:56:45Z

libbeat/docs/shared-autodiscover.asciidoc

+When you run an application on containers it becomes a moving target to the monitoring system, Autodiscover
+allows you to automatically detect what's running and update settings to monitor it.
+
+You can define configuration templates for different containers, Autodiscover subsystem will use them


Will users know what we mean by configuration templates here?

Also, change the comma to a period:

"...different containers. The autodiscover subsystem...

dedemorton · 2017-12-13T19:01:42Z

libbeat/docs/shared-autodiscover.asciidoc

+[float]
+=== Configuration options
+
+Autodiscover settings are defined under {beatname_lc}.autodiscover field, to enable it you must configure


I'd change this around a bit to be consistent with similar sections in the docs. Would also make a few small edits:

You define autodiscover settings in the +{beatname_lc}.autodiscover+ section of the +{beatname_lc}.yml+ config file. To enable autodiscover, you specify a list of providers.

dedemorton · 2017-12-13T19:10:43Z

libbeat/docs/shared-autodiscover.asciidoc

+[float]
+=== Providers
+
+Autodiscover providers work by watching for events on the system and translating that into internal autodiscover


Change:

...and translating that into...

To:

...and translating those events into....

dedemorton · 2017-12-13T19:58:07Z

libbeat/docs/shared-autodiscover.asciidoc

+Conditions match events from the provider, the use the <<conditions,same format from processors conditions>>.
+
+Confiuration templates can contain variables from the autodiscover event, they can be accessed under `data` namespace.
+For example, with the example event, "`${data.port}`" will result into `6379`.


I would say:

"${data.port}" resolves to 6379.

or

"${data.port}" results in 6379.

dedemorton · 2017-12-13T20:00:27Z

metricbeat/docs/autodiscover-docker-config.asciidoc

+              hosts: "${data.host}:6379"
+-------------------------------------------------------------------------------------
+
+This will launch `redis` module for all containers running a image with `redis` in its name.


Change to:

This configuration launches a redis module for all containers running an image with redis in the name.

dedemorton · 2017-12-13T20:01:49Z

filebeat/docs/autodiscover-docker-config.asciidoc

+              exclude_lines: ["^\\s+[\\-`('.|_]"]  # drop asciiart lines
+-------------------------------------------------------------------------------------
+
+This will launch `docker` logs prospector for all containers running a image with `redis` in its name.


Change to:

This configuration launches a docker logs prospector for all containers running an image with redis in the name.

dedemorton · 2017-12-13T20:02:59Z

filebeat/docs/autodiscover-docker-config.asciidoc

+
+This will launch `docker` logs prospector for all containers running a image with `redis` in its name.
+
+When defining modules, you can override default prospector to use docker:


Change to:

If you are using modules, you can override the default prospector and use the docker prospector instead.

dedemorton · 2017-12-13T20:23:33Z

libbeat/docs/shared-autodiscover.asciidoc

+Autodiscover settings are defined under {beatname_lc}.autodiscover field, to enable it you must configure
+a list of providers to be used.
+
+["source","yaml",subs="attributes"]


TBH, I'm not sure this config example is useful without the details of the provider config. I'd suggest removing the entire "Configuration options" section because you don't describe the options. Then you can just tack on the above paragraph to the end of the intro:

...to monitor services as they start running. You define autodiscover settings in the +{beatname_lc}.autodiscover+ section of the +{beatname_lc}.yml+ config file. To enable autodiscover, you specify a list of providers. +[float] +=== Providers

I'd like to make other changes to the intro, but that's probably good enough for now.

exekias · 2017-12-13T21:23:44Z

Thanks for the review and pointers @dedemorton! It should be ready for a second pass :)

dedemorton

Just one small change. otherwise lgtm

dedemorton · 2017-12-13T23:21:23Z

libbeat/docs/shared-autodiscover.asciidoc

 allows you to automatically detect what's running and update settings to monitor it.

-You can define configuration templates for different containers, Autodiscover subsystem will use them
+You can define configuration templates for different containers. Autodiscover subsystem will use them
 to monitor services as they start running.

 [float]


Remove lines 13 and 14. This content doesn't warrant a separate container.

adriansr

LGTM

* Add docs for autodiscover * Fix comment on filebeat autodiscover prospector settings * Apply review comments * Remove configuration options section (cherry picked from commit 223c074)

* Add docs for autodiscover * Fix comment on filebeat autodiscover prospector settings * Apply review comments * Remove configuration options section (cherry picked from commit 3dcb70e)

exekias added docs Filebeat Filebeat in progress Pull request is currently in progress. Metricbeat Metricbeat needs_backport PR is waiting to be backported to other branches. review v6.1.0 labels Dec 13, 2017

Add docs for autodiscover

2ccecdb

exekias force-pushed the autodiscover-docs branch from c71a798 to 2ccecdb Compare December 13, 2017 12:06

exekias removed the in progress Pull request is currently in progress. label Dec 13, 2017

exekias requested a review from dedemorton December 13, 2017 12:06

tsg reviewed Dec 13, 2017

View reviewed changes

Fix comment on filebeat autodiscover prospector settings

0fd6691

dedemorton suggested changes Dec 13, 2017

View reviewed changes

Apply review comments

a58fa54

dedemorton reviewed Dec 13, 2017

View reviewed changes

Remove configuration options section

0f6f40c

adriansr approved these changes Dec 14, 2017

View reviewed changes

tsg merged commit 223c074 into elastic:master Dec 14, 2017

exekias mentioned this pull request Dec 14, 2017

Cherry-pick #5868 to 6.1: Add docs for autodiscover #5879

Merged

exekias removed the needs_backport PR is waiting to be backported to other branches. label Dec 14, 2017

dedemorton mentioned this pull request Jan 22, 2018

Autodiscover #5245

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs for autodiscover #5868

Add docs for autodiscover #5868

exekias commented Dec 13, 2017 •

edited

Loading

tsg Dec 13, 2017

exekias Dec 13, 2017

dedemorton left a comment

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

dedemorton Dec 13, 2017

exekias commented Dec 13, 2017

dedemorton left a comment •

edited

Loading

dedemorton Dec 13, 2017

adriansr left a comment


		This will launch `docker` logs prospector for all containers running a image with `redis` in its name.

		When defining modules, you can override default prospector to use docker:

Add docs for autodiscover #5868

Add docs for autodiscover #5868

Conversation

exekias commented Dec 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dedemorton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

exekias commented Dec 13, 2017

dedemorton left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adriansr left a comment

Choose a reason for hiding this comment

exekias commented Dec 13, 2017 •

edited

Loading

dedemorton left a comment •

edited

Loading