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

Add info to support cloud config #7813

Merged
merged 2 commits into from
Aug 6, 2018
Merged

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Jul 31, 2018

Summary of changes:

  • Added info to help cloud users get Beats set up correctly.
  • Added more platform-specific commands for setting up and running Filebeat modules (to make the docs consistent).
  • Did some minor cleanup to change product names > attribute references (still need to do a full cleanup, but trying to catch these as I open files).
  • Moved the content about changing the output codec so that it appears at the end of the output config section (since the section applies to multiple outputs).
  • Misc changes to make steps consistent, use similar language, etc across content.

I'm marking this as "in progress" because I need some input from reviewers before this is ready to merge. Please see comments flagged for REVIEWERS.

@dedemorton dedemorton added docs in progress Pull request is currently in progress. review labels Jul 31, 2018
@dedemorton dedemorton requested review from ruflin and exekias July 31, 2018 03:51
@dedemorton
Copy link
Contributor Author

dedemorton commented Jul 31, 2018

@exekias @ruflin Probably only needs one developer to review, so one of you is optional. You get to decide who. :-)

Copy link
Contributor

@exekias exekias left a comment

Choose a reason for hiding this comment

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

LGTM, Left some comments

@@ -2,54 +2,119 @@
[id="running-{modulename}-modules"]
=== Set up and run the module

IMPORTANT: If you’ve secured Elasticsearch and Kibana, you need to configure the
`username` and `password` options in the Elasticsearch output before setting up
// REVIEWERS: Should we include docker commands here, too?
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we should, as it is not straightforward in the docker world to follow these interactive steps

at the command line when you run Filebeat. In a production environment, you'll
probably want to use the configs in the `modules.d` directory instead. See
<<configuration-filebeat-modules>> for more information.
ownership or permissions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Both the note and the paragraph are talking about errors related to file ownership or permissions. May this sound repetitive? I'm not sure here, so it's your call :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The info is in one note, but you're right...I don't have to repeast hte phraise "errors related to file ownership or permissions."

// what theses commands look like for deb/rpm/windows. I assume we want to
// tell users to start the service, but I don't think options like -M are
// allowed when you start as a service. Are they? Hoping someone with
// deb/rpm/windows experience can help me get the syntax right here.
Copy link
Contributor

Choose a reason for hiding this comment

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

There is no way to pass these variables to services, they would need to update the config file with them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@exekias Then I should probably add a note to indicate that. But I think users can still run the following commands, right?

deb and rpm:

filebeat -e -M "nginx.access.var.paths=[/var/log/nginx/access.log*]"

win:

PS > .\filebeat.exe -e -M "nginx.access.var.paths=[c:/programdata/nginx/logs/*access.log*]"

Copy link
Contributor

Choose a reason for hiding this comment

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

Those look correct 👍 but they are not useful to keep the service running, but for testing.

@tbragin
Copy link
Contributor

tbragin commented Aug 1, 2018

cc @dov0211

@dedemorton
Copy link
Contributor Author

I've added the fixes from the review. I did a lot of refactoring in the Filebeat docs to remove duplicated content. You can see what the changes will look like here: https://filebeatreference-6af8e.firebaseapp.com/

Now all the commands in the getting started and reference content should show platform-specific commands.

@exekias Changes are ready for a final review.

@dedemorton dedemorton removed the in progress Pull request is currently in progress. label Aug 2, 2018
@dedemorton
Copy link
Contributor Author

jenkins retest this please

@dedemorton
Copy link
Contributor Author

@karenzone FYI...

Copy link
Contributor

@ph ph left a comment

Choose a reason for hiding this comment

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

LGTM

@ph ph merged commit 923cc55 into elastic:master Aug 6, 2018
@dedemorton dedemorton added the needs_backport PR is waiting to be backported to other branches. label Aug 8, 2018
dedemorton added a commit to dedemorton/beats that referenced this pull request Aug 8, 2018
* Add info to support cloud config
dedemorton added a commit to dedemorton/beats that referenced this pull request Aug 8, 2018
* Add info to support cloud config
dedemorton added a commit to dedemorton/beats that referenced this pull request Aug 8, 2018
* Add info to support cloud config
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Aug 9, 2018
ruflin pushed a commit that referenced this pull request Aug 9, 2018
* Add info to support cloud config
ruflin pushed a commit that referenced this pull request Aug 9, 2018
* Add info to support cloud config
ruflin pushed a commit that referenced this pull request Aug 9, 2018
* Add info to support cloud config
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
* Add info to support cloud config
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
* Add info to support cloud config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants