sumologic-collector Cookbook

This cookbook installs the Sumo Logic collector on Linux using the shell script
installer. Here are the steps it follows:

1. Sets up sumo.conf and sumo.json with standard Linux logs
2. Downloads latest installer
3. Runs installer
4. Starts collector and registers with the Sumo Logic service

The collector Requires outbound access to https://collectors.sumologic.com.
Edit sumo.json to add/edit/remove sources. After installation you can
test connectivity.

Installation

1. Create an Access Key
2. Install the cookbook in your Chef repo:

knife cookbook github install SumoLogic/sumologic-collector-chef-cookbook

1. Specify data bag and item with your access credentials. The data item should
   contain attributes accessID and accessKey. The default data bag/item is
   ['sumo-creds']['api-creds']

2. Upload the cookbook to your Chef Server:

knife cookbook upload sumologic-collector

1. Add the sumologic-collector receipe to your node run lists. This step depends on your node configuration, so specifics will not be described in this README.md.

Attributes

<table>
<tr>
<td>['sumologic']['ephemeral']</td>
<td>Boolean</td>
<td>Sumo Logic Ephemeral Setting</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['sources']['default_timezone']</td>
<td>String</td>
<td>Timezone for source setup (defaults to UTC)</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['installDir'] </td>
<td>String</td>
<td>Sumo Logic Install Directory</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['ephemeral']</td>
<td>Boolean</td>
<td>Sumo Logic Ephemeral Setting</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['sources']['default_timezone']</td>
<td>String</td>
<td>Timezone for source setup (defaults to UTC)</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['installDir'] </td>
<td>String</td>
<td>Sumo Logic Install Directory</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['credentials']['bag_name']</td>
<td>String</td>
<td>Name of the data bag.</td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['credentials']['item_name']</td>
<td>String</td>
<td>Name of the item within the data bag. </td>
<td>Required</td>
</tr>
<tr>
<td>['sumologic']['credentials']['secret_file']</td>
<td>String</td>
<td>Path to the local file containing the encryption secret key.</td>
<td>Optional</td>
</tr>
</table>

Contributing

This cookbook is meant to help customers use Chef to install Sumo Logic
collectors, so please feel to fork this repository, and make whatever changes
you need for your environment.

License and Authors

Authors:
Ben Newton (ben@sumologic.com)