Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


logstash (16) Versions 0.11.4

Installs/Configures logstash

cookbook 'logstash', '= 0.11.4', :supermarket
cookbook 'logstash', '= 0.11.4'
knife supermarket install logstash
knife supermarket download logstash
Quality 0%

<a name="title"></a> chef-logstash Build Status


This is the semi-official 'all-in-one' Logstash cookbook.

This cookbook is primarily a library cookbook.

While you can still use the agent and server recipes, they are not recommended as they are very limited in what they do.

If you are using logstash < 1.2 you might want to use the 0.6.x branch.
If you are using logstash < 1.4 you might want to use the 0.7.x branch.


All of the requirements are explicitly defined in the recipes. Every
effort has been made to utilize Community Cookbooks.

However if you wish to use an external ElasticSearch cluster, you will
need to install that yourself and change the relevant attributes for
discovery. The same applies to integration with Graphite.

This cookbook has been tested together with the following cookbooks,
see the Berksfile for more details



see [attributes/default.rb](attributes/default.rb)

Beaver (alternative to Logstash Agent)

no longer used. see Community Beaver cookbook


no longer supports installing from source.

Lightweight Resource Providers

These now do all the heavy lifting.


This will install a logstash instance. It will take defaults from attributes for most attributes.

see [resources/instance.rb](resources/instance.rb)


This will create system init scripts for managing logstash instance. It will take defaults from attributes for most attributes.

see [resources/service.rb](resources/service.rb)

experimental support for pleaserun has been added. Only native for Ubuntu 12.04 has been thoroughly tested.


This will create logstash config files. It will take defaults from attributes for most attributes.

see [resources/config.rb](resources/config.rb)


This will install custom grok patterns for logstash. It will take defaults from attributes for most attributes:

see [resources/pattern.rb](resources/pattern.rb)


This will install the logstash community plugins:

see [resources/plugins.rb](resources/plugins.rb)


This will install the ElasticSearch Curator and setup a cron job. This replaces the deprecated index_cleaner:

see [resources/curator.rb](resources/curator.rb)

attribute precidence in logstash LWRPs

We've done our best to make this intuitive and easy to use.

  1. the value directly in the resource block.
  2. the value from the hash node['logstash']['instance'][name]
  3. the value from the hash node['logstash']['instance_default']

You should be able to override settings in any of the above places. It is recommended for readability that you set non-default options in the LWRP resource block. But do whichever makes sense to you.


There is a search helper library libraries/search.rb which will help you search for values such as elasticsearch_ip. see the server recipe for an example of its usage.



depreciated in favor if test kitchen.

$ vagrant up precise64

Rubocop, FoodCritic, Rspec, Test-Kitchen

$ bundle exec rake

Test Kitchen

$ kitchen converge server_ubuntu


Any and all contributions are welcome. We do ask that you test your contributions with the testing framework before you send a PR. All contributions should be made against the master branch.

Please update tests and changelist with your contributions.

Documentation contributions will earn you lots of hugs and kisses.


A proper readme is forthcoming but in the interim....

These two recipes show how to install and configure logstash instances via the provided LWRPs

  • [recipes/server.rb](recipes/server.rb) - This would be your indexer node
  • [recipes/agent.rb](recipes/agent.rb) - This would be a local host's agent for collection

See the elkstack community cookbook for a great example of using the LWRPs provided by this cookbook.



  • Vagrant 1.2.1+
  • Vagrant Berkshelf Plugin vagrant plugin install vagrant-berkshelf
  • Vagrant Omnibus Plugin vagrant plugin install vagrant-omnibus

Uses the Box Name to determine the run list ( based on whether its Debian or RHEL based ).

See chef_json and chef_run_list variables to change recipe behavior.


Run Logstash on Ubuntu Lucid : vagrant up lucid32 or vagrant up lucid64

Run Logstash on Centos 6 32bit : vagrant up centos6_32

Logstash will listen for syslog messages on tcp/5140

License and Author

  • Author: John E. Vincent
  • Author: Bryan W. Berry (
  • Author: Richard Clamp (@richardc)
  • Author: Juanje Ojeda (@juanje)
  • Author: @benattar
  • Author: Paul Czarkowski (@pczarkowski)
  • Copyright: 2012, John E. Vincent
  • Copyright: 2012, Bryan W. Berry
  • Copyright: 2012, Richard Clamp
  • Copyright: 2012, Juanje Ojeda
  • Copyright: 2012, @benattar
  • Copyright: 2014, Paul Czarkowski

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

CHANGELOG for chef-logstash


  • MINOR - default logstash version 1.4.2
  • MINOR - correct status code for initv scripts
  • MINOR - parameterize open file limits for upstart method
  • MINOR - late night bad resource in server recipe.


  • MAJOR - depreciate non runit service types.
  • MINOR - fix bug where node['logstash'][instance_name] must exist.
  • MAJOR - remove pyshipper in favor of beaver community cookbook.
  • MAJOR - remove beaver in favor of community cookbook.
  • MAJOR - assumes ChefDK for Development/Testing
  • MAJOR - use keys from config_template hash to make templates reusable.


  • major rework of service LWRP
  • rework of attribute precidence
  • node[logstash][default] changed to node[logstash][instance_default]

This file is used to list changes made in each version of chef-logstash.


  • update to fix PAX header issue on community site


  • curator LWRP


this will almost certainly break backwards compatibility

  • support for Logstash 1.4
  • major refactor towards being a library cookbook
    • instance LWRP
    • service LWRP
    • pattern LWP
    • config LWP


  • Support for new beaver config #239
  • Support for multiline codec #240
  • Parameterize /var/lib/logstash #242
  • Fix parameter spacing option #244


  • introduced more testing
    • Strainer: rubocop, knife test, foodcritic, chefspec
    • lots of style fixes for rubocop
    • skeleton spec files for each recipe
    • testkitchen + server spec


  • added fedora systemd support
  • moved zeromq repos to own recipe


  • bump logstash version to 1.3.2


  • support for sudo with upstart for agent and server


  • embedded kibana support


  • various bugfixes
  • support for multiple logstash workers via attribute.


New features

  • settable gid when using runit or upstart as supervisor
  • default logstash version 1.2.2
  • attributes to specify: config_dir, home, config_file for both agent and server.
  • don't install rabbit by default
  • allow for conditionals to be set in the filters and outputs hashes.
  • allow for disabling data driven templates.
  • attributes to enable regular(ish) style chef templates.

Bug fixes

  • Vagrantfile cleanup, support more OS
  • Cookbook Dependency cleanup

0.2.1 (June 26, 2012)

New features
* Use ruby hashes supplied by roles to populate inputs, filters,
and outputs
* redhat-family support
* change default version of logstash to 1.1.1preview
* add in Travis-CI support

Bug fixes
* keep apache default site from obscuring kibana

Foodcritic Metric

0.11.4 failed this metric

FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/b4740dbed4d4277fac71274f/logstash/templates/default/sv-logstash_web-run.erb:12
FC024: Consider adding platform equivalents: /tmp/cook/b4740dbed4d4277fac71274f/logstash/libraries/logstash_util.rb:48