Logstash has a rich collection of input, filter, codec and output plugins. Plugins are available as self-contained packages called gems and hosted on RubyGems.org. The plugin manager accesed via
bin/plugin script is used to manage the lifecycle of plugins in your Logstash deployment. You can install, uninstall and upgrade plugins using these Command Line Interface (CLI) described below.
Some sections here are for advanced users
Logstash release packages bundle common plugins so you can use them out of the box. To list the plugins currently available in your deployment:
Will list all installed plugins
Will list installed plugins with version information
Will list all installed plugins containing a namefragment
Will list all installed plugins for a particular group (input, filter, codec, output)
Adding plugins to your deploymentedit
The most common situation when dealing with plugin installation is when you have access to internet. Using this method, you will be able to retrieve plugins hosted on the public repository (RubyGems.org) and install on top of your Logstash installation.
bin/plugin install logstash-output-kafka
Once the plugin is successfully installed, you can start using it in your configuration file.
Advanced: Adding a locally built pluginedit
In some cases, you want to install plugins which have not yet been released and not hosted on RubyGems.org. Logstash provides you the option to install a locally built plugin which is packaged as a ruby gem. Using a file location:
bin/plugin install /path/to/logstash-output-kafka-1.0.0.gem
--pluginpath flag, you can load a plugin source code located on your file system. Typically this is used by developers who are iterating on a custom plugin and want to test it before creating a ruby gem.
bin/logstash --pluginpath /opt/shared/lib/logstash/input/my-custom-plugin-code.rb
Plugins have their own release cycle and are often released independent of Logstash’s core release cycle. Using the update sub-command you can get the latest or update to a particular version of the plugin.
If you need to remove plugins from your Logstash installation:
bin/plugin uninstall logstash-output-kafka
The previous sections relied on Logstash being able to communicate with RubyGems.org. In certain environments, Forwarding Proxy is used to handle HTTP requests. Logstash Plugins can be installed and updated through a Proxy by setting the
HTTP_PROXY environment variable:
export HTTP_PROXY=http://127.0.0.1:3128 bin/plugin install logstash-output-kafka
Once set, plugin commands install, update can be used through this proxy.