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


beaver (8) Versions 1.7.0

Installs/Configures beaver

cookbook 'beaver', '~> 1.7.0', :supermarket
cookbook 'beaver', '~> 1.7.0'
knife supermarket install beaver
knife supermarket download beaver
Quality 17%

beaver Cookbook

Install beaver - the python daemon that munches on logs and sends their
contents to logstash.


Ohai and Chef:

This cookbook makes use of node['platform_family'] to simplify
platform selection logic. This attribute was introduced in Ohai v0.6.12.


The following platform families are supported:

  • Debian derivatives (Debian, Ubuntu, etc)
  • RHEL derivatives (RHEL, CentOS, etc)


  • poise-python (to use the python_package LWRP)



Key Type Description Default
<tt>['beaver']['version']</tt> String Version to install via pip <tt>29</tt>
<tt>['beaver']['log_path']</tt> String Log path <tt>/var/log</tt>
<tt>['beaver']['log_file']</tt> String Log file <tt>beaver.log</tt>
<tt>['beaver']['generate_keypair']</tt> Boolean Whether to generate and expose keypair or not <tt>false</tt>
<tt>['beaver']['ssh_key_file']</tt> String Basename of the keyfiles to generate <tt>logger</tt>
<tt>['beaver']['config_path']</tt> String Configuration path <tt>/etc/beaver</tt>
<tt>['beaver']['config_file']</tt> String Configuration file <tt>beaver.conf</tt>
<tt>['beaver']['user']</tt> String User to run service as <tt>root</tt>
<tt>['beaver']['group']</tt> String Group to run service as <tt>root</tt>
<tt>['beaver']['configuration']</tt> Hash Key/Value configuration pairs <tt>{ 'respawn_delay' => 3, 'max_failure' => 7 }
<tt>['beaver']['files']</tt> Array Array containing hashes like { 'path' => '/var/log/syslog', 'type' => 'syslogs', 'tags' => 'sys, syslog' } for files to watch <tt>[]</tt>
<tt>['beaver']['input_type']['tcp/ampq/etc']</tt> Hash Key/Value input_types
<tt>['beaver']['output']</tt> Hash Key/Value
<tt>['poise-python']['beaver']['provider']</tt> String Python provider to install with. See poise-python for details. <tt>system</tt>
<tt>['poise-python']['beaver']['version']</tt> String Python version to install. Blank means any. Beaver only supports 2 as of v36. <tt>'2'</tt>


Managing log files

This cookbook includes an LWRP for managing log files consumed by Beaver. It
does so by dropping configuration snippets for each log file into Beaver's conf.d


  • :create: Creates a config file and restarts Beaver to load it. (This is the default action)
  • :delete: Removes the config file.


Parameter Type Description Default
<tt>name</tt> String Should be a name for the log file. e.g. 'syslog' <tt></tt>
<tt>path</tt> String The path to the log file being monitored. (Required) <tt></tt>
<tt>cookbook</tt> String Which cookbook contains the config file template, beaver-tail.conf.erb. <tt>beaver</tt>
<tt>format</tt> String What Logstash format should be used to send the log data. <tt>json_event</tt>
<tt>type</tt> String What Logstash type to associate with the log data. <tt>file</tt>
<tt>tags</tt> Array The Logstash tags to associate with the log data as an array of strings. <tt>[]</tt>
<tt>add_field</tt> Array The Logstash field(s) to associate with the log data. An array of strings in the form ['fieldname1', 'fieldvalue1']. <tt>[]</tt>
<tt>exclude</tt> String Which log files to exclude. Useful if using a file glob in the path parameter. The value must be a valid Python regex string. <tt></tt>


# Monitor /var/log/syslog
beaver_tail "syslog" do
  path "/var/log/syslog"
  type "syslog"
  format "json_event"

# Follow all logs in /var/log except those with `messages` or `secure` in the name.
beaver_tail "system logs" do
  path "/var/log/*log"
  type "syslog"
  tags: ["sys"]
  exclude "(messages|secure)"

# Stop monitoring syslog
beaver_tail "syslog" do
  action :delete



Just include beaver in your node's run_list:

  "run_list": [

And configure beaver either in role or on the node. If you set
['beaver']['ssh']['generate_keypair'] to true the cokbook will create
a public-key pair in the config_path and will expose the public key on
the node. This key can then be searched by e.g. the logstash host and
grant password-free access to tunnel e.g. redis (or anything else)
through it.

Configuration example (role)

  "name": "logstash-client",
  "description": "",
  "json_class": "Chef::Role",
  "chef_type": "role",
  "default_attributes": {
    "beaver": {
      "generate_keypair": true,
      "configuration": {
        "transport": "redis",
        "redis_url": "redis://localhost:6379/0",
        "redis_namespace": "logstash:beaver",
        "ssh_key_file": "remote_key",
        "ssh_tunnel": "",
        "ssh_tunnel_port": 6379,
        "ssh_remote_host": "",
        "ssh_remote_port": "6379"
  "run_list": [

Input Type Configuration (Hash)

  node.set['beaver']['input_type']['amqp'] = {
  'name' => "logstash_queue",
  'type' => "direct",
  'host' => "",
  'exchange' => "logstash-exchange",
  'key' => "logstash-key",
  'exclusive' => false,
  'durable' => false,
  'auto_delete' => false,

Output Type Configuration (Hash)

node.set['beaver']['output'] = {
    'output' => 'stdout { debug => true }'


  1. Fork the repository on Github
  2. Create a named feature branch (like add_component_x)
  3. Write you change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request using Github



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, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

CHANGELOG for beaver

This file is used to list changes made in each version of beaver.


  • Jeff Ramnani added a great LWRP for tail logs
  • The whole configuration changed to a way more flexible approach that will allow future configuration options in the cookbook without any adjustments (that is the reason for the major version bump too)


  • Initial release of beaver

Check the Markdown Syntax Guide for help with Markdown.

The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.

Collaborator Number Metric

1.7.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

1.7.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Foodcritic Metric

1.7.0 failed this metric

FC034: Unused template variables: beaver/templates/default/beaver-tail.conf.erb:1
FC064: Ensure issues_url is set in metadata: beaver/metadata.rb:1
FC065: Ensure source_url is set in metadata: beaver/metadata.rb:1
FC066: Ensure chef_version is set in metadata: beaver/metadata.rb:1
FC069: Ensure standardized license defined in metadata: beaver/metadata.rb:1
FC070: Ensure supports metadata defines valid platforms: beaver/metadata.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: beaver/providers/tail.rb:39
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric

1.7.0 passed this metric

Testing File Metric

1.7.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Version Tag Metric

1.7.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must include a tag that matches this cookbook version number