Add document for beat export dashboard #7696

ruflin · 2018-07-24T13:13:40Z

Follow up from #7239

ruflin · 2018-07-24T13:14:58Z

@dedemorton TBH was not 100% sure where to put it. This is basically a middle ground that allows people to export dashboards also without having to check out the Beats source code and build it. We don't really have this yet in the dev guide.

Alternative would be to put it in all guides where we list other commands?

dedemorton · 2018-07-24T23:15:38Z

@ruflin I'll take a closer look at this PR tomorrow. I do think we should add this to the command reference, too. I can take that on in a separate PR. I keep thinking I should bump the command reference up one level in the TOC. It won't change any of the URLs, but might make it more visible. WDYT? (Would mean breaking the content out into separate topics, though, due to asciidoc's limitation about single-chapter sections.)

ruflin · 2018-07-25T06:53:44Z

After your comment I realised this should definitively go into the command reference and not the dev guide. I moved it.

The reason is that the export methods we use in the dev guide produce a different format of dashboards which is used for contributing. The format created by export dashboard is to be used directly if the loading mechanism in Beat.

As commands become more important +1 on moving them up. I had a hard time to find it under Setting up ....

dedemorton

I want to edit this content in a separate PR (just minor stuff, but it'll be easier than peppering your review with comments).

dedemorton · 2018-07-25T17:57:22Z

libbeat/docs/command-reference.asciidoc

+
+
+*`dashboard`*::
+Exporting a dashboard allows to to store a dashboard on disk in a


typo "to to"

dedemorton · 2018-07-25T17:58:34Z

libbeat/docs/command-reference.asciidoc

+will write the dashboard to stdout. Above it's written into `dashboard.json` so
+it can later imported again. The file contains the dashboard with all
+visualizations and searches. The index pattern is removed as it is
+expected to be loaded separately for a Beat.


Change "a Beat" to {beatname_uc} (since this doc appears in each book).

ruflin · 2018-07-26T11:30:13Z

@dedemorton Comments addressed. Looking forward to a bigger refactoring here.

dedemorton

@ruflin Really sorry, but somehow this fell off the back of my wagon. I think I was busy the day I got the review request, because I didn't look very closely and missed a few things.

dedemorton · 2018-08-10T18:08:58Z

libbeat/docs/command-reference.asciidoc

@@ -14,7 +14,7 @@

 :global-flags: Also see <<global-flags,Global flags>>.

-:export-command-short-desc: Exports the configuration or index template to stdout
+:export-command-short-desc: Exports the configuration,index template or a dashboard to stdout


Sorry, missed this during my first review. You need to add a space after configuration,

dedemorton · 2018-08-10T18:11:43Z

libbeat/docs/command-reference.asciidoc

+Exporting a dashboard allows to store a dashboard on disk in a
+module and load it automatically. The following command can be used:
+
+[source,shell]


Since the example contains an asciidoc reference, you need to replace line 122 with:

["source","yaml",subs="attributes"]

dedemorton · 2018-08-10T18:12:48Z

libbeat/docs/command-reference.asciidoc

+*`dashboard`*::
+Exporting a dashboard allows to store a dashboard on disk in a
+module and load it automatically. The following command can be used:
+


Add a plus + here so the example gets indented correctly.

dedemorton · 2018-08-10T18:13:04Z

libbeat/docs/command-reference.asciidoc

+----
+$ {beatname_lc} export dashboard --id="dashboard-id" > dashboard.json
+----
+


Add a plus + here so the text below gets indented correctly.

dedemorton · 2018-08-10T18:13:21Z

libbeat/docs/command-reference.asciidoc

+it can later imported again. The file contains the dashboard with all
+visualizations and searches. The index pattern is removed as it is
+expected to be loaded separately for {beatname_uc}.
+


Add a plus + here so the text below gets indented correctly.

dedemorton · 2018-08-10T18:13:30Z

libbeat/docs/command-reference.asciidoc

+The generated `dashboard.json` file can be copied into the `kibana/6/dashboard`
+directory of {beatname_lc} and next time `{beatname_lc} setup dashboards` is
+run the dashboard will be imported.
+


Add a plus + here so the text below gets indented correctly.

ruflin

Review comments applied.

ruflin · 2018-08-14T06:50:33Z

libbeat/docs/command-reference.asciidoc

@@ -14,7 +14,7 @@

 :global-flags: Also see <<global-flags,Global flags>>.

-:export-command-short-desc: Exports the configuration or index template to stdout
+:export-command-short-desc: Exports the configuration,index template or a dashboard to stdout


dedemorton

I promise I won't keep doing this, but I noticed a couple more minor nits that I missed before.

dedemorton · 2018-08-14T16:26:40Z

libbeat/docs/command-reference.asciidoc

+expected to be loaded separately for {beatname_uc}.
+
+The generated `dashboard.json` file can be copied into the `kibana/6/dashboard`
+directory of {beatname_lc} and next time `{beatname_lc} setup dashboards` is


@ruflin in order for the attribute to resolve

`{beatname_lc} setup dashboards`

needs to be

+{beatname_lc} setup dashboards+ ``` Sorry for missing *another* problem. Sigh.

Changed.

Why does the tick not work here and have to use + instead?

asciidoc treats everything within back ticks as text. Using plus signs forces asciidoc to evaluate the asciidoc references first.

dedemorton · 2018-08-14T16:27:03Z

libbeat/docs/command-reference.asciidoc

+
+["source","shell",subs="attributes"]
+----
+$ {beatname_lc} export dashboard --id="dashboard-id" > dashboard.json


We don't show $ in the other examples (makes copy/pasting harder).

makes sense. I wonder why I have it here. Pretty sure i copied from somewhere.

dedemorton

LGTM

* Add document for beat export dashboard Follow up from elastic#7239 * move to command reference * address review comments * review comments applied * apply review feedback

…#7996) * Add document for beat export dashboard (#7696) * Add safeguard related statements for max_backoff setting (#7889) * Add docs about append_fields (#7903) * Fix processor autodiscovery docs for Filebeat (#7937) * Minor fixes to attributes in module docs (#7949)

* Add document for beat export dashboard Follow up from elastic#7239 * move to command reference * address review comments * review comments applied * apply review feedback

…7937 #7939 #7948 #7949 #7950) (#8188) * Reset modulename attribute at the end of a file (#7888) * Add safeguard related statements for max_backoff setting (#7889) * Add docs about append_fields (#7903) * Add docs about append_fields * Remove experimental tag from setup.template.json.enabled description * Metricbeat: Add compatibility notes where missing (#7939) * Metricbeat: Add compatibility notes where missing, based on integration tests * Added review suggestions * Add missing config options to Logstash section of reference.yml (#7883) Closes #3062 * Fix processor autodiscovery docs for Filebeat (#7937) { needs escaping as otherwise asciidoc will show an empty code block. * Add document for beat export dashboard (#7696) * Add document for beat export dashboard Follow up from #7239 * move to command reference * address review comments * review comments applied * apply review feedback * Replace golang with Go (#7948) I've been told that using "golang" instead of "Go" is considered a faux pas in some circles. :-) I've replaced instances in the external docs, but I did not update the changelog, readmes, or code files. * Minor fixes to attributes in module docs (#7949) * Add recommendation to avoid harvesting symlinks when dealing with file rotation (#7950)

…tic#7903 elastic#7937 elastic#7949) (elastic#7996) * Add document for beat export dashboard (elastic#7696) * Add safeguard related statements for max_backoff setting (elastic#7889) * Add docs about append_fields (elastic#7903) * Fix processor autodiscovery docs for Filebeat (elastic#7937) * Minor fixes to attributes in module docs (elastic#7949)

Add document for beat export dashboard

19d293d

Follow up from elastic#7239

ruflin added docs libbeat labels Jul 24, 2018

ruflin added the review label Jul 24, 2018

move to command reference

26e3e0d

dedemorton reviewed Jul 25, 2018

View reviewed changes

address review comments

59ecfd1

dedemorton suggested changes Aug 10, 2018

View reviewed changes

dedemorton mentioned this pull request Aug 10, 2018

Edit content about exporting dashboards #7945

Closed

review comments applied

da52b54

ruflin commented Aug 14, 2018

View reviewed changes

dedemorton approved these changes Aug 14, 2018

View reviewed changes

apply review feedback

c5c79d0

dedemorton approved these changes Aug 15, 2018

View reviewed changes

ruflin added the needs_backport PR is waiting to be backported to other branches. label Aug 16, 2018

dedemorton merged commit 471c360 into elastic:master Aug 16, 2018

dedemorton mentioned this pull request Aug 17, 2018

Backport to 6.4: Multiple doc changes (#7696 #7889 #7903 #7937 #7949) #7996

Merged

dedemorton mentioned this pull request Aug 17, 2018

Backport to 6.x: Multiple doc changes (#7696 #7883 #7888 #7889 #7903 #7937 #7939 #7948 #7949 #7950) #8011

Closed

dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Aug 18, 2018

dedemorton mentioned this pull request Aug 31, 2018

Backport to 6.x: Multiple doc changes (#7696 #7883 #7888 #7889 #7903 #7937 #7939 #7948 #7949 #7950) #8188

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add document for beat export dashboard #7696

Add document for beat export dashboard #7696

ruflin commented Jul 24, 2018

ruflin commented Jul 24, 2018

dedemorton commented Jul 24, 2018 •

edited

Loading

ruflin commented Jul 25, 2018

dedemorton left a comment

dedemorton Jul 25, 2018

dedemorton Jul 25, 2018

ruflin commented Jul 26, 2018

dedemorton left a comment

dedemorton Aug 10, 2018

ruflin Aug 14, 2018

dedemorton Aug 10, 2018

dedemorton Aug 10, 2018

dedemorton Aug 10, 2018

dedemorton Aug 10, 2018

dedemorton Aug 10, 2018

ruflin left a comment

ruflin Aug 14, 2018

dedemorton left a comment

dedemorton Aug 14, 2018

ruflin Aug 15, 2018

dedemorton Aug 15, 2018

dedemorton Aug 14, 2018

ruflin Aug 15, 2018

dedemorton left a comment



		`dashboard`::
		Exporting a dashboard allows to to store a dashboard on disk in a

Add document for beat export dashboard #7696

Add document for beat export dashboard #7696

Conversation

ruflin commented Jul 24, 2018

ruflin commented Jul 24, 2018

dedemorton commented Jul 24, 2018 • edited Loading

ruflin commented Jul 25, 2018

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

ruflin commented Jul 26, 2018

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

ruflin left a comment

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

dedemorton left a comment

Choose a reason for hiding this comment

dedemorton commented Jul 24, 2018 •

edited

Loading