[Lens] Document the "Other" entry in data summaries in Kibana guide #85575

dej611 · 2020-12-10T14:36:23Z

Summary

Since the issue has been created the Lens UI changed introducing the Other entry to fill the gap until 100% of the value. The missing bit was some documentation to cover the meaning of this special entry, provided by this PR.

Checklist

Documentation was added for features that require explanation or tutorials

elasticmachine · 2020-12-10T14:36:25Z

Pinging @elastic/kibana-app (Team:KibanaApp)

KOTungseth

I left a minor suggestion around punctuation and using active voice, but otherwise, LGTM!

Also, can you add a screenshot that shows this?

KOTungseth · 2020-12-10T15:47:39Z

docs/user/dashboard/dashboard.asciidoc

@@ -228,6 +228,8 @@ To view the data field summary information, navigate to the field, then click *i
 [role="screenshot"]
 image::images/lens_data_info.png[Data summary window]

+Sometimes documents have no data for the field inspected: *Lens* will show a "Other" entry to represent these documents in the distribution chart.


Suggested change

Sometimes documents have no data for the field inspected: *Lens* will show a "Other" entry to represent these documents in the distribution chart.

Sometimes documents have no data for the field inspected:. *Lens* shows an *Other* entry to represent these documents in the distribution chart.

Can you add a screenshot that shows this?

I made the screenshot for it, but then dropped as I thought it was too much. Will add it back! 📸

flash1293

@wylieconlon knows better, but I don't think "Sometimes documents have no data for the field inspected: Lens shows an "Other" entry to represent these documents in the distribution chart." is 100% (pun intended) true - the field summary will only give you 10 entries at max, grouping everything else into "Other":

dej611 · 2020-12-14T14:12:50Z

Ok, found out the 10 value in the server code. Will update on that side as well.

flash1293 · 2020-12-14T14:28:53Z

docs/user/dashboard/dashboard.asciidoc

+[role="screenshot"]
+image::images/lens_data_info_other.png[Data summary window with Other]
+
+NOTE: because the distribution is based on single values, the sum of all the entries and "Other" may be above 100%, because entries in array values are counted as distinct values.


I did a quick test and while Tim raises a good point in the issue you opened, this is not the case right now:

For this data:

POST testindex/_doc { "val": ["A", "B", "C"] } POST testindex/_doc { "val": ["D", "E", "F"] } POST testindex/_doc { "val": ["G", "H", "I"] }

Right now it seems like this only caused by rounding

Catching up on this discussion: @flash1293 is right that it's only a rounding issue, not an issue with the underlying calculation. The size of "other" is based on the value_count of the field minus the sum of all terms we get back, which is correct for array fields and regular fields.

wylieconlon

I'm glad we're updating this part of the docs, but I think it needs another round of updates for accuracy!

wylieconlon · 2020-12-14T19:34:28Z

docs/user/dashboard/dashboard.asciidoc

+[role="screenshot"]
+image::images/lens_data_info_other.png[Data summary window with Other]
+
+NOTE: because the distribution is based on single values, the sum of all the entries and "Other" may be above 100%, because entries in array values are counted as distinct values.


Catching up on this discussion: @flash1293 is right that it's only a rounding issue, not an issue with the underlying calculation. The size of "other" is based on the value_count of the field minus the sum of all terms we get back, which is correct for array fields and regular fields.

wylieconlon · 2020-12-14T19:35:39Z

docs/user/dashboard/dashboard.asciidoc

@@ -228,6 +228,13 @@ To view the data field summary information, navigate to the field, then click *i
 [role="screenshot"]
 image::images/lens_data_info.png[Data summary window]

+*Lens* inspects the top 10 values to build the value distribution: every other value, together with documents with no data for the inspected field, are shown with the "Other" entry in the distribution chart.


This sentence is missing information about what happens for number/date fields: in both cases we do something more than just top 10. For numbers we show both top 10 and histogram. We show the histogram when the top 10 values are less than 10% of all the values.

…s by type and hardcoded stat values

dej611 · 2020-12-15T10:55:40Z

I've revisited completely the data summary section to cover all the raised questions and feedback.

wylieconlon

This looks good! Left a couple of tweaks that you can optionally take

docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <[email protected]>

kibanamachine · 2020-12-17T17:54:40Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 85575 or prevent reminders by adding the backport:skip label.

…lastic#85575) * 📝 Address Other entry in data summaries * 👌 Integrated feedback from review * 📝 Add not about going beyong 100% with array values * 👌 Improved documentation for summaries * 👌 Improved documentation for data summaries covering discussed aspects by type and hardcoded stat values * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> Co-authored-by: Wylie Conlon <[email protected]>

kibanamachine · 2020-12-18T18:04:39Z

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

