https://github.com/rapid7/le_chef
https://github.com/rapid7/le_chef
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rapid7/le_chef
- Owner: rapid7
- Archived: true
- Created: 2011-09-12T12:00:49.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T08:53:22.000Z (over 1 year ago)
- Last Synced: 2025-03-22T08:13:06.589Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 59.6 KB
- Stars: 20
- Watchers: 59
- Forks: 34
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Logentries_agent Chef Cookbook
==============
Installs/Configures the Logentries agent to allow logging to [Logentries](https://logentries.com)
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](https://logentries.com/doc/accountkey/))
* `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 an array of hashes
* `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:
```json
{
"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)
```ruby
override['le']['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
```ruby
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
```ruby
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
------------------
* Author:: Joe Heung ()
Copyright (C) 2015, RevelOps Inc.
License:: All rights reserved