Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions docs/dashboards/data-quality-dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -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 <<cases-overview,case>>.
. 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 <<cases-overview,case>>.

NOTE: For more information about how to fix mapping problems, refer to {ref}/mapping.html[Mapping].
Binary file modified docs/dashboards/images/data-qual-dash-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dashboards/images/data-qual-dash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.