Skip to content


Subversion checkout URL

You can clone with
Download ZIP
logstash - transport and process your logs, events, or other data
Ruby Shell Other
Branch: master

New plugin config attribute :obsolete

An obsolete setting is one that will cause a configuration error if it
is used.

The purpose of `:obsolete` is to help inform users when a setting has
been completely removed. The lifecycle of a plugin setting is now 4
phases: available, deprecated, obsolete, deleted.

"Available" is the default, and deprecated remains the same as it was
(logging a warning). The new obsolete will cause a configuration error
if such a setting is used. Then later, we can finally delete the config
setting after it's been obsolete for some time.

Fixes #3977

Fixes #3978
latest commit 7e7e4c8719
@jordansissel jordansissel authored
Failed to load latest commit information.
acceptance_spec Update package acceptance tests
benchmark Add a micro benchmark runner
bin Fix path with space
bot Warm welcome to bot,may it serves you well
ci Make the necessary changes to use rspec3 as a default test runner for
docs New plugin config attribute :obsolete
lib New plugin config attribute :obsolete
locales New plugin config attribute :obsolete
patterns removes the patterns from patterns dir
pkg Use echo instead of trace or emit.
rakelib add test for compact and compact! in java_integrations
spec New plugin config attribute :obsolete
tools update to jruby-1.7.20 and cleanup legacy patches
.gitignore Update package acceptance tests
.tailor - add .tailor config
CHANGELOG move changelog to markdown and added link Update to changes in 2.0 beta1 Include link to reference docs
CONTRIBUTORS ElasticSearch output plugin to support multiple hosts and enhance sta…
Gemfile Revert "merged from upstream"
Gemfile.jruby-1.9.lock Revert "merged from upstream"
LICENSE update to elastic brand
Makefile Refactor build tooling to use Ruby
NOTICE.TXT Add NOTICE.TXT to comply with License Fix typo in
Rakefile add the missing magic header # encoding: utf-8 so all internal string… - clean up style guide a bit
dripmain.rb use :build dependencies
logstash-core.gemspec trigger input plugin shutdown using out of band call
logstash-event.gemspec Removing reference of `fieldreference`
require-analyze.rb - hacky script to analyze the DEBUG=require csv output grouped by

Logstash Code Climate Coverage Status

Logstash is a tool for managing events and logs. You can use it to collect logs, parse them, and store them for later use (like, for searching). If you store them in Elasticsearch, you can view and analyze them with Kibana.

It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

For more info, see

Logstash Plugins

AKA "Where'd that plugin go??"

Since version 1.5.0 beta1 (and current master) of Logstash, all plugins have been separated into their own repositories under the logstash-plugins github organization. Each plugin is now a self-contained Ruby gem which gets published to Logstash has added plugin infrastructure to easily maintain the lifecyle of the plugin. For more details and rationale behind these changes, see our blogpost.

Elasticsearch logstash-contrib repo is deprecated. We have moved all of the plugins that existed there into their own repositories. We are migrating all of the pull requests and issues from logstash-contrib to the new repositories.

For more info on developing and testing these plugins, please see the README on any plugin repository.

Plugin Issues and Pull Requests

We are migrating all of the existing pull requests to their respective repositories. Rest assured, we will maintain all of the git history for these requests.

Please open new issues and pull requests for plugins under its own repository

For example, if you have to report an issue/enhancement for the Elasticsearch output, please do so here.

Logstash core will continue to exist under this repository and all related issues and pull requests can be submitted here.

Need Help?


Logstash uses JRuby which gets embedded in the vendor/jruby/ directory. It is recommended but not mandatory that you also use JRuby as your local Ruby interpreter and for this you should consider using a Ruby version manager such as RVM or rbenv. It is possible to run the rake tasks and the bin/ commands without having JRuby locally installed in which case the embedded JRuby will be used automatically. If you have a local JRuby installed you can force logstash to use your local JRuby instead of the embedded JRuby with the USE_RUBY=1 environment variable.

To get started, make sure you have a local JRuby or Ruby version 1.9.x or above with the rake tool installed.

On Windows make sure to set the JAVA_HOME environment variable to the path to your JDK installation directory. For example set JAVA_HOME=<JDK_PATH>

To run logstash from the repo you must bootstrap the environment

rake bootstrap

or bootstrap & install the core plugins required to run the tests

rake test:install-core

To verify your environment, run bin/logstash version which should look like this

$ bin/logstash version


For testing you can use the test rake tasks and the bin/rspec command, see instructions below. Note that the bin/logstash rspec command has been replaced by bin/rspec.

Core tests

1- In order to run the core tests, a small set of plugins must first be installed:

rake test:install-core

2- To run the logstash core tests you can use the rake task:

rake test:core

or use the rspec tool to run all tests or run a specific test:

bin/rspec spec/foo/bar_spec.rb

Note that if a plugin is installed using the plugin manager bin/plugin install ... do not forget to also install the plugins development dependencies using the following command after the plugin installation:

bin/plugin install --development

Plugins tests

To run the tests of all currently installed plugins:

rake test:plugin

You can install the default set of plugins included in the logstash package or all plugins:

rake test:install-default
rake test:install-all

Note that if a plugin is installed using the plugin manager bin/plugin install ... do not forget to also install the plugins development dependencies using the following command after the plugin installation:

bin/plugin install --development

Developing plugins

The documentation for developing plugins can be found in the plugins README, see our example plugins:

Drip Launcher

Drip is a tool which help solve the slow JVM startup problem. The drip script is intended to be a drop-in replacement for the java command. We recommend using drip during development, in particular for running tests. Using drip, the first invokation of a command will not be faster but the subsequent commands will be swift.

To tell logstash to use drip, either set the USE_DRIP=1 environment variable or set JAVACMD=`which drip`.


USE_DRIP=1 bin/rspec
USE_DRIP=1 bin/rspec


Drip does not work with STDIN. You cannot use drip for running configs which uses the stdin plugin.


You can build a logstash package as tarball or zip file

rake artifact:tar
rake artifact:zip

You can also build .rpm and .deb, but the fpm tool is required.

rake artifact:rpm
rake artifact:deb

Project Principles

  • Community: If a newbie has a bad time, it's a bug.
  • Software: Make it work, then make it right, then make it fast.
  • Technology: If it doesn't do a thing today, we can make it do it tomorrow.


All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.

Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.

It is more important to me that you are able to contribute.

For more information about contributing, see the CONTRIBUTING file.

Something went wrong with that request. Please try again.