Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
logstash - logs/event transport, processing, management, search.

This branch is 2149 commits behind elasticsearch:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
bot
docs
etc
lib
locales
misc
patterns
pkg
screencast
spec
src/net/logstash
test/jenkins
.gitignore
.tailor
.travis.yml
CHANGELOG
CONTRIBUTORS
Gemfile
LICENSE
Makefile
README.md
STYLE.md
extract_services.rb
gembag.rb
logstash-event.gemspec
logstash.gemspec
pl.rb
pl2.rb
pull_release_note.rb

README.md

logstash

Build 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). Speaking of searching, logstash comes with a web interface for searching and drilling into all of your logs.

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 http://logstash.net/

Need Help?

Need help? Try #logstash on freenode irc or the logstash-users@googlegroups.com mailing list.

You can also find documentation on the http://logstash.net site.

Developing

If you don't have JRuby already (or don't use rvm, rbenv, etc), you can have bin/logstash fetch it for you by setting USE_JRUBY:

USE_JRUBY=1 bin/logstash ...

Otherwise, here's how to get started with rvm:

# Install JRuby with rvm
rvm install jruby-1.7.4
rvm use jruby-1.7.4

Now install dependencies:

# Install logstash ruby dependencies
ruby gembag.rb logstash.gemspec

# to use logstash gems or libraries in irb, use the following
# this gets you an 'irb' shell with logstash's environment
bin/logstash irb

# or use irb from the jar
java -jar logstash-<version>-monolithic.jar irb

# Run logstash
bin/logstash agent [options]

# If running bin/logstash agent yields complaints about log4j/other things
# This will download the elasticsearch jars so logstash can use them.
make vendor-elasticsearch

Testing

There are a few ways to run the tests. For development, using bin/logstash rspec <some spec> will suffice:

% bin/logstash rspec spec/filters/grok.rb 
...................

Finished in 0.123 seconds
19 examples, 0 failures

Alternately, if you have just built the flatjar or jar, you can run the tests specifically on those like so:

% make flatjar-test
# or ...
% make jar-test

Finally, like 'bin/logstash rspec' above, you can invoke the jar to run a test like so:

% java -jar logstash.jar rspec spec/filters/grok.rb
...................

Finished in 0.346 seconds
19 examples, 0 failures

Building

Releases are available here: http://logstash.objects.dreamhost.com/

If you want to build the jar yourself, run:

make flatjar

rpm, deb, or other package formats are not currently available, but are easy to build with fpm. If you are interested in seeing future releases include your favorite packaging format, please let me know.

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.

Contributing

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.

That said, some basic guidelines, which you are free to ignore :)

  • Have a problem you want logstash to solve for you? You can email the mailing list, or join the IRC channel #logstash on irc.freenode.org, or email me personally (jls@semicomplete.com)
  • Have an idea or a feature request? File a ticket on jira, or email the mailing list, or email me personally (jls@semicomplete.com) if that is more comfortable.
  • If you think you found a bug, it probably is a bug. File it on jira or send details to the mailing list.
  • If you want to send patches, best way is to fork this repo and send me a pull request. If you don't know git, I also accept diff(1) formatted patches - whatever is most comfortable for you.
  • Want to lurk about and see what others are doing? IRC (#logstash on irc.freenode.org) is a good place for this as is the mailing list
Something went wrong with that request. Please try again.