…guide (#85575) (#86344) * 📝 Address Other entry in data summaries * 👌 Integrated feedback from review * 📝 Add not about going beyong 100% with array values * 👌 Improved documentation for summaries * 👌 Improved documentation for data summaries covering discussed aspects by type and hardcoded stat values * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> Co-authored-by: Wylie Conlon <[email protected]> Co-authored-by: Wylie Conlon <[email protected]>

…uide (#85575) (#86345) * 📝 Address Other entry in data summaries * 👌 Integrated feedback from review * 📝 Add not about going beyong 100% with array values * 👌 Improved documentation for summaries * 👌 Improved documentation for data summaries covering discussed aspects by type and hardcoded stat values * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <[email protected]> Co-authored-by: Wylie Conlon <[email protected]> Co-authored-by: Wylie Conlon <[email protected]>

📝 Address Other entry in data summaries

f9be6f8

dej611 added Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.0.0 Feature:Lens docs v7.11.0 labels Dec 10, 2020

dej611 requested review from wylieconlon and KOTungseth December 10, 2020 14:36

dej611 added the release_note:skip Skip the PR/issue when compiling release notes label Dec 10, 2020

KOTungseth approved these changes Dec 10, 2020

View reviewed changes

👌 Integrated feedback from review

dc32b05

dej611 mentioned this pull request Dec 14, 2020

[Lens] Data summaries percentage can go beyond 100% #85572

Closed

dej611 added 2 commits December 14, 2020 12:57

Merge remote-tracking branch 'upstream/master' into doc/lens/summaries

c0c9d8c

📝 Add not about going beyong 100% with array values

4e9a368

flash1293 reviewed Dec 14, 2020

View reviewed changes

👌 Improved documentation for summaries

38d378b

flash1293 reviewed Dec 14, 2020

View reviewed changes

wylieconlon suggested changes Dec 14, 2020

View reviewed changes

👌 Improved documentation for data summaries covering discussed aspect…

2ee1cce

…s by type and hardcoded stat values

wylieconlon approved these changes Dec 15, 2020

View reviewed changes

docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved

docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved

docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved

dej611 and others added 3 commits December 15, 2020 18:03

Update docs/user/dashboard/dashboard.asciidoc

6c65d45

Co-authored-by: Wylie Conlon <[email protected]>

Update docs/user/dashboard/dashboard.asciidoc

136c7fc

Co-authored-by: Wylie Conlon <[email protected]>

Update docs/user/dashboard/dashboard.asciidoc

19ec460

Co-authored-by: Wylie Conlon <[email protected]>

dej611 merged commit 56ad415 into elastic:master Dec 15, 2020

dej611 deleted the doc/lens/summaries branch December 15, 2020 17:50

dej611 mentioned this pull request Dec 15, 2020

Advanced Lens documentation #81780

Open

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Dec 17, 2020

This was referenced Dec 17, 2020

[7.11] [Lens] Document the "Other" entry in data summaries in Kibana guide (#85575) #86344

Merged

[7.x] [Lens] Document the "Other" entry in data summaries in Kibana guide (#85575) #86345

Merged

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Dec 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Lens] Document the "Other" entry in data summaries in Kibana guide #85575

[Lens] Document the "Other" entry in data summaries in Kibana guide #85575

dej611 commented Dec 10, 2020

elasticmachine commented Dec 10, 2020

KOTungseth left a comment

KOTungseth Dec 10, 2020

KOTungseth Dec 10, 2020

dej611 Dec 10, 2020

flash1293 left a comment •

edited

Loading

dej611 commented Dec 14, 2020

flash1293 Dec 14, 2020

wylieconlon Dec 14, 2020

wylieconlon left a comment

wylieconlon Dec 14, 2020

wylieconlon Dec 14, 2020

dej611 commented Dec 15, 2020

wylieconlon left a comment

kibanamachine commented Dec 17, 2020

kibanamachine commented Dec 18, 2020

	Sometimes documents have no data for the field inspected: Lens will show a "Other" entry to represent these documents in the distribution chart.
	Sometimes documents have no data for the field inspected:. Lens shows an Other entry to represent these documents in the distribution chart.

[Lens] Document the "Other" entry in data summaries in Kibana guide #85575

[Lens] Document the "Other" entry in data summaries in Kibana guide #85575

Conversation

dej611 commented Dec 10, 2020

Summary

Checklist

elasticmachine commented Dec 10, 2020

KOTungseth left a comment

Choose a reason for hiding this comment

KOTungseth Dec 10, 2020

Choose a reason for hiding this comment

KOTungseth Dec 10, 2020

Choose a reason for hiding this comment

dej611 Dec 10, 2020

Choose a reason for hiding this comment

flash1293 left a comment • edited Loading

Choose a reason for hiding this comment

dej611 commented Dec 14, 2020

flash1293 Dec 14, 2020

Choose a reason for hiding this comment

wylieconlon Dec 14, 2020

Choose a reason for hiding this comment

wylieconlon left a comment

Choose a reason for hiding this comment

wylieconlon Dec 14, 2020

Choose a reason for hiding this comment

wylieconlon Dec 14, 2020

Choose a reason for hiding this comment

dej611 commented Dec 15, 2020

wylieconlon left a comment

Choose a reason for hiding this comment

kibanamachine commented Dec 17, 2020

kibanamachine commented Dec 18, 2020

flash1293 left a comment •

edited

Loading