diff --git a/docs/dashboard.asciidoc b/docs/dashboard.asciidoc index 7dc723582..448c6b692 100644 --- a/docs/dashboard.asciidoc +++ b/docs/dashboard.asciidoc @@ -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 diff --git a/docs/dashboard/auto-generate.asciidoc b/docs/dashboard/auto-generate.asciidoc new file mode 100644 index 000000000..70ec207ed --- /dev/null +++ b/docs/dashboard/auto-generate.asciidoc @@ -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 <> 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. \ No newline at end of file diff --git a/docs/discover.asciidoc b/docs/discover.asciidoc index 0072b442c..fb6fef88d 100644 --- a/docs/discover.asciidoc +++ b/docs/discover.asciidoc @@ -23,3 +23,5 @@ include::discover/document-data.asciidoc[] include::discover/context.asciidoc[] include::discover/viewing-field-stats.asciidoc[] + +include::discover/selected-fields.asciidoc[] diff --git a/docs/discover/document-data.asciidoc b/docs/discover/document-data.asciidoc index 7e429f5c7..d2f1d6777 100644 --- a/docs/discover/document-data.asciidoc +++ b/docs/discover/document-data.asciidoc @@ -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 <> 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. diff --git a/docs/discover/selected-fields.asciidoc b/docs/discover/selected-fields.asciidoc new file mode 100644 index 000000000..1dc3e8819 --- /dev/null +++ b/docs/discover/selected-fields.asciidoc @@ -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 <>. + +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 <>. + +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 <>. \ No newline at end of file diff --git a/docs/images/dashboard/auto-generate/create-panel.png b/docs/images/dashboard/auto-generate/create-panel.png new file mode 100644 index 000000000..a548e6d5e Binary files /dev/null and b/docs/images/dashboard/auto-generate/create-panel.png differ diff --git a/docs/images/dashboard/auto-generate/generate-vis-report-panel.png b/docs/images/dashboard/auto-generate/generate-vis-report-panel.png new file mode 100644 index 000000000..e8426f505 Binary files /dev/null and b/docs/images/dashboard/auto-generate/generate-vis-report-panel.png differ diff --git a/docs/images/dashboard/auto-generate/new-auto-gen-dashboard.png b/docs/images/dashboard/auto-generate/new-auto-gen-dashboard.png new file mode 100644 index 000000000..1e5db6722 Binary files /dev/null and b/docs/images/dashboard/auto-generate/new-auto-gen-dashboard.png differ diff --git a/docs/images/discover/add-field-from-sidebar.png b/docs/images/discover/add-field-from-sidebar.png new file mode 100644 index 000000000..0d9f720e0 Binary files /dev/null and b/docs/images/discover/add-field-from-sidebar.png differ diff --git a/docs/images/discover/auto-select-button.png b/docs/images/discover/auto-select-button.png new file mode 100644 index 000000000..3629adda6 Binary files /dev/null and b/docs/images/discover/auto-select-button.png differ diff --git a/docs/images/discover/auto-select-report.png b/docs/images/discover/auto-select-report.png new file mode 100644 index 000000000..ce00c302d Binary files /dev/null and b/docs/images/discover/auto-select-report.png differ diff --git a/docs/images/discover/auto-select-test-modal-ok-button.png b/docs/images/discover/auto-select-test-modal-ok-button.png new file mode 100644 index 000000000..e07b4f90e Binary files /dev/null and b/docs/images/discover/auto-select-test-modal-ok-button.png differ diff --git a/docs/images/discover/auto-select-test-modal.png b/docs/images/discover/auto-select-test-modal.png new file mode 100644 index 000000000..0597bbd4e Binary files /dev/null and b/docs/images/discover/auto-select-test-modal.png differ diff --git a/docs/images/discover/generate-dashboard-button.png b/docs/images/discover/generate-dashboard-button.png new file mode 100644 index 000000000..ff1d57d6d Binary files /dev/null and b/docs/images/discover/generate-dashboard-button.png differ diff --git a/docs/images/discover/remove-button.png b/docs/images/discover/remove-button.png new file mode 100644 index 000000000..97e412612 Binary files /dev/null and b/docs/images/discover/remove-button.png differ diff --git a/docs/images/discover/remove-field.png b/docs/images/discover/remove-field.png new file mode 100644 index 000000000..54a170847 Binary files /dev/null and b/docs/images/discover/remove-field.png differ diff --git a/docs/images/discover/selected-fields.png b/docs/images/discover/selected-fields.png new file mode 100644 index 000000000..c399baa14 Binary files /dev/null and b/docs/images/discover/selected-fields.png differ