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


papertrail (3) Versions 1.1.1

Installs/Configures Papertrail's remote_syslog2

cookbook 'papertrail', '~> 1.1.1'
cookbook 'papertrail', '~> 1.1.1', :supermarket
knife supermarket install papertrail
knife supermarket download papertrail
Quality 88%

Papertrail Cookbook

This cookbook configures the Papertrail remote_syslog2 agent. To configure rsyslog for use with Papertrail, check out the Papertrail documentation.

Supported Platforms

  • RHEL 6 / CentOS 6
  • RHEL 7 / CentOS 7
  • Amazon Linux 2017.03
  • Ubuntu 14.04
  • Ubuntu 16.04
  • Debian 9

This cookbook has been tested on Chef 13.x and 12.21.x.



  1. Set the attributes node['papertrail']['destination_host'], node['papertrail']['destination_port'], and at least one file/directory in node['papertrail']['files'].
  2. Include papertrail in your node's run_list:
  "run_list": [

This will install remote_syslog2 with the configured settings from the Chef node attributes.

Recipes & their attributes

This cookbook only has one recipe, which does all setup and configuration. There are a number of attributes you can configure, all of which mirror the configuration items found in the remote_syslog2 README.

  • node['papertrail']['files']

Type: Array

A list of files or patterns to send to Papertrail. At least one entry is required.

Example: ruby node['papertrail']['files'] = [ '/tmp/test.log', '/srv/foo.txt', '/var/log/*.bar' ]

To tag a file/path, the structure is slightly different: ruby node['papertrail']['files'] = [ '/tmp/test.log', '/srv/foo.txt', {'path' => '/srv/foo.txt', 'tag' => 'my_tag'} ]

  • node['papertrail']['exclude_files']

Type: Array

A list of files or patterns to exclude.

Example: ruby node['papertrail']['exclude_files'] = [ '/tmp/exlude.log', '/srv/dont-include.log', '/var/log/skip-me.log' ]

  • node['papertrail']['exclude_patterns']

Type: Array

A regex of log message patterns to exclude.

Example: ruby node['papertrail']['exclude_patterns'] = ['\d+ things'] - node['papertrail']['hostname']

Type: String

Override the default hostname.

Example: ruby node['papertrail']['hostname'] = 'my-super-awesome-hostname'

  • node['papertrail']['destination_host'], node['papertrail']['destination_port'], & node['papertrail']['destination_protocol']

Type: String (destination_host & destination_protocol) Type: Integer (destination_port)

The Papertrail host and port to send logs to, and the protocol to use. These are required. Destination and port default to empty, while Protocol defaults to tls.

Example: ruby node['papertrail']['destination_host'] = '' node['papertrail']['destination_port'] = XXXXX node['papertrail']['destination_protocol'] = 'tls'

  • node['papertrail']['new_file_check_interval']

Type: Integer

Overrides the default file check interval.

Example: ruby node['papertrail']['new_file_check_interval'] = 30

  • node['papertrail']['severity']

Overrides the default remote_syslog2 severity level.

Example: ruby node['papertrail']['severity'] = 'warn'

  • node['papertrail']['facility']

Overrides the default remote_syslog2 facility.

Example: ruby node['papertrail']['facility'] = 'local7'

  • node['papertrail']['version']

Type: String

Use a different version of remote_syslog than the default.

Example: ruby node['papertrail']['version'] = '0.18'


See [](


See [](

License and Authors

License: See [LICENSE](

Author: Mike Julian (@mjulian)

Dependent cookbooks

apt >= 0.0.0
yum-epel >= 0.0.0
yum >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.


  • Add support for two new config options: facility and severity.
  • Minor bug fixes


Initial release of chef-papertrail

Collaborator Number Metric

1.1.1 failed this metric

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

Contributing File Metric

1.1.1 passed this metric

Foodcritic Metric

1.1.1 passed this metric

No Binaries Metric

1.1.1 passed this metric

Publish Metric

1.1.1 passed this metric

Supported Platforms Metric

1.1.1 passed this metric

Testing File Metric

1.1.1 passed this metric

Version Tag Metric

1.1.1 passed this metric