diff --git a/docs/dashboards/data-quality-dashboard.asciidoc b/docs/dashboards/data-quality-dashboard.asciidoc index abf9edb674..1dd347afc6 100644 --- a/docs/dashboards/data-quality-dashboard.asciidoc +++ b/docs/dashboards/data-quality-dashboard.asciidoc @@ -35,7 +35,7 @@ Data does not appear in the dashboard until a user selects indices to check. IMPORTANT: To customize which indices are checked when you click *Check all*, {security-guide}/data-views-in-sec.html[change the current data view]. -* *Check a single index*: To check a single index, expand it using the arrow on the left. Checking a single index is faster than checking all indices. +* *Check a single index*: To check a single index, click the **Check now** button under **Actions**. Checking a single index is faster than checking all indices. Once checked, an index's data quality results persist indefinitely. You can see when the index was last checked, and generate updated results at any time. @@ -53,15 +53,24 @@ Click a node in the treemap to expand the corresponding index. [discrete] == Learn more about checked index fields -After an index is checked, an X (❌) or a checkmark (✅) appears in its *Result* column. The X (❌) indicates mapping problems in an index. To view index details, including which fields weren't successfully mapped, click the arrow next to the result to expand it. +After an index is checked, a **Pass** or **Fail** status appears. **Fail** indicates mapping problems in an index. To view index check details, including which fields weren't successfully mapped, click the **Check now** button under **Actions**. [role="screenshot"] image::images/data-qual-dash-detail.png[An expanded index with some failed results in the Data Quality dashboard] -When you expand a result, the *Summary* tab immediately helps you visualize the status of fields in that index. The other tabs display more details about particular fields, grouped by their mapping status. +The index check flyout provides more information about the status of fields in that index. Each of its tabs describe fields grouped by mapping status. NOTE: Fields in the *Same family* category have the correct search behavior, but might have different storage or performance characteristics (for example, you can index strings to both `text` and `keyword` fields). To learn more, refer to {ref}/mapping-types.html[Field data types]. +[discrete] +== View historical data quality results + +You can review an index's data quality history by clicking **View history** under **Actions**, or by clicking the **History** tab in the details flyout. You can filter the results by time and **Pass** / **Fail** status. Click a historical check to expand it and view more details. + +image::images/data-qual-dash-history.png[The Data Quality dashboard] + +NOTE: Recent historical data includes the **Incompatible fields** and **Same family** views. Legacy historical data only includes the **Incompatible fields** view. + [discrete] == Export data quality results @@ -73,8 +82,7 @@ You can share data quality results to help track your team's remediation efforts . Click *Copy to clipboard* to copy a Markdown report to your clipboard. * Export results for one index: -. Expand an index that has at least one incompatible field by clicking the arrow to the left of its *Result*. -. From the *Summary* or *Incompatible fields* tab, select *Add to new case* to open a new <>. -. From the *Summary*, *Incompatible fields*, or *Same family* tab, click *Copy to clipboard* to copy a Markdown report to your clipboard. +. View details for a checked index by clicking the **Check now** button under **Actions**. +. From the **Incompatible fields** tab, select **Add to new case** to open a new <>. NOTE: For more information about how to fix mapping problems, refer to {ref}/mapping.html[Mapping]. diff --git a/docs/dashboards/images/data-qual-dash-detail.png b/docs/dashboards/images/data-qual-dash-detail.png index a94bf5acaa..7e397586be 100644 Binary files a/docs/dashboards/images/data-qual-dash-detail.png and b/docs/dashboards/images/data-qual-dash-detail.png differ diff --git a/docs/dashboards/images/data-qual-dash-history.png b/docs/dashboards/images/data-qual-dash-history.png new file mode 100644 index 0000000000..58e634e09a Binary files /dev/null and b/docs/dashboards/images/data-qual-dash-history.png differ diff --git a/docs/dashboards/images/data-qual-dash.png b/docs/dashboards/images/data-qual-dash.png index 08c82a7b0e..9310d84cf2 100644 Binary files a/docs/dashboards/images/data-qual-dash.png and b/docs/dashboards/images/data-qual-dash.png differ