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.

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

Update documentation of filestream input with the new improvements #25303

Merged
merged 11 commits into from
May 4, 2021

Conversation

kvch
Copy link
Contributor

@kvch kvch commented Apr 26, 2021

What does this PR do?

This PR adds more information about the filestream input to our documentation. It also adds details about the newly added features of the input.

See the docs preview: https://beats_25303.docs-preview.app.elstc.co/diff

Topics added & updated

  • How is it different from log input?
  • Add parsers option
  • Add include_files option
  • Add ignore_inactive option
  • Add resend_on_touch option

Why is it important?

In the last few weeks filestream has been improved immensely. The documentation has reflect the changes.

Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation
    - [ ] I have made corresponding change to the default configuration files
    - [ ] I have added tests that prove my fix is effective or that my feature works
    - [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

* How is it different from log input?
* Section about parsers
* Add `ignore_inactive` option
* Add `resend_on_touch` option
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 26, 2021
@kvch kvch requested a review from urso April 26, 2021 09:05
@kvch kvch added docs Team:Elastic-Agent Label for the Agent team labels Apr 26, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/agent (Team:Agent)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 26, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Apr 26, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: Pull request #25303 updated

  • Start Time: 2021-05-04T09:31:10.692+0000

  • Duration: 28 min 10 sec

  • Commit: 8684714

Trends 🧪

Image of Build Times

❕ Flaky test report

No test was executed to be analysed.

@urso urso requested a review from dedemorton April 26, 2021 12:03
@urso
Copy link

urso commented Apr 26, 2021

LGTM.

@dedemorton you want to review, or shall we progress with merging?

@kvch is this doc update for 7.13?

@kvch
Copy link
Contributor Author

kvch commented Apr 27, 2021

Yes, it is for 7.13.

@urso urso requested a review from a team April 27, 2021 17:34
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

I have a few grammar recommendations 📝

filebeat/docs/inputs/input-filestream.asciidoc Outdated Show resolved Hide resolved
filebeat/docs/inputs/input-filestream.asciidoc Outdated Show resolved Hide resolved
aggragate the contents into a multiline event.

4. Some position updates and metadata changes no longer depend on the publishing pipeline.
If a the pipeline is blocked some changes are still applied to the registry.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If a the pipeline is blocked some changes are still applied to the registry.
If a pipeline is blocked, some changes are still applied to the registry.

Copy link
Member

Choose a reason for hiding this comment

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

Not sure if a or the on this one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We have one pipeline per input, so I would say the.

Copy link
Member

Choose a reason for hiding this comment

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

Did you remove the a then? It looks like it still reads "If a the pipeline..."

Copy link
Member

@bmorelli25 bmorelli25 May 4, 2021

Choose a reason for hiding this comment

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

filebeat/docs/inputs/input-filestream.asciidoc Outdated Show resolved Hide resolved
filebeat/docs/inputs/input-filestream.asciidoc Outdated Show resolved Hide resolved
@dedemorton
Copy link
Contributor

Don't wait for me to review this. Brandon's comments are golden.

@kvch kvch merged commit d29e006 into elastic:master May 4, 2021
@kvch kvch added backport-v7.13.0 Automated backport with mergify backport-v7.14.0 Automated backport with mergify labels May 4, 2021
mergify bot pushed a commit that referenced this pull request May 4, 2021
mergify bot pushed a commit that referenced this pull request May 4, 2021
kvch added a commit that referenced this pull request May 4, 2021
kvch added a commit that referenced this pull request May 4, 2021
@bmorelli25
Copy link
Member

I think some of my review comments were skippable, but there are a few that weren't addressed that I think still need to be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v7.13.0 Automated backport with mergify backport-v7.14.0 Automated backport with mergify docs Team:Elastic-Agent Label for the Agent team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants