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

Document new command line interface #4490

Closed
exekias opened this issue Jun 12, 2017 · 5 comments
Closed

Document new command line interface #4490

exekias opened this issue Jun 12, 2017 · 5 comments

Comments

@exekias
Copy link
Contributor

exekias commented Jun 12, 2017

New command line interface has been merged #4420

This adds subcommands for different actions while keeping backwards compatibility if no subcommand is given (it will execute run). We will need to document the new features and update existing invocations to the new format.

We may probably want to support documentation for beat specific subcommands in the future, apart from the default, common ones.

Right now we have:

$ metricbeat help
$ metricbeat version
$ metricbeat configtest
$ metricbeat setup
$ metricbeat run
$ metricbeat (alias for metricbeat run)
@tsg
Copy link
Contributor

tsg commented Jun 21, 2017

As part of #4506 I added a new flag --machine-learning to the setup command, which only loads the ML configurations. I defer the task of writing the docs for it to this ticket :).

@exekias
Copy link
Contributor Author

exekias commented Jun 26, 2017

#4510 was merged, this is the list of new commands:

$ metricbeat completion
$ metricbeat export config
$ metricbeat export template

@dedemorton let me know if you need any pointers when doing this task, we can do a call or I can write some notes

@exekias
Copy link
Contributor Author

exekias commented Jul 10, 2017

#4537 was merged, and it's the last one, it adds modules management command for metricbeat and filebeat:

$ metricbeat modules list
$ metricbeat modules enable apache2

@dedemorton
Copy link
Contributor

Created #4832 to add these docs.

@dedemorton
Copy link
Contributor

I think we can close this, right? Looks like maybe some of the names changed, but I think I covered all of this in the command ref info in 4832.

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

No branches or pull requests

3 participants