Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[maps] Top hits per entity--change to title to use recent, minor edits #89254

Merged
merged 5 commits into from
Feb 4, 2021
Merged

[maps] Top hits per entity--change to title to use recent, minor edits #89254

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0dfaa2d
[maps] Top hits per entity--change to title to use recent, minor edits
kmartastic Jan 27, 2021
9329844
Merge branch 'master' of github.com:elastic/kibana into TopHitsPerEntity
kmartastic Jan 27, 2021
020981d
Updated TopHitsPerEntity title and description to use the term relevant
kmartastic Jan 28, 2021
d71648e
updating top hits per entity topic to new title
kmartastic Jan 29, 2021
ec7fa21
Merge branch 'master' into TopHitsPerEntity
kibanamachine Feb 4, 2021
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
4 changes: 2 additions & 2 deletions docs/maps/maps-aggregations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ To enable a blended layer that dynamically shows clusters or documents:

[role="xpack"]
[[maps-top-hits-aggregation]]
=== Top hits per entity
=== Display the most relevant documents per entity

You can display the most relevant documents per entity, for example, the most recent GPS tracks per flight.
Use *Top hits per entity* to display the most relevant documents per entity, for example, the most recent GPS tracks per flight route.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now title is repeat of this sentence. Is that a problem?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think @gchaps?

I don't think it's a problem, but it's obviously not normal practice.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does feel a little awkward to have"per entity" appear three times before the second sentence. What about removing that sentence and going with this:

Elasticsearch groups your data using a terms aggregation, and then accumulates the most relevant documents based on sort order for each entry using a top hits metric aggregation.

To view the top hits per entity:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't loss the example, "for example, the most recent GPS tracks per flight route." needs to be maintained

Copy link
Contributor

@gchaps gchaps Jan 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elasticsearch groups your data using a terms aggregation, and then accumulates the most relevant documents based on sort order for each entry using a top hits metric aggregation. This enables you to view metrics such as the most recent GPS tracks per flight route.

To view the top hits per entity:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't use the word "metric" because its not an aggregation. Unlike an aggregation, top hits is actually showing documents, just a very small number of documents per entity, where entity is an airplane or truck.

Copy link
Contributor

@gchaps gchaps Jan 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metrics > top hits?

If that doesn't work, let's go with the original text.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the text is fine because Tops hits per entity is a UI command.

Use Top hits per entity to display the most relevant documents per entity, for example, the most recent GPS tracks per flight route.

To get this data, {es} first groups your data using a {ref}/search-aggregations-bucket-terms-aggregation.html[terms aggregation],
then accumulates the most relevant documents based on sort order for each entry using a {ref}/search-aggregations-metrics-top-hits-aggregation.html[top hits metric aggregation].

Expand Down