Ruby Java HTML Shell JavaScript CSS Other
Switch branches/tags
Failed to load latest commit information.
.github Move Contributors for more visibility May 20, 2016
bin make -V/--version fast on Windows (#8508) Feb 21, 2018
buildSrc BUILD: Fix wrong paths and wrong output declarations on installTestGe… Jan 29, 2018
ci BUILD: Run rake tasks in Gradle JVM Jan 17, 2018
config Remove pipeline.output.workers from logstash.yml Jan 4, 2018
data Add back missing gitkeep in data dir Jan 23, 2018
docs Fix overview list and add ID Feb 16, 2018
gradle/wrapper MINOR: Move to Gradle 4.3 + Use Gradle Source Distribution Oct 31, 2017
lib Secret Store: Ability to set and use secret data from an encrypted da… Jan 13, 2018
logstash-core-plugin-api Add generated runtime_dependency to logstash core plugin Oct 11, 2017
logstash-core BUG: Fix input shutting down prematurely Feb 22, 2018
modules Adding an ability of being more verbose when setting up netflow module Nov 17, 2017
pkg Ensure that environment variables are only accessible to be read root Jan 24, 2018
qa test fix: use single worker in test to avoid concurrency issue in sle… Jan 17, 2018
rakelib Add pipelines.yml to RPM/DEB configured files to avoid overwrite on u… Feb 9, 2018
spec Remove in memory serialized queue Ruby wrappers Jan 22, 2018
tools #8360 fix tests by enforcing IPV4 in Benchmark tool UTs Sep 23, 2017
.dockerignore Introduce docker for CI builds. Sep 14, 2017
.gitignore Keystore documentation Feb 6, 2018
.ruby-version Revert "MINOR: Adjust Ruby Version File" Sep 12, 2017 Update Contribution Guidelines (#9186) Feb 22, 2018
CONTRIBUTORS Doc: update contributing guide to include link for IntelliJ setup Fixes Jun 19, 2017
COPYING.csv Add tool to generate dependency details in csv Dec 22, 2017
Dockerfile Revert "Add .lock.release to the test docker container" Nov 29, 2017
Dockerfile.base Minor: Remove JRuby 1.7 from the docker base image (it is not used) Sep 20, 2017
Gemfile.template add jdbc_static (#8933) Jan 15, 2018
LICENSE Generate notice file during artifact build (#6538) Jan 16, 2017 Fix spacing Feb 7, 2018 New roadmap page May 20, 2016
Rakefile Rakefile: update help with test tasks. Mar 31, 2017 use jruby Jun 12, 2017
build.gradle BUILD: Fix wrong paths and wrong output declarations on installTestGe… Jan 29, 2018 Test fix: disable the gradle daemon by default (as recommended for CI) Oct 5, 2017
gradlew Migrate Logstash to Log4j2 Logging (#5651) Aug 25, 2016
gradlew.bat Migrate Logstash to Log4j2 Logging (#5651) Aug 25, 2016
settings.gradle Benchmark Tool Jul 24, 2017
versions.yml Bump to jackson 2.9.4 and pin jrjackson to exact version Feb 21, 2018


Logstash is part of the Elastic Stack along with Beats, Elasticsearch and Kibana. Logstash is an open source, server-side data processing pipeline that ingests data from a multitude of sources simultaneously, transforms it, and then sends it to your favorite "stash." (Ours is Elasticsearch, naturally.). Logstash has over 200 plugins, and you can write your own very easily as well.

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

Documentation and Getting Started

You can find the documentation and getting started guides for Logstash on the site

For information about building the documentation, see the README in


You can download officially released Logstash binaries, as well as debian/rpm packages for the supported platforms, from downloads page.

Snapshot Builds

For the daring, snapshot builds are available. These builds are created nightly and have undergone no formal QA, so they should never be run in production.


Need Help?

Logstash Plugins

Logstash plugins are hosted in separate repositories under the logstash-plugins github organization. Each plugin is a self-contained Ruby gem which gets published to

Writing your own Plugin

Logstash is known for its extensibility. There are hundreds of plugins for Logstash and you can write your own very easily! For more info on developing and testing these plugins, please see the working with plugins section

Plugin Issues and Pull 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.

Developing Logstash Core


  • Install JDK version 8. Make sure to set the JAVA_HOME environment variable to the path to your JDK installation directory. For example set JAVA_HOME=<JDK_PATH>
  • Install JRuby 9.1.x It is recommended to use a Ruby version manager such as RVM or rbenv.
  • Install rake and bundler tool using gem install rake and gem install bundler respectively.

RVM install (optional)

If you prefer to use rvm (ruby version manager) to manage Ruby versions on your machine, follow these directions:

gpg --keyserver hkp:// --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL | bash -s stable --ruby=jruby-

Check Ruby version

Before you proceed, please check your ruby version by:

$ ruby -v
jruby (2.3.3) 2017-05-25 b09c48a Java HotSpot(TM) 64-Bit Server VM 25.131-b11 on 1.8.0_131-b11 +jit [darwin-x86_64]

Building Logstash

  • To run Logstash from the repo you must first bootstrap the environment:
rake bootstrap
  • You can then use bin/logstash to start Logstash, but there are no plugins installed. To install default plugins, you can run:
rake plugin:install-default

This will install the 80+ default plugins which makes Logstash ready to connect to multiple data sources, perform transformations and send the results to Elasticsearch and other destinatins.

To verify your environment, run the following to send your first event:

bin/logstash -e 'input { stdin { } } output { stdout {} }'

This should start Logstash with stdin input waiting for you to enter an event

hello world
2016-11-11T01:22:14.405+0000 hello world

Advanced: Drip Launcher

Drip is a tool that solves the slow JVM startup problem while developing Logstash. 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 invocation 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


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

Building Logstash Documentation

To build the Logstash Reference (open source content only) on your local machine, clone the following repos:

logstash - contains main docs about core features

logstash-docs - contains generated plugin docs

docs - contains doc build files

Make sure you have the same branch checked out in logstash and logstash-docs. Check out master in the docs repo.

Run the doc build script from within the docs repo. For example:

./ --doc ../logstash/docs/index.asciidoc --chunk=1 -open


Most of the unit tests in Logstash are written using rspec for the Ruby parts. For the Java parts, we use junit. For testing you can use the test rake tasks and the bin/rspec command, see instructions below:

Core tests

1- To run the core tests you can use the Gradle task:

./gradlew test

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

bin/rspec spec/foo/bar_spec.rb

Note that before running the rspec command for the first time you need to set up the RSpec test dependencies by running:

./gradlew bootstrap

2- To run the subset of tests covering the Java codebase only run:

./gradlew javaTests

3- To execute the complete test-suite including the integration tests run:

./gradlew check

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:

rake test:install-default

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

bin/logstash-plugin install --development

Building Artifacts

You can build a Logstash snapshot package as tarball or zip file

./gradlew assembleTarDistribution
./gradlew assembleZipDistribution

This will create the artifact LS_HOME/build directory

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.