cookbook 'sumologic-collector', '= 1.2.3'
sumologic-collector
(29) Versions
1.2.3
-
Follow15
Installs/Configures sumologic-collector
cookbook 'sumologic-collector', '= 1.2.3', :supermarket
knife supermarket install sumologic-collector
knife supermarket download sumologic-collector
sumologic-collector Cookbook
This cookbook installs the Sumo Logic collector. Linux installs use the shell script
installer and Windows uses the exe installer. Here are the steps it follows:
- Sets up
sumo.conf
andsumo.json
. By default the standard Linux logs are captured. On Windows the application and system event logs are captured. - Downloads latest installer
- Runs installer
- 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
- Create an Access Key
- Install the cookbook in your Chef repo (your knife version should be at least 11.10.4 and you should have the knife github plugin installed):
knife cookbook github install SumoLogic/sumologic-collector-chef-cookbook
Specify data bag and item with your access credentials. The data item should
contain attributesaccessID
andaccessKey
. Note that attribute names are case sensitive. If the cases mismatch, the values will not appear when chef-client runs. The default data bag/item is
['sumo-creds']['api-creds']
Upload the cookbook to your Chef Server:
knife cookbook upload sumologic-collector
- 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']['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)
CHANGELOG for sumologic-collector
This file is used to list changes made in each version of sumologic-collector.
0.1.0:
- Initial release of sumologic-collector
1.2.00:
- Updated cookbook to support Access IDs and Keys
Check the Markdown Syntax Guide for help with Markdown.
The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.
Foodcritic Metric
1.2.3 failed this metric
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:34
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:35
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:50
FC013: Use file_cache_path rather than hard-coding tmp paths: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/install_proxy.rb:51
FC019: Access node attributes in a consistent manner: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:34
FC019: Access node attributes in a consistent manner: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:35
FC019: Access node attributes in a consistent manner: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:50
1.2.3 failed this metric
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:35
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:50
FC013: Use file_cache_path rather than hard-coding tmp paths: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/install_proxy.rb:51
FC019: Access node attributes in a consistent manner: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:34
FC019: Access node attributes in a consistent manner: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:35
FC019: Access node attributes in a consistent manner: /tmp/cook/1114cd4c975f2fb5955a475c/sumologic-collector/recipes/sumoconf.rb:50