AWS CloudWatch Logs Cookbook

Unofficial Chef Cookbook that install and configure AWS CloudWatch Logs Agent and deploy it's configurations automatically.

Usage

Add this cookbook to your base recipe:

cookbook 'aws-cloudwatchlogs', '~> 1.1.7'

You need to configure the following node attributes via an environment or role:

default_attributes(
   'aws_cwlogs' => {
      'region' => 'your_aws_region',
      'aws_access_key_id' => 'your_aws_access_key',
      'aws_secret_access_key' => 'your_aws_secret_key',
      'log' => {
         'syslog' => {
            'datetime_format' => '%b %d %H:%M:%S',
            'file' => '/var/log/syslog',
            'buffer_duration' => '5000',
            'log_stream_name' => '{instance_id}',
            'initial_position' => 'start_of_file',
            'log_group_name' => '/var/log/syslog'
         }
      }
   }
)

Or you can also configure by declaring it in another cookbook at a higher precedence level:

default['aws_cwlogs']['region'] = 'your_aws_region'
default['aws_cwlogs']['aws_access_key_id'] = 'your_aws_access_key'
default['aws_cwlogs']['aws_secret_access_key'] = 'your_aws_secret_key'
default['aws_cwlogs']['log']['syslog'] = {
   'datetime_format' => '%b %d %H:%M:%S',
   'file' => '/var/log/syslog',
   'buffer_duration' => '5000',
   'log_stream_name' => '{instance_id}',
   'initial_position' => 'start_of_file',
   'log_group_name' => '/var/log/syslog'
}

Note: If you do not specify aws credentials, it will attempt to use the AWS IAM Role assigned to the instance instead.

Once you defined the attributes, you will need to reference aws_cwlogs resource in your recipe:

include_recipe 'aws-cloudwatchlogs'

aws_cwlogs 'syslog' do
  log node['aws_cwlogs']['log']['syslog']
end

aws_cwlogs 'messages' do
  log node['aws_cwlogs']['log']['messages']
end

This will create a unique configuration file in AWS CloudWatch Logs that will be stored in etc/config directory.

Remember: You can configure as many logs as you need with log attribute.

Note: We are not making use of data_bags for AWS Credentials in this recipe at this time.

Example

Those attributes used before will generate the AWS CloudWatch Logs configuration below:

[syslog]
datetime_format = %b %d %H:%M:%S
file = /var/log/syslog
buffer_duration = 5000
log_stream_name = {instance_id}
initial_position = start_of_file
log_group_name = /var/log/syslog

For more deployment details about AWS CloudWatch Logs, please visit the AWS CloudWatch Logs Documentation.

Requirements

Platform

• Ubuntu 14.04

Attributes

See attributes/default.rb for default values.

Recipes

default

This recipe will check if all necessary requirements being met, and after that will call configure and install recipe.

configure

This recipe will prepare and configure all files required by AWS CloudWatch Logs.

install

This recipe will install AWS CloudWatch Logs Agent.

Changes

See CHANGELOG.md for more details.

License and Author

See LICENSE for more details.

Trademark

Amazon Web Services and AWS are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.