cloudwatchlogs
Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- Amazon, Ubuntu, RedHat, CentOS
This module has been deprecated by its author since Jul 22nd 2021.
Start using this module
Documentation
cloudwatchlogs
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with cloudwatchlogs
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module installs, configures and manages the service for the AWS Cloudwatch Logs Agent on Amazon Linux, Ubuntu, Red Hat & CentOS EC2 instances.
Module Description
CloudWatch Logs can be used to monitor your logs for specific phrases, values, or patterns. For example, you could set an alarm on the number of errors that occur in your system logs or view graphs of web request latencies from your application logs. You can view the original log data to see the source of the problem if needed. Log data can be stored and accessed for as long as you need using highly durable, low-cost storage so you don’t have to worry about filling up hard drives.
Setup
What cloudwatchlogs affects
- The
awslogs
package. - Configuration files under
/etc/awslogs
. - The
awslogs
service.
Setup Requirements
This module does NOT manage the AWS CLI credentials. As such if you are not using an IAM role (recommended) then you will need some other way of managing the credentials.
This module by Justin Downing is recommended for this purpose.
Beginning with cloudwatchlogs
The minimum you need to get this module up and running is (assuming your instance is launched with a suitable IAM role):
include '::cloudwatchlogs'
Usage
The above minimal config can also be presented as:
class { '::cloudwatchlogs': }
On none Amazon Linux instances you also need to provide a default region:
class { '::cloudwatchlogs': region => 'eu-west-1' }
For each log you want sent to Cloudwatch Logs you create a cloudwatchlogs::log
resource.
A simple example that might be used on the RedHat ::osfamily is:
class { '::cloudwatchlogs': region => 'eu-west-1' }
cloudwatchlogs::log { 'Messages':
path => '/var/log/messages',
}
cloudwatchlogs::log { 'Secure':
path => '/var/log/secure',
}
See the examples/ directory for further examples.
Reference
cloudwatchlogs
state_file
:
Defaults:
- Amazon Linux:
/var/lib/awslogs/agent-state
- Other:
/var/awslogs/state/agent-state
State file for the awslogs agent.
region
:
Default: undef
The region your EC2 instance is running in.
NOTE: This is required for none Amazon distros.
cloudwatchlogs::log
path
Default: undef
Optional. This is the absolute path to the log file being managed. If not set the name of the resource is used instead (and must be an absolute path if that this situation occurs).
streamname
Default: {instance_id}
The name of the stream in Cloudwatch Logs.
datetime_format
Default: %b %d %H:%M:%S
Specifies how the timestamp is extracted from logs. See the official docs for further info.
Http Proxy Usage
If you have a http_proxy or https_proxy then run the following puppet code after calling cloudwatchlogs to modify the launcher script as a workaround bcause awslogs python code currently doesn't have http_proxy support:
$launcher = "#!/bin/sh
# Version: 1.3.5
echo -n $$ > /var/awslogs/state/awslogs.pid
/usr/bin/env -i AWS_CONFIG_FILE=/var/awslogs/etc/awscli.conf HOME=\$HOME HTTPS_PROXY=${http_proxy} HTTP_PROXY=${http_proxy} NO_PROXY=169.254.169.254 /bin/nice -n 4 /var/awslogs/bin/aws logs push --config-file /var/awslogs/etc/awslogs.conf >> /var/log/awslogs.log 2>&1
"
file { '/var/awslogs/bin/awslogs-agent-launcher.sh':
ensure => file,
owner => root,
group => root,
mode => '0755',
content => $launcher,
require => Class['cloudwatchlogs'],
}
Limitations
This module is currently only compatible with:
- Amazon Linux AMI 2014.09 or later.
- Ubuntu
- Red Hat
- CentOS
More information on support as well as information in general about the set-up of the Cloudwatch Logs agent can be found here.
Development
Contributions are welcome via pull requests.
Contributors
Authors:
All other contributions: https://github.com/kemra102/puppet-cloudwatchlogs/graphs/contributors
v0.1.0:
- Initial release, supports Amazon Linux only.
v1.0.0:
- Added support for Ubuntu, RHEL & CentOS via python package.
v0.1.0:
- Made 'region', 'aws_access_key_id' & 'aws_secret_access_key' optional for people who launch instances with an IAM role.
- Added 'streamname' variable.
v1.1.2:
- Fixed default stream name.
- Only install 'wget' package if not defined else where in catalogue.
v2.0.0:
- Moved to using concat for each log file entry. This allows use of more customizable entries more easily down the road.
- Removed management of AWS CLI keys, this should be done by mdoules designed for this purpose.
- Documented usage of using a http_proxy on instances that might require it.
- Provided examples of IAM role for Cloudwatch Logs & of various ways to specify log entries.
Dependencies
- puppetlabs-stdlib (>= 3.2.0)
- puppetlabs-concat (>= 1.1.0)
Copyright (c) 2015, Danny Roberts & Russ McKendrick All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.