More generic docs for use in APM Server #6184

roncohen · 2018-01-25T19:44:16Z

Use specific beat name name instead of "the Beat"
Make Logstash and other outputs optional for the beat
Decouple the index pattern from the beat name

dedemorton

One minor typo; otherwise, LGTM with one caveat: I only tested that the docs build without errors. I didn't verify that the new conditional sections render as expected.

dedemorton · 2018-01-26T01:10:29Z

libbeat/docs/dashboardsconfig.asciidoc

@@ -20,7 +20,7 @@ To load the dashboards, you can either enable dashboard loading in the
 run the `setup` command. Dashboard loading is disabled by default.

 When dashboard loading is enabled, {beatname_uc} uses the Kibana API to load the
-sample dashboards. Dashboard loading is only attempted at Beat startup.
+sample dashboards. Dashboard loading is only attempted when {beatname_uc} startups up.


typo: startups up

ruflin · 2018-01-27T23:21:50Z

@roncohen Seeing you pushed some more change, I'm curious if it's ready for merge? As Dede is off this week, please ping me if yes.

roncohen · 2018-01-30T16:44:06Z

there's more incoming @ruflin

roncohen · 2018-01-31T13:11:34Z

quite a few things changed so this probably needs another round from @dedemorton

tsg · 2018-01-31T14:38:06Z

libbeat/docs/loggingconfig.asciidoc

@@ -63,11 +63,11 @@ errors, there will be no log file in the directory specified for logs.
 [[level]]
 ==== `logging.level`

-Minimum log level. One of `debug`, `info`, `warning`, or `error`. The default
+Minimum log level. One of `debug`, `info`, `warn`, or `error`. The default


Remember to change this back to warning, as we went for making warning work again in #6240

fixed. Thanks for the reminder.

…tion.

removed version note as these docs are only for this version

…at for filebeat

graphaelli · 2018-02-14T14:33:25Z

@tsg @dedemorton can one or both of you sign off on this one?

dedemorton · 2018-02-14T17:45:52Z

@graphaelli Oh sorry. I was on vacation when the notification came through and didn't see the notification from GitHub. I'll take a look sometime today.

dedemorton

Mostly minor stuff.

dedemorton · 2018-02-15T01:41:35Z

libbeat/docs/command-reference.asciidoc

 :setup-command-short-desc: Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available)
+else::[]


I don't think asciidoc supports this style of conditional coding. When I ran with has_ml_jobs: no, the description was blank.

You might need to wrap the text in its own statement:

ifeval::["{has_ml_jobs}"=="yes"] :setup-command-short-desc: Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available) endif::[] ifeval::["{has_ml_jobs}"!="yes"] :setup-command-short-desc: Sets up the initial environment, including the index template, and Kibana dashboards (when available) endif::[]

dedemorton · 2018-02-15T02:00:36Z

libbeat/docs/outputconfig.asciidoc

@@ -13,6 +13,12 @@
 [[configuring-output]]
 == Configure the output

+ifdef::only-elasticsearch[]
+You configure {beatname_uc} to write to Elasticsearch by setting options in
+the `output.elasticsearch` of the +{beatname_lc}.yml+ config file.


I'd say either "in the output.elasticsearch section of the +{beatname_lc}.yml+ config file" or "under output.elasticsearch in the +{beatname_lc}.yml+ config file."

dedemorton · 2018-02-15T02:12:40Z

libbeat/docs/shared-ssl-config.asciidoc

@@ -1,5 +1,5 @@
 [[configuration-ssl]]
-== Specify SSL settings
+== SSL settings for outputs


The SSL settings are relevant for other stuff (like kibana), too, so I wouldn't change the title here.

dedemorton · 2018-02-15T02:47:33Z

libbeat/docs/template-config.asciidoc

 You can adjust the following settings to load your own template or overwrite an
 existing one.

 *`setup.template.enabled`*:: Set to false to disable template loading. If set this to false,
 you must <<load-template-manually,load the template manually>>.

 *`setup.template.name`*:: The name of the template. The default is
