From 606e189bc9c26890544f5892877ddf45078e3c87 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 6 Sep 2021 16:05:43 +0200 Subject: [PATCH] Add documentation about -folder flag to dashboard exporting (#27696) (#27736) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add note about -folder flag * Update docs/devguide/newdashboards.asciidoc Co-authored-by: Jaime Soriano Pastor Co-authored-by: Jaime Soriano Pastor (cherry picked from commit bad004915bc62fdc99d04308611b3ab4152c0e5c) Co-authored-by: Noémi Ványi --- docs/devguide/newdashboards.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/devguide/newdashboards.asciidoc b/docs/devguide/newdashboards.asciidoc index 896670cee293..6dc0b895fc69 100644 --- a/docs/devguide/newdashboards.asciidoc +++ b/docs/devguide/newdashboards.asciidoc @@ -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`. @@ -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]