papertrail / papertrail-cookbook

Cookbook to setup logging to papertrailapp.com

DESCRIPTION:

Cookbook to connect syslogging to papertrailapp.com.

REQUIREMENTS:

• rsyslog cookbook

INSTALLATION

The easiest way to install this is to use knife-github-cookbooks:

gem install knife-github-cookbooks
knife cookbook github install librato/papertrail-cookbook

ATTRIBUTES:

node['papertrail']['logger']      - Logger to use. Support loggers include: rsyslog. Defaults to rsyslog.

node['papertrail']['remote_host'] - Papertrail host to send stats to. Defaults to 'logs.papertrailapp.com'.

node['papertrail']['remote_port'] - Port to use. No default.

node['papertrail']['cert_file']   - Where to store papertrail CA bundle. Defaults to '/etc/papertrail-bundle.pem'

node['papertrail']['cert_url']    - URL to download CA bundle from. Defaults to 'https://papertrailapp.com/tools/papertrail-bundle.pem'

node['papertrail']['resume_retry_count'] - Number of times to retry sending failed messages. Defaults to unlimited.

node['papertrail']['queue_disk_space'] - Maximum disk space for queues. Defaults to 100M.

node['papertrail']['queue_size'] - Maximum events to queue. Defaults to 100000.

node['papertrail']['queue_file_name'] - Name of the disk queue. Defaults to 'papertrailqueue'.

By default, this recipe will log to Papertrail using the system's hostname. If you want to set the hostname that will be used (think ephemeral cloud nodes) you can set one of the following. If either is set it will use the hostname_name first and the hostname_cmd second.

node['papertrail']['hostname_name'] - Set the logging hostname to this string.

node['papertrail']['hostname_cmd'] - Set the logging hostname to the output of this command passed to system(). This is useful if the desired hostname comes from a dynamic source like EC2 meta-data.

File monitoring is not really a part of papertrail but is included here:

node['papertrail']['watch_files'] - This is a hash of files and associated tags that will be configured to be watched and included in the papertrail logging. This is useful for including output from applications that aren't configured to use syslog. Example:

{
  '/var/log/chef/client.log'    => 'chef',
  '/var/log/something_else.log' => 'tag'
}

USAGE:

Include the default recipe in your chef run list.

papertrail-cookbook's Issues

Not in Supermarket?

At Hired we're setting up cookbooks following "the Berkshelf Way™," and have so far been able to specify dependencies in metadata.rb to be read by Berkshelf. However, this cookbook isn't on the Chef Supermarket, so we have to work around that. We haven't used knife-github-cookbooks and I always hesitate to introduce a new dependency, especially one that goes outside our normal workflow.

Any chance y'all could publish this? Thanks!

Anything chef-brigade can do to help?

Is there anything @chef-brigade can do to help out? We're probably going to start using this in our infra, so we want to keep it awesome.

If you need any administrative help, want a slack channel, website, testing infra &c, just let us know. It doesn't need to have the brigade name anywhere on it.

queue file name

Hi,
the default attribute for the queue file is '/var/log/rsyslog_queue_main'.
When starting rsyslog in debug mode one can see that rsyslog is appending the queue file name (in this case the full path) to the current working directory.
1905.236568347:7f5473892740: action 17 queue[DA]: .qi file name is '/var/spool/rsyslog//var/log/rsyslog_queue_main.qi', len 49

If I read http://www.rsyslog.com/doc/master/rainerscript/queue_parameters.html correctly, it should be a filename without path information.

queue.filename name File name to be used for the queue files. Please note that this is actually just the file name. A directory can NOT be specified in this paramter. If the files shall be created in a specific directory, specify queue.spoolDirectory for this. The filename is used to build to complete path for queue files.

Fix deprecated node[] set

[Fri, 07 Dec 2012 19:24:25 +0000] WARN: Setting attributes without specifying a precedence is deprecated and will be
removed in Chef 11.0. To set attributes at normal precedence, change code like:
node["key"] = "value" # Not this
to:
node.set["key"] = "value" # This

Called from:
/tmp/chef-solo/cookbooks/papertrail/recipes/default.rb:83:in `from_file'

No OSS License

Apache 2 is the standard for Chef cookbooks. Plz to add?