Skip to content

Commit

Permalink
Add documentation about -folder flag to dashboard exporting (#27696) (#…
Browse files Browse the repository at this point in the history
…27736)

* Add note about -folder flag

* Update docs/devguide/newdashboards.asciidoc

Co-authored-by: Jaime Soriano Pastor <jaime.soriano@elastic.co>

Co-authored-by: Jaime Soriano Pastor <jaime.soriano@elastic.co>
(cherry picked from commit bad0049)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
  • Loading branch information
mergify[bot] and kvch authored Sep 6, 2021
1 parent 3e7338f commit 606e189
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/devguide/newdashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -255,11 +255,11 @@ MODULE=redis ID=AV4REOpp5NkDleZmzKkE mage exportDashboard

[source,shell]
---------------
./filebeat export dashboard -id 7fea2930-478e-11e7-b1f0-cb29bac6bf8b >> Filebeat-redis.ndjson
./filebeat export dashboard -id 7fea2930-478e-11e7-b1f0-cb29bac6bf8b -folder module/redis
---------------

This generates a `AV4REOpp5NkDleZmzKkE.ndjson` file inside dashboard directory in the redis module.
It contains all dependencies like visualizations and searches.
This generates an appropriate folder under module/redis for the dashboard, separating assets into dashboards, searches, vizualizations, etc.
Each exported file is a JSON and their names are the IDs of the assets.

NOTE: The dashboard ID is available in the dashboard URL. For example, in case the dashboard URL is
`app/kibana#/dashboard/AV4REOpp5NkDleZmzKkE?_g=()&_a=(description:'Overview%2...`, the dashboard ID is `AV4REOpp5NkDleZmzKkE`.
Expand Down Expand Up @@ -291,7 +291,7 @@ By passing the yml file to the `export_dashboards.go` script or to the Beat, you

[source,shell]
-------------------
go run dev-tools/cmd/dashboards/export_dashboards.go -yml filebeat/module/system/module.yml
go run dev-tools/cmd/dashboards/export_dashboards.go -yml filebeat/module/system/module.yml -folder dashboards
-------------------

[source,shell]
Expand Down

0 comments on commit 606e189

Please sign in to comment.