Browse files

FC011 Cleanup

This commit updates the cookbook to fix Foodcritic rule FC011:
Missing README in markdown format.
This commit also fixes parts of the README for change to markdown.
  • Loading branch information...
1 parent de88a24 commit f4189c00fa522e7c0d20127a79eaa3de864ea878 Paul Welch committed Sep 26, 2012
Showing with 57 additions and 53 deletions.
  1. +57 −0 README.md
  2. +0 −53 README.rdoc
View
57 README.md
@@ -0,0 +1,57 @@
+
+## DESCRIPTION:
+
+Cookbook to connect syslogging to [papertrailapp.com](https://papertrailapp.com/).
+
+## REQUIREMENTS:
+
+ * [rsyslog cookbook](http://community.opscode.com/cookbooks/rsyslog)
+
+## INSTALLATION
+
+The easiest way to install this is to use [knife-github-cookbooks](https://github.com/websterclay/knife-github-cookbooks):
+
+ gem install knife-github-cookbooks
+ knife github cookbook install librato/papertrail-cookbook
+
+## ATTRIBUTES:
+
+```ruby
+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 cert file..
+
+node['papertrail']['cert_url'] - URL to download certificate from.
+```
+
+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.
+
View
53 README.rdoc
@@ -1,53 +0,0 @@
-= DESCRIPTION:
-
-Cookbook to connect syslogging to papertrailapp.com.
-
-= REQUIREMENTS:
-
- * rsyslog cookbook
-
-= INSTALLATION
-
-The easiest way to install this is to use {knife-github-cookbooks}[https://github.com/websterclay/knife-github-cookbooks]:
-
- gem install knife-github-cookbooks
- knife github cookbook 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 cert file..
-
-node[:papertrail][:cert_url] - URL to download certificate from.
-
-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:
-
-Just include the default recipe.

0 comments on commit f4189c0

Please sign in to comment.