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

Jump to bottom

[DOC] Add fail processor documentation #5980

Merged
merged 19 commits into from
May 22, 2024
Merged

[DOC] Add fail processor documentation #5980

merged 19 commits into from
May 22, 2024

Conversation

vagimeli
Copy link
Contributor

Description

Closes the content gap

Issues Resolved

##4647

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.

@vagimeli vagimeli added Needs SME Waiting on input from subject matter expert Content gap labels Dec 22, 2023
@vagimeli vagimeli self-assigned this Dec 22, 2023
@vagimeli
Copy link
Contributor Author

@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 vagimeli mentioned this pull request Dec 22, 2023
Closed
45 tasks
@vagimeli
Copy link
Contributor 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.

@gaobinlong
Copy link
Contributor

@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.

@vagimeli
Copy link
Contributor 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.

@vagimeli vagimeli requested a review from dlvenable as a code owner February 6, 2024 21:22
@vagimeli vagimeli marked this pull request as draft February 15, 2024 21:20
@vagimeli vagimeli marked this pull request as ready for review February 26, 2024 22:12
@vagimeli
Copy link
Contributor Author

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

@vagimeli
Update fail.md
50825ba 
Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli
Copy link
Contributor Author

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

gaobinlong
gaobinlong reviewed Apr 12, 2024
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
@vagimeli vagimeli requested a review from epugh as a code owner April 16, 2024 21:48
@vagimeli
Copy link
Contributor Author

@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.

gaobinlong
gaobinlong approved these changes Apr 17, 2024
View reviewed changes
Copy link
Contributor

@gaobinlong gaobinlong left a comment

Choose a reason for hiding this comment

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

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 vagimeli added 3 - Tech review PR: Tech review in progress and removed Needs SME Waiting on input from subject matter expert labels May 2, 2024
Naarcha-AWS
Naarcha-AWS approved these changes May 14, 2024
View reviewed changes
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

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
@vagimeli @Naarcha-AWS
Update _ingest-pipelines/processors/fail.md
cd636ae 
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli @Naarcha-AWS
Update _ingest-pipelines/processors/fail.md
6736e66 
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli vagimeli added backport 2.14 PR: Backport label for 2.14 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels May 22, 2024
natebower
natebower reviewed May 22, 2024
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

vagimeli and others added 5 commits May 22, 2024 10:03
@vagimeli @natebower
Update _ingest-pipelines/processors/fail.md
3ea73b5 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli @natebower
Update _ingest-pipelines/processors/fail.md
95ecf12 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli @natebower
Update _ingest-pipelines/processors/fail.md
27aef26 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli
Update fail.md
ec15cfb 
Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli
Merge branch 'main' into fail-processor
999551e
@vagimeli vagimeli removed the 5 - Editorial review PR: Editorial review in progress label May 22, 2024
@vagimeli vagimeli merged commit 05710d0 into main May 22, 2024
6 checks passed
@vagimeli vagimeli deleted the fail-processor branch May 22, 2024 18:20
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 22, 2024
@github-actions @Naarcha-AWS @natebower
[DOC] Add fail processor documentation (#5980)
3efb7af 
* Add fail processor documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Update fail.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

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

Signed-off-by: Melissa Vagi <[email protected]>

* Address tech review comments

Signed-off-by: Melissa Vagi <[email protected]>

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _ingest-pipelines/processors/fail.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _ingest-pipelines/processors/fail.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update fail.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 05710d0)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request May 22, 2024
Merged
github-actions bot pushed a commit that referenced this pull request May 22, 2024
@opensearch-trigger-bot
[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 natebower left review comments

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@gaobinlong gaobinlong gaobinlong approved these changes

@hdhalter hdhalter Awaiting requested review from hdhalter

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

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

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@vagimeli vagimeli

Labels
backport 2.14 PR: Backport label for 2.14 Content gap
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@vagimeli @gaobinlong @Naarcha-AWS @natebower