Skip to content

Commit

Permalink
Add dashboard autogeneration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
colmose committed Mar 21, 2018
1 parent 655a15d commit 7b958e9
Show file tree
Hide file tree
Showing 17 changed files with 77 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ image:images/darktheme.png[Dark Theme Example]

NOTE: You can change the default theme in the *Advanced* section of the *Settings* tab.

include::dashboard/auto-generate.asciidoc[]

[[saving-dashboards]]
== Saving Dashboards

Expand Down
32 changes: 32 additions & 0 deletions docs/dashboard/auto-generate.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[[autogenerate-dashboard]]
== Autogenerate Dashboard

If you have selected fields (or used the `autoselect fields` feature) in **Discover**, you can click the image:images/discover/generate-dashboard-button.png[Generate Dashboard Button]
button to autogenerate a dashboard from those selected fields.
This will create a new dashboard with visualizations selected to display the data in those fields.

First the generated dashboard details are shown and can be edited:

image::images/dashboard/auto-generate/create-panel.png["Create Autogenerated Dashboard Panel", align="center"]

Here, you can edit the title of the new dashboard, choose whether to store the time with the dashboard
(a time filter set on the dashboard will be stored and retrieved when the dashboard is reloaded).

If you wish to add a <<kibi_multi_chart, Multichart visualization>> to the dashboard, select the checkbox.
Be aware that this can slow the generation of the dashboard.

=== Generate Dashboard Report

Clicking image:images/discover/auto-select-test-modal-ok-button.png[Generate Dashboard Modal OK Button] on the generated dashboard's details panel opens a panel showing the details of the visualizations to be
added to the dashboard:

image::images/dashboard/auto-generate/generate-vis-report-panel.png["Generate Dashboard Visualizations Panel", align="center"]

Here, the visualizations to be applied to the dashboard are listed. You can choose whether or not to add them with the
checkboxes on the left and you can also edit the automatically generated title of each visualization in the input boxes on the right.

Clicking on image:images/discover/auto-select-test-modal-ok-button.png[Generate Dashboard Visualizations Modal OK Button] here will save and generate your new dashboard...

image::images/dashboard/auto-generate/new-auto-gen-dashboard.png["New Auto Generated Dashboard", align="center"]

If you wish to resize or reorder your visualizations on the dashboard, hit the **Edit** button on the top bar to begin customizing.
2 changes: 2 additions & 0 deletions docs/discover.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ include::discover/document-data.asciidoc[]
include::discover/context.asciidoc[]

include::discover/viewing-field-stats.asciidoc[]

include::discover/selected-fields.asciidoc[]
4 changes: 3 additions & 1 deletion docs/discover/document-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,14 @@ field data.
To add a field column from the Fields list, hover over the field and click its
*add* button.

image::images/discover/add-field-from-sidebar.png["Add Field From Sidebar",align="center"]

To add a field column from a document's field data, expand the document
and click the field's
image:images/add-column-button.png[Add Column] *Toggle column in table* button.

Added field columns replace the `_source` column in the Documents table. The added
fields are also added to the *Selected Fields* list.
fields are also added to the <<selected-fields, *Selected Fields*>> list.

To rearrange the field columns, hover over the header of the column you want to move
and click the *Move left* or *Move right* button.
Expand Down
38 changes: 38 additions & 0 deletions docs/discover/selected-fields.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[[selected-fields]]
== Selected Fields

Selected Fields are displayed on the **Selected Field** list at the top left of the Discover page.

image::images/discover/selected-fields.png["Selected Fields", align="center"]

Click on a field to see the field's <<viewing-field-stats, stats>>.

To remove a field, hover over or click on the field and click its image:images/discover/remove-button.png[Remove Field button] button.

image::images/discover/remove-field.png["Remove Selected Field", align="center"]

Once you have selected at least one field, you can then select the image:images/discover/generate-dashboard-button.png[Generate Dashboard button] button to begin autogenerating a new <<dashboard, Dashboard>>.

If you have not selected any fields, you can allow {kibi-name} to select the fields it believes are the most relevant by clicking the image:images/discover/auto-select-button.png[Remove Field button] button.

Note: This button is only visible if there are no fields selected. If you have selected fields, the image:images/discover/generate-dashboard-button.png[Generate Dashboard button] button will be visible in its place.

=== Autoselect Fields

{kibi-name} begins testing the fields with each field being analyzed for relevance against
a number of heuristics, for example, whether all values are unique - which indicates a potential ID field and unlikely to be relevant for visualizations.

image::images/discover/auto-select-test-modal.png["Auto Select Report", align="center"]

Once all the fields have been analyzed, a test report is displayed.

image::images/discover/auto-select-report.png["Auto Select Report", align="center"]

This report shows all the fields in the Discover data, which fields are selected as most relevant, the field type,
the visualization selected for that type, the relevancy score and any notes on why the field was or wasn't selected as a relevant field.

You can add and remove fields you would like selected using the checkboxes on the left.

Once you are ready, hit the image:images/discover/auto-select-test-modal-ok-button.png[Autoselect Test Modal OK Button] button to select the fields.

Once the fields have populated the **Selected Fields** list, you are ready to <<autogenerate-dashboard, image:images/discover/generate-dashboard-button.png[Generate Dashboard button]>>.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/add-field-from-sidebar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/auto-select-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/auto-select-report.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/auto-select-test-modal.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/remove-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/remove-field.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discover/selected-fields.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7b958e9

Please sign in to comment.