Add support to export dashboard to Beat #7239

ruflin · 2018-06-01T10:41:41Z

Currently to export a Dashboard from the Kibana exporter API it has to be done manually or the Beats repository must be used. To simplify the exporting of own dashboards the command beat export dashboard --id="dashboard-id" is added. This should allow all users to export their own dashboards.

The output is written to stdout, so the expected usage is to pipe it into a file inside the kibana/dashboards/6 directory.

For the Kibana connection settings it uses the setting from setup.kibana.*. If none are set it uses the defaults.

houndci-bot · 2018-06-01T10:42:04Z

libbeat/kibana/client.go

@@ -246,6 +246,22 @@ func (client *Client) ImportJSON(url string, params url.Values, jsonBody map[str

 func (client *Client) Close() error { return nil }

+// GetDashboard returns the dashboard with the given id with the index pattern removed
+func (c *Client) GetDashboard(id string) (common.MapStr, error) {


receiver name c should be consistent with previous receiver name client for Client

Currently to export a Dashboard from the Kibana exporter API it has to be done manually or the Beats repository must be used. To simplify the exporting of own dashboards the command `beat export dashboard --id="dashboard-id"` is added. This should allow all users to export their own dashboards. The output is written to stdout, so the expected usage is to pipe it into a file inside the `kibana/dashboards/6` directory. For the Kibana connection settings it uses the setting from `setup.kibana.*`. If none are set it uses the defaults.

ruflin · 2018-06-01T10:45:41Z

@dedemorton I was not sure where I should put the docs for this one. Suggestions?

dedemorton · 2018-06-01T17:13:13Z

@ruflin There are a few places where we should talk about exporting dashboards:

Update the content about the export command here: Make sure you also update the short description at the beginning of the topic. (I wish asciidoc had support for proper railroad track style syntax diagrams because one would be useful here. The examples help with the syntax, tho, so make sure you add one for export dashboards.)
In the Beats Developer Guide, add a new section called something like "Exporting dashboards to stdout or a file" to the existing topic here. You'll need to rework the intro a bit.
In a couple of places where we talk about the dashboards (for example, here and here), add a tip to tell users that they can export the dashboards after customizing them, and point to the developer guide for more info.

TBH, I think we have overloaded the getting started topics in the reference guide. We should have a separate section that tells users how to work with the assets (like dashboards) that Beats deploys. Customizing and exporting our dashboards isn't just a developer task, I think. Someday....

dedemorton · 2018-06-01T17:21:07Z

note that I've created a related enhancement request here: #7243

ruflin · 2018-06-04T07:14:20Z

@dedemorton Thanks for the pointers. Will open a follow up PR with the docs changes.

In elastic#7239 support to export a dashboard is a added to each Beat. This is expected to be used by users. The export_dashboard script from the Beats repository is expected by the Devs and contributors which want to add new dashboards. In elastic#7224 the dashboards are modified to be stored with decoded json objects for better versioning. This change modifies the export dashboard script so it generates the same decoded output so no additional conversion is needed. Note: The export_dashboard script could need some cleanup but I didn't tackle this in this PR and leave it for later to keep the change to a minimum.

In #7239 support to export a dashboard is a added to each Beat. This is expected to be used by users. The export_dashboard script from the Beats repository is expected by the Devs and contributors which want to add new dashboards. In #7224 the dashboards are modified to be stored with decoded json objects for better versioning. This change modifies the export dashboard script so it generates the same decoded output so no additional conversion is needed.

Follow up from elastic#7239

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

* 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)

ruflin added review libbeat :Dashboards labels Jun 1, 2018

houndci-bot reviewed Jun 1, 2018

View reviewed changes

ruflin force-pushed the improve-dashboard-exporter branch from 05aa12a to 6e61482 Compare June 1, 2018 10:43

ruflin force-pushed the improve-dashboard-exporter branch from 6e61482 to 373245d Compare June 1, 2018 10:43

make hound-ci happy

e72041c

add missing version

962d121

ruflin mentioned this pull request Jun 1, 2018

Update export_dashboard script to export full dashboard json doc #7241

Merged

kvch approved these changes Jun 1, 2018

View reviewed changes

jsoriano approved these changes Jun 4, 2018

View reviewed changes

jsoriano merged commit ccd36fb into elastic:master Jun 4, 2018

ruflin deleted the improve-dashboard-exporter branch June 4, 2018 07:44

ruflin mentioned this pull request Jun 5, 2018

Improve dashboard handling, exporting, loading #7262

Closed

19 tasks

roncohen mentioned this pull request Jun 6, 2018

Kibana Index Patterns going out-of-sync elastic/apm-server#991

Closed

ruflin added a commit to ruflin/beats that referenced this pull request Jul 24, 2018

Add document for beat export dashboard

19d293d

Follow up from elastic#7239

ruflin mentioned this pull request Jul 24, 2018

Add document for beat export dashboard #7696

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support to export dashboard to Beat #7239

Add support to export dashboard to Beat #7239

ruflin commented Jun 1, 2018 •

edited

Loading

houndci-bot Jun 1, 2018

ruflin commented Jun 1, 2018

dedemorton commented Jun 1, 2018

dedemorton commented Jun 1, 2018

ruflin commented Jun 4, 2018

Add support to export dashboard to Beat #7239

Add support to export dashboard to Beat #7239

Conversation

ruflin commented Jun 1, 2018 • edited Loading

houndci-bot Jun 1, 2018

Choose a reason for hiding this comment

ruflin commented Jun 1, 2018

dedemorton commented Jun 1, 2018

dedemorton commented Jun 1, 2018

ruflin commented Jun 4, 2018

ruflin commented Jun 1, 2018 •

edited

Loading