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

RSS

logentries_agent (8) Versions 0.2.7

Installs and configures the logentries agent

Berkshelf/Librarian
Policyfile
Knife
cookbook 'logentries_agent', '~> 0.2.7'
cookbook 'logentries_agent', '~> 0.2.7', :supermarket
knife cookbook site install logentries_agent
knife cookbook site download logentries_agent
README
Dependencies
Quality 44%

Logentries_agent Chef Cookbook

Installs/Configures the Logentries agent to allow logging to Logentries

Requirements

Platform:

  • Debian
  • Ubuntu
  • Rhel

Cookbooks:

The following are dependencies of the Logentries cookbook

  • apt
  • yum

Attributes

Default

  • node['le']['account_key'] - your Logentries account_key (this can be found following this link)
  • node['le']['data_bag_name'] - Name of a data bag containing account key.
  • node['le']['data_bag_item_name'] - Name of a data bag item containing account key.
  • node['le']['hostname'] - sets the hostname of the log to the machine name, defaults to node['hostname']
  • node['le']['logs_to_follow'] - An array of logs to follow or a hash of arrays
  • node['le']['datahub']['enable'] - To send logs to datahub set this to true. Default is false
  • node['le']['datahub']['server_ip'] - IP of your datahub server
  • node['le']['datahub']['port'] - port datahub is running on, normally port 10000
  • node['le']['pull-server-side-config'] - Specifies whether to make an api call to pull configuration or not, by default this is set to true meaning an api call will be made to logentries.com. Default is true
  • node['le']['deb'] - the distro of the debian platform , defaults to node['lsb']['codename'].

Notice: If node['le']['account_key'] is empty, then the chef will get account_key from the data bag.

Data bag

Example of a data bag:

{
  "id": "le",
  "account_key": "f8dbebcc-f907-41e1-9089-701134572b36"
}

Example of logs_to_follow

  • caveats - name needs to be unique

Usage

There are 3 main scenarios in which the Logentries Linux Agent can be run.

Default (no datahub and pull configuration from logentries.com)

override['le']['account_key'] = <logentries_account_key>
override['le']['logs_to_follow'] = ['/var/log/syslog']
override['le']['logs_to_follow'] = [{:name => 'syslog', :log => '/var/log/syslog'}]

This is the normal case where you send the data directly to Logentries and get the configuration for your logs from Logentries as well. To send data to logentries you will have to override node['le']['account_key']

Local configuration only

override['le']['pull-server-side-config'] = false
override['le']['logs_to_follow'] = [{:name => 'syslog', :log => '/var/log/syslog', :token => '00000000-0000-0000-0000-000000000000'}]

To send data to Logentries without specifying an account key, you can set override['le']['pull-server-side-config'] to false. This will only send the logs specified in the configuration file without contacting Logentries. In this case you have to create the logs in advance and know the tokens as well.

Datahub

override['le']['datahub']['enable'] = true
override['le']['pull-server-side-config'] = false
override['le']['datahub']['server_ip'] = '1.2.3.4'
override['le']['datahub']['port'] = 10000
override['le']['logs_to_follow'] = [{:name => 'syslog', :log => '/var/log/syslog'}]

This scenario is for datahub users looking to push a config and not need to register to send their logs to their datahub instance.

Usage

Put depends 'yum', and 'apt', in your metadata.rb to gain access to the resources.

Updating the Logentries Agent

Restarting the Chef script will allow the recipe to install any updates to the Logentries agent.

License and Author

Copyright (C) 2015, RevelOps Inc.

License:: All rights reserved

Dependent cookbooks

yum >= 0.0.0
apt >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric
            

0.2.7 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

0.2.7 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

0.2.7 failed this metric

FC052: Metadata uses the deprecated "suggests" keyword: logentries_agent/metadata.rb:21
FC066: Ensure chef_version is set in metadata: logentries_agent/metadata.rb:1
FC069: Ensure standardized license defined in metadata: logentries_agent/metadata.rb:1
FC070: Ensure supports metadata defines valid platforms: logentries_agent/metadata.rb:1
Run with Foodcritic Version 12.2.1 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

0.2.7 passed this metric

No Binaries Metric
            

0.2.7 passed this metric

Publish Metric
            

0.2.7 passed this metric

Supported Platforms Metric
            

0.2.7 passed this metric

Testing File Metric
            

0.2.7 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

0.2.7 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number