Add geo-centroid and weighted average aggregations documentation #7613

vagimeli · 2024-07-02T21:29:48Z

Description

Closes content gaps in #4293

Issues Resolved

Version

Backport to latest version

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

[ X] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli · 2024-07-03T19:18:56Z

_aggregations/metric/weighted-avg.md

+- `missing`: A value or weight to use if the field is missing
+
+
+## Using the aggregation


Technical reviewer: Please confirm this example is relevant to an OpenSearch user. I tested the example using Dev Tools. If another example is more appropriate, please replace the draft example with your example. Thank you.

vagimeli · 2024-07-03T19:19:29Z

_aggregations/metric/geocentroid.md

+
+The `geo_centroid` aggregation in OpenSearch is a powerful tool that allows you to calculate the weighted geographic center or focal point of a set of spatial data points. This metric aggregation operates on `geo_point` fields and returns the centroid location as a latitude-longitude pair.
+
+## Using the aggregation


Technical reviewer: Please confirm this example is relevant to an OpenSearch user. I tested the example using Dev Tools. If another example is more appropriate, please replace the draft example with your example. Thank you.

vagimeli · 2024-07-03T19:30:40Z

@msfroh @bowenlan-amzn @sandeshkr419 Would one of you be available to technical review this PR? The doc team is closing content gaps for aggregations and need a technical review before we can published the doc. Please note that I used Amazon Q to assist in code example generation and Dev Tools to test those examples. Thank you.

bowenlan-amzn · 2024-07-08T17:08:14Z

_aggregations/metric/geocentroid.md

+
+The `geo_centroid` aggregation in OpenSearch is a powerful tool that allows you to calculate the weighted geographic center or focal point of a set of spatial data points. This metric aggregation operates on `geo_point` fields and returns the centroid location as a latitude-longitude pair.
+
+## Using the aggregation


bowenlan-amzn · 2024-07-08T17:11:14Z

_aggregations/metric/weighted-avg.md

+- `missing`: A value or weight to use if the field is missing
+
+
+## Using the aggregation


natebower

@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

_aggregations/metric/geocentroid.md

_aggregations/metric/weighted-avg.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

_aggregations/metric/geocentroid.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

_aggregations/metric/geocentroid.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

…nsearch-project#7613) * Add geo-centroid and weighted avaerage aggregations documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add geocentroid content and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add weighted average content and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

…nsearch-project#7613) * Add geo-centroid and weighted avaerage aggregations documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add geocentroid content and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add weighted average content and examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/weighted-avg.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _aggregations/metric/geocentroid.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>

Add geo-centroid and weighted avaerage aggregations documentation

a033264

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli requested review from hdhalter, kolchfa-aws, Naarcha-AWS, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners July 2, 2024 21:29

vagimeli changed the title ~~Add geo-centroid and weighted avaerage aggregations documentation~~ Add geo-centroid and weighted average aggregations documentation Jul 2, 2024

vagimeli added 2 - In progress Issue/PR: The issue or PR is in progress. aggregations and analyzers Content gap labels Jul 2, 2024

vagimeli self-assigned this Jul 2, 2024

vagimeli added the Needs SME Waiting on input from subject matter expert label Jul 2, 2024

vagimeli added 2 commits July 3, 2024 10:58

Add geocentroid content and examples

61353ee

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Add weighted average content and examples

144092a

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Jul 3, 2024

Merge branch 'main' into metric-aggs-content-gap

a0eaf29

vagimeli commented Jul 3, 2024

View reviewed changes

vagimeli linked an issue Jul 3, 2024 that may be closed by this pull request

[DOC] Missing documentation on Aggregations #4293

Open

11 tasks

bowenlan-amzn approved these changes Jul 8, 2024

View reviewed changes

Merge branch 'main' into metric-aggs-content-gap

32ddef9

natebower approved these changes Jul 9, 2024

View reviewed changes

vagimeli and others added 3 commits July 9, 2024 09:08

Update _aggregations/metric/geocentroid.md

ff10997

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/geocentroid.md

0309c56

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/geocentroid.md

1c3e335

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli and others added 15 commits July 9, 2024 09:08

Update _aggregations/metric/geocentroid.md

ec76d2d

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/geocentroid.md

cb8efc0

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/geocentroid.md

e159226

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

28796e0

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/geocentroid.md

f5e19e3

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

fd99759

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

46b2c9b

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

4d91453

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

9e18581

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/geocentroid.md

d86f529

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

66d981c

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

d1ed725

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

7972376

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _aggregations/metric/weighted-avg.md

2efeb6d

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Merge branch 'main' into metric-aggs-content-gap

b5f46ad

vagimeli commented Jul 9, 2024

View reviewed changes

_aggregations/metric/geocentroid.md Outdated Show resolved Hide resolved

Update _aggregations/metric/geocentroid.md

037cedb

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli commented Jul 9, 2024

View reviewed changes

_aggregations/metric/geocentroid.md Outdated Show resolved Hide resolved

vagimeli added 2 commits July 9, 2024 09:13

Update _aggregations/metric/geocentroid.md

643b2aa

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Merge branch 'main' into metric-aggs-content-gap

1287811

vagimeli merged commit bdc4c8c into main Jul 9, 2024
6 checks passed

vagimeli deleted the metric-aggs-content-gap branch July 9, 2024 15:37

hdhalter mentioned this pull request Aug 5, 2024

[DOC] Missing documentation on Aggregations #4293

Open

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add geo-centroid and weighted average aggregations documentation #7613

Add geo-centroid and weighted average aggregations documentation #7613

vagimeli commented Jul 2, 2024

vagimeli Jul 3, 2024 •

edited

Loading

bowenlan-amzn Jul 8, 2024

vagimeli Jul 3, 2024 •

edited

Loading

bowenlan-amzn Jul 8, 2024

vagimeli commented Jul 3, 2024

bowenlan-amzn Jul 8, 2024

bowenlan-amzn Jul 8, 2024

natebower left a comment

		- `missing`: A value or weight to use if the field is missing


		## Using the aggregation


		The `geo_centroid` aggregation in OpenSearch is a powerful tool that allows you to calculate the weighted geographic center or focal point of a set of spatial data points. This metric aggregation operates on `geo_point` fields and returns the centroid location as a latitude-longitude pair.

		## Using the aggregation

Add geo-centroid and weighted average aggregations documentation #7613

Add geo-centroid and weighted average aggregations documentation #7613

Conversation

vagimeli commented Jul 2, 2024

Description

Issues Resolved

Version

Frontend features

Checklist

vagimeli Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

bowenlan-amzn Jul 8, 2024

Choose a reason for hiding this comment

vagimeli Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

bowenlan-amzn Jul 8, 2024

Choose a reason for hiding this comment

vagimeli commented Jul 3, 2024

bowenlan-amzn Jul 8, 2024

Choose a reason for hiding this comment

bowenlan-amzn Jul 8, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

vagimeli Jul 3, 2024 •

edited

Loading

vagimeli Jul 3, 2024 •

edited

Loading