Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms


sumologic-collector (20) Versions 1.2.4

Installs/Configures sumologic-collector

cookbook 'sumologic-collector', '= 1.2.4'
cookbook 'sumologic-collector', '= 1.2.4', :supermarket
knife cookbook site install sumologic-collector
knife cookbook site download sumologic-collector

sumologic-collector Cookbook

This cookbook installs the Sumo Logic collector or updates an existing one if it was set to use Local Configuration Mangement. Installation on Linux uses the shell script installer and on Windows uses the exe installer. Here are the steps it follows:

  1. Sets up sumo.conf and sumo.json (or the json folder). By default the standard Linux logs (system and security) are captured. On Windows the application and system event logs are captured.
  2. Downloads latest installer
  3. Runs installer
  4. Starts collector and registers with the Sumo Logic service

For collector update, the existing collector must have been switched to use Local Configuration Mangement - see section Make the switch for more details. The steps the cookbook follows:

  1. Verify that the collector folder exists.
  2. (Optional) Recreate sumo.conf and sumo.json (or the json files under the json folder).
  3. Restart the collector for the changes to take effect.

The collector Requires outbound access to Edit sumo.json (or the json files under the json folder) to add/edit/remove sources. After installation you can test connectivity.


Starting from 19.107, there are 2 major extensions to SumoLogic collectors: * You can configure a collector's parameters from a set of json files under a common folder. Each of the json file will represent a source on that collector. Updates made to a json file will then be reflected on its corresponding source. Note that the format of this kind of file is slightly different from that of the traditional single json file (sumo.json) and they are not compatible. You also need to use the parameter syncSources instead of sources inside sumo.conf. See more details here. * You can change a collector's existing parameters through local configuration json file(s) continuously. Before this, using collector API was the only option. More information about this is here


  1. Create an Access Key
  2. 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
  3. Specify data bag and item with your access credentials. The data item should contain attributes accessID and accessKey. 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']
  4. (Optional) Decide if you want to use the Local Configuration Management feature by setting the attribute default['sumologic']['local_management'] properly. By default this feature is on, to leverage the power of Chef.
  5. (Optional) Select the json configuration option (i.e. through a single file or a folder) by setting the attribute default['sumologic']['use_json_path_dir'] appropriately. By default a single json file is used.
  6. (Optional) Check if the path to the json file or the json folder is set correctly in the attribute default['sumologic']['sumo_json_path']. By default this is the path to the json file at /etc/sumo.json on Linux or c:\sumo\sumo.json on Windows.
  7. Upload the cookbook to your Chef Server: knife cookbook upload sumologic-collector
  8. 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


<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>


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 (, Duc Ha (

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

CHANGELOG for sumologic-collector

This file is used to list changes made in each version of sumologic-collector.


  • Initial release of sumologic-collector


  • Updated cookbook to support Access IDs and Keys


  • Updated cookbook to support Local Collector Management and JSON directory option.

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.4 failed this metric

FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumoconf.rb:34
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumoconf.rb:35
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumoconf.rb:50
FC002: Avoid string interpolation where not required: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumojsondir.rb:31
FC007: Ensure recipe dependencies are reflected in cookbook metadata: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/install_proxy.rb:32
FC013: Use file_cache_path rather than hard-coding tmp paths: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/install_proxy.rb:51
FC019: Access node attributes in a consistent manner: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumoconf.rb:34
FC019: Access node attributes in a consistent manner: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumoconf.rb:35
FC019: Access node attributes in a consistent manner: /tmp/cook/cf95df172edd9fcaca16c9d0/sumologic-collector/recipes/sumoconf.rb:50