-
Notifications
You must be signed in to change notification settings - Fork 508
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.
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
Add clarification about OpenSearch ingest pipelines compared to Data … #6786
Conversation
…Prepper Signed-off-by: Melissa Vagi <[email protected]>
@dlvenable @gaobinlong Thank you for providing context about ingest pipelines and Data Prepper. Please review this PR at your availability. I'll be out of office Mar 26-April 2, so please reach out to @hdhalter if this PR needs changes or reviews before I return. Thank you, Melissa |
Thanks, Melissa! I will update the label to 'tech review' for sign off by @dlvenable and @gaobinlong. |
Tagging @Naarcha-AWS for doc review. |
…Prepper Signed-off-by: Melissa Vagi <[email protected]>
Hi @Naarcha-AWS @dlvenable Please review this PR as soon as your schedule permits. Thank you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding this clarity @vagimeli !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!
_data-prepper/index.md
Outdated
|
||
Data Prepper lets users build custom pipelines to improve the operational view of applications. Two common uses for Data Prepper are trace and log analytics. [Trace analytics]({{site.url}}{{site.baseurl}}/observability-plugin/trace/index/) can help you visualize the flow of events and identify performance problems, and [log analytics]({{site.url}}{{site.baseurl}}/observability-plugin/log-analytics/) can improve searching, analyzing and provide insights into your application. | ||
With Data Prepper you can build custom pipelines to improve the operational view of applications. Two common uses for Data Prepper are trace analytics and log analytics. [Trace analytics]({{site.url}}{{site.baseurl}}/observability-plugin/trace/index/) can help you visualize events flow and identify performance problems. [Log analytics]({{site.url}}{{site.baseurl}}/observability-plugin/log-analytics/) can help improve searching, analyzing and give you deeper insights into your application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The last sentence needs some clarification. Improve search and analytics what or how?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this read better? Log analytics equips you with tools to enhance your search capabilities, conduct comprehensive analysis, and gain insights into your applications' performance and behavior.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect!
_ingest-pipelines/index.md
Outdated
|
||
OpenSearch ingest pipelines perform actions on indexes and are preferred for use cases involving pre-processing simple datasets, [machine learning processors]({{site.url}}{{site.baseurl}}/ingest-pipelines/processors/sparse-encoding/), and [vector embedding processors]({{site.url}}{{site.baseurl}}/ingest-pipelines/processors/text-image-embedding/). OpenSearch ingest pipelines are recommended for simple data pre-processing and small datasets. | ||
|
||
Data Prepper is the preferred data ingestion tool for OpenSearch. Data Prepper is recommended for any data processing that it supports and for use cases involving the transferring and fetching of large datasets and complex data pre-processing. Refer to the [Data Prepper]({{site.url}}{{site.baseurl}}/data-prepper/) documentation to learn more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First sentence: This reads as though a noun should follow "data processing". Data processing what that it supports?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a better rewrite? Data Prepper is recommended for any data processing tasks it supports, particularly when dealing with large datasets and complex data pre-processing requirements. It streamlines the process of transferring and fetching large datasets, while providing robust capabilities for intricate data preparation and transformation operations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that works, but no comma in the second sentence 😄
_ingest-pipelines/index.md
Outdated
|
||
Data Prepper is the preferred data ingestion tool for OpenSearch. Data Prepper is recommended for any data processing that it supports and for use cases involving the transferring and fetching of large datasets and complex data pre-processing. Refer to the [Data Prepper]({{site.url}}{{site.baseurl}}/data-prepper/) documentation to learn more information. | ||
|
||
OpenSearch ingest pipelines can only be managed using [ingest API operations]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the link, should "Ingest" be capitalized (is it the name of the API)?
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
#6786) * Add clarification about OpenSearch ingest pipelines compared to Data Prepper --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit fd8bd45) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
…Prepper
Description
Clarifies preferred data ingestion tools for OpenSearch
Issues Resolved
Closes parts of #6429
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.