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

Jump to bottom

[DOC] Add fail processor documentation #5980

Merged

vagimeli merged 19 commits into main from fail-processor

May 22, 2024

Collaborator

vagimeli commented Dec 22, 2023

Description

Closes the content gap

Issues Resolved

Checklist

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.


          Add fail processor documentation

a9b3a7c

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

vagimeli added Needs SME Content gap labels

vagimeli self-assigned this

vagimeli requested review from hdhalter, kolchfa-aws, Naarcha-AWS, AMoo-Miki and natebower as code owners

December 22, 2023 19:02

Collaborator Author

vagimeli commented Dec 22, 2023

@hdhalter We need a dev to take the first pass at drafting this content. I can support them in refining the content and getting it through the documentation process. The ingest processor template is provided with this PR, so it should help the dev get started. Thanks!

vagimeli mentioned this pull request

[META DOC] Ingest Processors Content Gaps #4647

Closed

45 tasks

Collaborator Author

vagimeli commented Jan 31, 2024 •

edited

Loading

@gaobinlong Would you have availability to help close the content gap on this PR? We don't have a set deadline, so at your availability is okay. The same process you've followed for the copy processor can be followed here. Thank you.

Contributor

gaobinlong commented Feb 1, 2024

@gaobinlong Would you have availability to help close the content gap on this PR? We don't have a set deadline, so at your availability is okay. The same process you've followed for the copy processor can be followed here. Thank you.

OK, glad to do that, I'll open a PR for this issue.

Collaborator Author

vagimeli commented Feb 6, 2024

@gaobinlong Would you have availability to help close the content gap on this PR? We don't have a set deadline, so at your availability is okay. The same process you've followed for the copy processor can be followed here. Thank you.

OK, glad to do that, I'll open a PR for this issue.

Thanks @gaobinlong. Please tag me in the PR when it's ready for doc review.


          Merge branch 'main' into fail-processor

aa14064

vagimeli requested a review from dlvenable as a code owner

February 6, 2024 21:22


          Merge branch 'main' into fail-processor

3def449

vagimeli marked this pull request as draft

February 15, 2024 21:20


          Merge branch 'main' into fail-processor

48d01e8

vagimeli marked this pull request as ready for review

February 26, 2024 22:12

vagimeli requested a review from stephen-crawford as a code owner

February 26, 2024 22:12

Collaborator Author

vagimeli commented Feb 26, 2024

@gaobinlong This template for the fail ingest processor is ready for you to add code examples at your availability. Thank you, Melissa


          Update fail.md

50825ba

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

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

vagimeli commented

View reviewed changes

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

Collaborator Author

vagimeli commented Apr 11, 2024

@gaobinlong Will you review this PR for technical accuracy? I added examples and new content. Thank you!

gaobinlong reviewed

View reviewed changes

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved


          Address tech review feedback and add SME's code examples

5aac822

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

vagimeli requested a review from epugh as a code owner

April 16, 2024 21:48

Collaborator Author

vagimeli commented Apr 16, 2024

@gaobinlong Thank you for your review and the code examples. I made your changes. Once. you approve, I'll send for editorial review and then merge the PR.


          Merge branch 'main' into fail-processor

6d034e5

gaobinlong approved these changes

View reviewed changes

Contributor

gaobinlong left a comment

Overall looks good to me, some minor changes need to be done.

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

vagimeli added 3 - Tech review and removed Needs SME labels

vagimeli added 2 commits

May 13, 2024 09:41


          Merge branch 'main' into fail-processor

4b3ca83


          Address tech review comments

385d587

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

Naarcha-AWS approved these changes

View reviewed changes

Collaborator

Naarcha-AWS left a comment

A few suggestions, otherwise LGTM.

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

vagimeli and others added 2 commits

May 22, 2024 09:45


          Update _ingest-pipelines/processors/fail.md

cd636ae

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>


          Update _ingest-pipelines/processors/fail.md

6736e66

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli commented

View reviewed changes

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Show resolved Hide resolved

vagimeli added 3 commits

May 22, 2024 09:47


          Update _ingest-pipelines/processors/fail.md

f581ea2

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


          Merge branch 'main' into fail-processor

9b7119c


          Merge branch 'main' into fail-processor

6cbc5bf

vagimeli added backport 2.14 5 - Editorial review and removed 3 - Tech review labels

natebower reviewed

View reviewed changes

Collaborator

natebower left a comment

@vagimeli Just a few comments/changes. Thanks!

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated Show resolved Hide resolved

_ingest-pipelines/processors/fail.md Outdated


		### Step 4 (Optional): Retrieve the document

		Since the log event was not indexed due to the pipeline failure, attempting to retrieve it will result in a document not found error.

Collaborator

natebower May 22, 2024

Should "document not found" be specially formatted as the name of the error?

vagimeli and others added 5 commits

May 22, 2024 10:03


          Update _ingest-pipelines/processors/fail.md

3ea73b5

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


          Update _ingest-pipelines/processors/fail.md

95ecf12

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


          Update _ingest-pipelines/processors/fail.md

27aef26

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


          Update fail.md

ec15cfb

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

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


          Merge branch 'main' into fail-processor

999551e

vagimeli removed the 5 - Editorial review label

vagimeli merged commit 05710d0 into main

6 checks passed

vagimeli deleted the fail-processor branch

May 22, 2024 18:20

opensearch-trigger-bot bot pushed a commit that referenced this pull request


          [DOC] Add fail processor documentation (#5980)

3efb7af

* Add fail processor documentation

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

* Update fail.md

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

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

* Address tech review feedback and add SME's code examples

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

* Address tech review comments

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

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/fail.md

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

* Update _ingest-pipelines/processors/fail.md

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

* Update _ingest-pipelines/processors/fail.md

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

* Update _ingest-pipelines/processors/fail.md

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

* Update fail.md

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

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

---------

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit 05710d0)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

opensearch-trigger-bot bot mentioned this pull request

[Backport 2.14] [DOC] Add fail processor documentation #7233

Merged

github-actions bot pushed a commit that referenced this pull request


          [DOC] Add fail processor documentation (#5980) (#7233)

48cf315

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

natebower natebower left review comments

gaobinlong gaobinlong approved these changes

Naarcha-AWS Naarcha-AWS approved these changes

hdhalter Awaiting requested review from hdhalter

kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

stephen-crawford Awaiting requested review from stephen-crawford

epugh Awaiting requested review from epugh epugh is a code owner

Labels

backport 2.14 Content gap