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

Update Journalbeat docs #8864

Merged
merged 11 commits into from
Nov 9, 2018
Merged

Update Journalbeat docs #8864

merged 11 commits into from
Nov 9, 2018

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Nov 1, 2018 •
edited
Loading

This PR completes the doc changes for Journalbeat. So that we can do a full review of all the new files, including merged content, I've created a review repo here: https://github.com/dedemorton/beats-docs-review. Here's the review process we'll follow:

1 - DONE Review the PR that I created here and add your comments: dedemorton/beats-docs-review#1.
2 - DONE Merge this PR when the full review is complete: dedemorton/beats-docs-review#1.
3 - DONE Come back to this PR (#8864) and do a final review that includes the changes in libbeat.
4 - When the changes are approved, I'll merge and backport as usual.

Open questions:

  • Will Journalbeat be available in the apt/yum repos?
  • Are dashboards available for 6.5?
  • What is the default for max_backoff in 6.5?
  • Are seek settings as they are now documented correct?

Remaining work to do after this PR is merged:

  • Get the Journalbeat docs added to the full doc build.
  • Add linux command examples to the shared files.
  • Make updates to the command reference.
    - [ ] Alphabetize the list of processors (cleanup task). Removed because this is minor.
  • (verify) Add global options back into the docs: max_backoff, backoff, seek, and include_matches

@dedemorton dedemorton added docs in progress Pull request is currently in progress. review needs_backport PR is waiting to be backported to other branches. and removed review labels Nov 1, 2018
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Nov 1, 2018
@dedemorton dedemorton requested review from kvch and urso November 1, 2018 23:32
@dedemorton dedemorton mentioned this pull request Nov 1, 2018
Merged
5 tasks
@dedemorton dedemorton added backport and removed in progress Pull request is currently in progress. labels Nov 8, 2018
urso
urso reviewed Nov 8, 2018
View reviewed changes
Copy link

@urso urso left a comment

Choose a reason for hiding this comment

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

#8973 adds a default dashboard. The PR is approved, green and ready to merge. I think we will have these changes in 6.5 as well. @kvch right?

@dedemorton dedemorton added needs_backport PR is waiting to be backported to other branches. and removed backport labels Nov 8, 2018
@kvch
Copy link
Contributor

kvch commented Nov 9, 2018

Yes, I am backporting it to 6.5.

@kvch
Copy link
Contributor

kvch commented Nov 9, 2018

Documentation of seek is correct.
Dep and rpm pacakges are built for journalbeat, so I assume those will be available in APT and YUM repos.

@kvch
Copy link
Contributor

kvch commented Nov 9, 2018 •
edited by dedemorton
Loading

Sorry, but the changes I made in my last PR are not going to make it to 6.5. Could you please follow up the changes in the docs?
Changes:

  • default value of backoff is 60s
  • no dashboard

@dedemorton dedemorton merged commit 508d898 into elastic:master Nov 9, 2018
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 9, 2018
@dedemorton
Update Journalbeat docs (elastic#8864)
ba58e4f 
* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back
@dedemorton dedemorton mentioned this pull request Nov 9, 2018
Merged
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 9, 2018
@dedemorton
Update Journalbeat docs (elastic#8864)
478c93d 
* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back
@dedemorton dedemorton mentioned this pull request Nov 9, 2018
Merged
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Nov 9, 2018
dedemorton added a commit that referenced this pull request Nov 12, 2018
@dedemorton
Backport to 6.x: Docs for new beats (#8811, #8864, #8744) (#9024)
7aaaaa7 
* Add conditions for each platform (#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
dedemorton added a commit that referenced this pull request Nov 12, 2018
@dedemorton
Backport to 6.5: Docs for new beats (#8811, #8864, #8744) (#9025)
2df6560 
* Add conditions for each platform (#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
DStape pushed a commit to DStape/beats that referenced this pull request Aug 20, 2019
@dedemorton
Update Journalbeat docs (elastic#8864)
39e8c14 
* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back
DStape pushed a commit to DStape/beats that referenced this pull request Aug 20, 2019
@dedemorton
Backport to 6.x: Docs for new beats (elastic#8811, elastic#8864, elas…
6195f6a 
…tic#8744) (elastic#9024)

* Add conditions for each platform (elastic#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (elastic#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (elastic#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
@dedemorton
Backport to 6.5: Docs for new beats (elastic#8811, elastic#8864, elas…
2d15ace 
…tic#8744)  (elastic#9025)

* Add conditions for each platform (elastic#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (elastic#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (elastic#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kvch kvch kvch left review comments

@jsoriano jsoriano jsoriano left review comments

@urso urso urso approved these changes

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dedemorton @kvch @jsoriano @urso