sous-chefs / Logrotate
Programming Languages
Projects that are alternatives of or similar to Logrotate
logrotate Cookbook
Manages the logrotate package and provides a resource to manage application specific logrotate configuration.
Maintainers
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.
Requirements
Platforms
Should work on any platform that includes a 'logrotate' package and writes logrotate configuration to /etc/logrotate.d.
Tested on:
- Ubuntu / Debian
- CentOS
- Amazon Linux
- openSUSE Leap
Chef
- Chef 12.5+
Cookbooks
- none
Recipes
global
Generates and controls a global /etc/logrotate.conf
file that will include additional files generated by the logrotate_app
resource (see below). The contents of the configuration file is controlled through node attributes under node['logrotate']['global']
. The default attributes are based on the configuration from the Ubuntu logrotate package.
To define a valueless directive (e.g. compress
, copy
) simply add an attribute named for the directive with a truthy value:
node['logrotate']['global']['compress'] = 'any value here'
Note that defining a valueless directive with a falsey value will not make it false, but will remove it:
# Removes a defaulted 'compress' directive; does not add a 'nocompress' directive.
node.override['logrotate']['global']['compress'] = false
To fully override a booleanish directive like compress
, you should probably remove the positive form and add the negative form:
node.override['logrotate']['global']['compress'] = false
node.override['logrotate']['global']['nocompress'] = true
The same is true of frequency directives; to be certain the frequency directive you want is included in the global configuration, you should override the ones you don't want as false:
%w[ daily weekly yearly ].each do |freq|
node.override['logrotate']['global'][freq] = false
end
node.override['logrotate']['global']['monthly'] = true
To define a parameter with a value (e.g. create
, mail
) add an attribute with the desired value:
node['logrotate']['global']['create'] = '0644 root adm'
To define a path stanza in the global configuration (generally unneeded because of the logrotate_app
resource) just add an attribute with the path as the name and a hash containing directives and parameters as described above:
node['logrotate']['global']['/var/log/wtmp'] = {
'missingok' => true,
'monthly' => true,
'create' => '0660 root utmp',
'rotate' => 1
}
firstaction
, prerotate
, postrotate
, and lastaction
scripts can be defined either as arrays of the lines to put in the script or multiline strings:
node['logrotate']['global']['/var/log/foo/*.log'] = {
'missingok' => true,
'monthly' => true,
'create' => '0660 root adm',
'rotate' => 1,
'prerotate' => ['service foo start_rotate', 'logger started foo service log rotation'],
'postrotate' => <<-EOF
service foo end_rotate
logger completed foo service log rotation
EOF
}
Resources
logrotate_app
This resource can be used to drop off customized logrotate config files on a per application basis.
The resource takes the following properties:
-
path
: specifies a single path (string) or multiple paths (array) that should have logrotation stanzas created in the config file. No default, this must be specified. -
cookbook
: The cookbook that continues the template for logrotate_app config resources. By default this islogrotate
. Users can provide their own template by setting this attribute to point at a different cookbook. -
template_name
: sets the template source, default is "logrotate.erb". -
template_mode
: the mode to create the logrotate template with (default: "0644") -
template_owner
: the owner of the logrotate template (default: "root") -
template_group
: the group of the logrotate template (default: "root") -
frequency
: sets the frequency for rotation. Default value is 'weekly'. Valid values are: hourly, daily, weekly, monthly, yearly, see the logrotate man page for more information. Note that usually logrotate is configured to be run by cron daily. You have to change this configuration and run logrotate hourly to be able to really rotate logs hourly. Hourly rotation requires logrotate v3.8.5 or higher. -
options
: Any logrotate configuration option that doesn't specify a value. See the logrotate(8) manual page of v3.9.2 or earlier for details.
In addition to these properties, any logrotate option that takes a parameter can be used as a logrotate_app property. For example, to set the rotate
option you can use a resource declaration such as:
logrotate_app 'tomcat-myapp' do
path '/var/log/tomcat/myapp.log'
frequency 'daily'
rotate 30
create '644 root adm'
end
Also, any logrotate option that takes one of scripts names (firstaction
, prerotate
, postrotate
, and lastaction
) can be used. Script body should be passed as value of this option. For example, nginx logrotation with postrotate
:
logrotate_app 'nginx' do
path '/var/log/nginx/*.log'
frequency 'daily'
options %w(missingok compress delaycompress notifempty dateext dateyesterday nomail sharedscripts)
rotate 365
create '640 www-data www-data'
dateformat '.%Y-%m-%d'
maxage 365
postrotate '[ ! -f /var/run/nginx.pid ] || kill -USR1 `cat /var/run/nginx.pid`'
end
See the logrotate(8) manual page of v3.9.2 or earlier for the list of available options.
Usage
The default recipe will ensure logrotate is always up to date.
To create application specific logrotate configs, use the logrotate_app
resource. For example, to rotate logs for a tomcat application named myapp that writes its log file to /var/log/tomcat/myapp.log
:
logrotate_app 'tomcat-myapp' do
path '/var/log/tomcat/myapp.log'
frequency 'daily'
rotate 30
create '644 root adm'
end
To rotate multiple logfile paths, specify the path as an array:
logrotate_app 'tomcat-myapp' do
path ['/var/log/tomcat/myapp.log', '/opt/local/tomcat/catalina.out']
frequency 'daily'
create '644 root adm'
rotate 7
end
To specify which logrotate options, specify the options as an array:
logrotate_app 'tomcat-myapp' do
path '/var/log/tomcat/myapp.log'
options ['missingok', 'delaycompress', 'notifempty']
frequency 'daily'
rotate 30
create '644 root adm'
end
Contributors
This project exists thanks to all the people who contribute.
Backers
Thank you to all our backers!
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.