From f93febf56192efe145c8bde5a55fb9abbdeda80d Mon Sep 17 00:00:00 2001 From: Suyog Rao Date: Wed, 1 Jun 2016 13:31:36 +0200 Subject: [PATCH] Add docs about plugin generator Fixes #5418 --- docs/static/contributing-to-logstash.asciidoc | 2 +- docs/static/plugin-generator.asciidoc | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 docs/static/plugin-generator.asciidoc diff --git a/docs/static/contributing-to-logstash.asciidoc b/docs/static/contributing-to-logstash.asciidoc index 238b26fa4..05bdeade5 100644 --- a/docs/static/contributing-to-logstash.asciidoc +++ b/docs/static/contributing-to-logstash.asciidoc @@ -14,7 +14,7 @@ Since plugins can now be developed and deployed independently of the Logstash core, there are documents which guide you through the process of coding and deploying your own plugins: - +* <> * http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_input_plugin.html[How to write a Logstash input plugin] * http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_codec_plugin.html[How to write a Logstash codec plugin] * http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_filter_plugin.html[How to write a Logstash filter plugin] diff --git a/docs/static/plugin-generator.asciidoc b/docs/static/plugin-generator.asciidoc new file mode 100644 index 000000000..0563b466b --- /dev/null +++ b/docs/static/plugin-generator.asciidoc @@ -0,0 +1,19 @@ +[[plugin-generator]] +== Generating Plugins + +You can now create your own Logstash plugin in seconds! The generate subcommand of `bin/logstash-plugin` creates the foundation +for a new Logstash plugin with templatized files. It creates the right directory structure, gemspec files and dependencies so you +can start adding custom code process data with Logstash. + +**Example Usage** + +[source,sh] +-------------------------------------------- +bin/logstash-plugin generate --type input --name xkcd --path ~/ws/elastic/plugins +------------------------------------------- + +* `--type`: Type of plugin - input, filter, output and codec +* `--name`: Name for the new plugin +* `--path`: Directory path where the new plugin structure will be created. If not specified, it will be ' +created in the current directory. +