Skip to content

Commit

Permalink
[serverless] Updates Data Quality Dashboard UI (#5718)
Browse files Browse the repository at this point in the history
* First draft

* Update docs/serverless/dashboards/data-quality-dash.mdx

Co-authored-by: Karen Grigoryan <[email protected]>

* Update docs/serverless/dashboards/data-quality-dash.mdx

Co-authored-by: Karen Grigoryan <[email protected]>

* Update docs/serverless/dashboards/data-quality-dash.mdx

Co-authored-by: Karen Grigoryan <[email protected]>

* Update docs/serverless/dashboards/data-quality-dash.mdx

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Karen Grigoryan <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
  • Loading branch information
3 people authored Sep 3, 2024
1 parent b8ba187 commit 98b7474
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/serverless/dashboards/data-quality-dash.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ When you open the dashboard, data does not appear until you select indices to ch
To customize which indices are checked when you click **Check all**, [change the current data view](((security-guide))/data-views-in-sec.html).
</DocCallOut>

* **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 index** button under **Actions**. Checking a single index is faster than checking all indices.

## Visualize checked indices
The treemap that appears at the top of the dashboard shows the relative document count of your indices. The color of each index's node refers to its status:
Expand All @@ -53,12 +53,11 @@ The treemap that appears at the top of the dashboard shows the relative document
Click a node in the treemap to expand the corresponding index.

## 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.
After an index is checked, `Pass` or `Fail` appears in its **Result** column. `Fail` indicates mapping problems in an index. To view index check details, including which fields weren't successfully mapped, click the **View check details** button under **Actions**.

![An expanded index with some failed results in the Data Quality dashboard](../images/data-quality-dash/-dashboards-data-qual-dash-detail.png)


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.

<DocCallOut title="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 [Field data types](((ref))/mapping-types.html).
Expand All @@ -76,8 +75,8 @@ You can share data quality results to help track your team's remediation efforts

**Export results for one index**:

1. Expand an index that has at least one incompatible field by clicking the arrow to the left of its **Result**.
1. From the **Summary** or **Incompatible fields** tabs, select **Add to new case** to open a new <DocLink slug="/serverless/security/cases-overview">case</DocLink>, or click **Copy to clipboard** to copy a Markdown report to your clipboard.
1. View details for a checked index that has at least one incompatible field by clicking the **View check details** button under **Actions**.
1. From the **Incompatible fields** tab, select **Add to new case** to open a new <DocLink slug="/serverless/security/cases-overview">case</DocLink>, or click **Copy to clipboard** to copy a Markdown report to your clipboard.

<DocCallOut title="Note">
For more information about how to fix mapping problems, refer to [Mapping](((ref))/mapping.html).
Expand Down
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.

0 comments on commit 98b7474

Please sign in to comment.