Snu-Sumologic Cookbook

An opinionated implementation of installation and configuration of the Sumo
Logic collector using the sumologic-collector cookbook.

Requirements

This cookbook requires at least Chef 12. It is tested against the two most
major Chef versions (currently 13.x and 12.x) and the two most recent Ubuntu
LTS (currently 16.04 and 14.04) and CentOS (currently 7.x and 6.x) releases.

It expects to find Sumo Logic API credentials in a data bag item named
sumologic within a data bag named credentials. That data bag item must
contain keys for both accessID and accessKey.

Usage

Add one or more of the included recipes to your run list and/or declare
instances of the included resources in your own recipes.

Recipes

default

• Runs the installation, configuration, and monitoring recipes.

installation

• Uses the snu_sumologic_collector resource to install the collector app, unconfigured, into /opt/SumoCollector.
• This recipe performs no configuration and is ideal for e.g. baking the Sumo collector into a base system image.

configuration

• Pulls Sumo Logic credentials out of the configured credentials data bag.
• Uses the snu_sumologic_collector resource to configure and start the collector that should have already been installed by the installation recipe.
• Uses a delayed action to, at the end of the Chef run, empty the sources directory of any files that are no longer in Chef's resource collection.

monitoring

• Ensures Sensu is installed and makes the sensu user a member of the Sumo group so it's able to monitor logs in /opt/SumoCollector.
• At some point in the future, this recipe will include configuring Sensu checks for the Sumo collector.

Attributes

default

The configuration recipe pulls Sumo credentials out of a data bag that is
configurable via two attributes:

default['sumologic']['credentials']['bag_name'] = 'credentials'
default['sumologic']['credentials']['item_name'] = 'sumologic'

An empty config hash is defined that can be overridden to pass any additional
properties to the snu_sumologic_collector resource in the configuration
recipe:

default['snu_sumologic']['config'] = {}

Resources

snu_sumologic_collector

A wrapper around the sumologic_collector resource to:

• Set some opinionated defaults based on our Sumo usage.
• Manage the configured Sumo sources directory.

Syntax:

snu_sumologic_collector 'default' do
  sumo_access_id 'abc123'
  sumo_access_key 'def456'
  action %i[configure enable start]
  delayed_action :manage
end

Actions:

* The :manage action should only be used as a delayed_action, otherwise
files it decides to delete will depend on the ordering of Chef's run
context.

Properties:

* All other properties are identical to those in the sumologic_collector
resource.

snu_sumo_source_local_file

A wrapper around the sumo_source_local_file resource to:

• Set some opinionated defaults based on our Sumo usage.
• Define an additional :delete action.

Syntax:

snu_sumo_source_local_file 'nginx' do
  path_expression '/var/log/nginx.log'
  action :create
end

Actions:

Properties:

* All other properties are identical to those in the sumo_source_local_file
resource.

Maintainers

• Jonathan Hartman jonathan.hartman@socrata.com
• Josh Oberwetter josh.oberwetter@socrata.com
• Justin Haynes justin.haynes@socrata.com
• Joe Nunnelley joe.nunnelley@socrata.com
• Noah Meyerhans noah.meyerhans@socrata.com
• John Krah john.krah@socrata.com
• Brian Oldfield brian.oldfield@socrata.com
• Andrew Gall andrew.gall@socrata.com
• Ele Mooney ele.mooney@socrata.com
• Ayn Leslie ayn.leslie@socrata.com
• Anothony Nowell anthony.nowell@socrata.com