-+{beatname_lc}+. The Beat version is always appended to the given
+{beatname_lc}-*+. The {beatname_uc} version is always appended to the given


Does this asterisk really belong here?

roncohen · 2018-02-19T11:16:02Z

I've addressed your comments in 5a4de2b. Let me know if there's anything else

roncohen · 2018-02-21T08:01:28Z

@dedemorton OK to merge?

dedemorton · 2018-02-21T18:07:20Z

@roncohen Yes (as long as the CI failures look OK to you...TBH, I'm never quite sure which CI failures I can ignore).

Do we need to backport these changes to 6.2? Or are they for 6.3 and later?

Fixed according to comments.

* Use specific beat name's instead of 'the Beat' * Dont show Logstash info unless it's supported. * Make the index pattern decoupled from the beat name * Make it possible to skip the pipeline docs in output.elasticsearch * Introduce beat_default_index_prefix. * Use name of beat in shared-kibana-config.asciidoc * Add .\ for PS instruction and make it possible to remove logstash mention. * Introduce 'has_ml_jobs' * Added `html_docs` to .gitignore * Better outputconfig for Elasticsearch only beats. * Less blamy wording * Only talk about Filebeat for filebeat docs * Update the rest of the max_retries sections to only talk about Filebeat for filebeat * Special case for apm-server as it was only introduced in 6.0 * expand beat_default_index_prefix use (elastic#2)

* Use specific beat name's instead of 'the Beat' * Dont show Logstash info unless it's supported. * Make the index pattern decoupled from the beat name * Make it possible to skip the pipeline docs in output.elasticsearch * Introduce beat_default_index_prefix. * Use name of beat in shared-kibana-config.asciidoc * Add .\ for PS instruction and make it possible to remove logstash mention. * Introduce 'has_ml_jobs' * Added `html_docs` to .gitignore * Better outputconfig for Elasticsearch only beats. * Less blamy wording * Only talk about Filebeat for filebeat docs * Update the rest of the max_retries sections to only talk about Filebeat for filebeat * Special case for apm-server as it was only introduced in 6.0 * expand beat_default_index_prefix use (#2)

* Use specific beat name's instead of 'the Beat' * Dont show Logstash info unless it's supported. * Make the index pattern decoupled from the beat name * Make it possible to skip the pipeline docs in output.elasticsearch * Introduce beat_default_index_prefix. * Use name of beat in shared-kibana-config.asciidoc * Add .\ for PS instruction and make it possible to remove logstash mention. * Introduce 'has_ml_jobs' * Added `html_docs` to .gitignore * Better outputconfig for Elasticsearch only beats. * Less blamy wording * Only talk about Filebeat for filebeat docs * Update the rest of the max_retries sections to only talk about Filebeat for filebeat * Special case for apm-server as it was only introduced in 6.0 * expand beat_default_index_prefix use (elastic#2)

roncohen mentioned this pull request Jan 25, 2018

Docs improvements elastic/apm-server#548

Merged

ruflin requested a review from dedemorton January 26, 2018 00:41

ruflin added docs review labels Jan 26, 2018

dedemorton suggested changes Jan 26, 2018

View reviewed changes

roncohen force-pushed the use-specific-beat-name branch from 80e481b to 6bd1bdf Compare January 26, 2018 14:36

roncohen force-pushed the use-specific-beat-name branch from 639f193 to 5f597df Compare January 31, 2018 12:27

tsg reviewed Jan 31, 2018

View reviewed changes

graphaelli mentioned this pull request Feb 1, 2018

x-pack security docs elastic/apm-server#546

Merged

Ron Cohen added 18 commits February 9, 2018 13:29

Use specific beat name's instead of 'the Beat'

16833cd

Dont show Logstash info unless it's supported.

54cc9f4

Dont show Logstash info if not supported.

0539799

Make the index pattern decoupled from the beat name

74f2e49

Make it possible to skip the pipeline docs in output.elasticsearch

0b16e74

Use the specific beat name.

4396b35

Fix typo as suggested by @dedemorton.

5745abf

More beat_default_index_prefix.

97e3648

Use name of beat in shared-kibana-config.asciidoc

3d41272

Add .\ for PS instruction and make it possible to remove logstash men…

dd8aef8

…tion.

Introduce 'has_ml_jobs'

fe3fb16

Added html_docs to .gitignore

81b40cf

Better outputconfig for Elasticsearch only beats.

29e1fec

Less blamy wording and ..

0219cff

removed version note as these docs are only for this version

Fix list in output config

e3f055d

Only talk about Filebeat for filebeat docs

5b25d58

It's 'warn', not 'warning'. Found by @simitt

06ff123

Update the rest of the max_retries sections to only talk about Filebe…

5319f24

…at for filebeat

Ron Cohen and others added 4 commits February 9, 2018 13:32

Special case for apm-server as it was only introduced in 6.0

5880999

expand beat_default_index_prefix use (#2)

98dd57a

Revert 'warn' -> 'warning' change.

5344b7b

Add missing quotes.

6ab153b

roncohen force-pushed the use-specific-beat-name branch from d31bcb4 to 6ab153b Compare February 9, 2018 12:36

Fix conditionals

9232834

dedemorton previously requested changes Feb 15, 2018

View reviewed changes

Fixed according to @dedemorton's comments.

5a4de2b

roncohen merged commit 1f0189d into elastic:master Feb 22, 2018

jalvz added a commit to jalvz/apm-server that referenced this pull request Feb 26, 2018

Incorporate doc updates from elastic/beats#6184

81a2b44

jalvz added a commit to elastic/apm-server that referenced this pull request Mar 8, 2018

Incorporate doc updates from elastic/beats#6184

c3a3221

simitt pushed a commit to simitt/apm-server that referenced this pull request Mar 22, 2018

Incorporate doc updates from elastic/beats#6184

22a5831

simitt pushed a commit to elastic/apm-server that referenced this pull request Mar 22, 2018

Incorporate doc updates from elastic/beats#6184

ff0da20

bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Dec 18, 2023

Incorporate doc updates from elastic/beats#6184

07b1fdd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More generic docs for use in APM Server #6184

More generic docs for use in APM Server #6184

roncohen commented Jan 25, 2018

dedemorton left a comment

dedemorton Jan 26, 2018

ruflin commented Jan 27, 2018

roncohen commented Jan 30, 2018

roncohen commented Jan 31, 2018

tsg Jan 31, 2018

roncohen Feb 5, 2018

graphaelli commented Feb 14, 2018 •

edited

Loading

dedemorton commented Feb 14, 2018

dedemorton left a comment

dedemorton Feb 15, 2018

dedemorton Feb 15, 2018

dedemorton Feb 15, 2018

dedemorton Feb 15, 2018

roncohen commented Feb 19, 2018

roncohen commented Feb 21, 2018

dedemorton commented Feb 21, 2018

		:setup-command-short-desc: Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available)
		else::[]

More generic docs for use in APM Server #6184

More generic docs for use in APM Server #6184

Conversation

roncohen commented Jan 25, 2018

dedemorton left a comment

Choose a reason for hiding this comment

dedemorton Jan 26, 2018

Choose a reason for hiding this comment

ruflin commented Jan 27, 2018

roncohen commented Jan 30, 2018

roncohen commented Jan 31, 2018

tsg Jan 31, 2018

Choose a reason for hiding this comment

roncohen Feb 5, 2018

Choose a reason for hiding this comment

graphaelli commented Feb 14, 2018 • edited Loading

dedemorton commented Feb 14, 2018

dedemorton left a comment

Choose a reason for hiding this comment

dedemorton Feb 15, 2018

Choose a reason for hiding this comment

dedemorton Feb 15, 2018

Choose a reason for hiding this comment

dedemorton Feb 15, 2018

Choose a reason for hiding this comment

dedemorton Feb 15, 2018

Choose a reason for hiding this comment

roncohen commented Feb 19, 2018

roncohen commented Feb 21, 2018

dedemorton commented Feb 21, 2018

graphaelli commented Feb 14, 2018 •

edited

Loading