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

rsyslog (38) Versions 6.0.2

Installs and configures rsyslog

Berkshelf/Librarian
Policyfile
Knife
cookbook 'rsyslog', '~> 6.0.2'
cookbook 'rsyslog', '~> 6.0.2', :supermarket
knife cookbook site install rsyslog
knife cookbook site download rsyslog
README
Dependencies
Changelog
Quality 100%

rsyslog Cookbook

Build Status Cookbook Version

Installs and configures rsyslog to replace syslogd for client and/or server use. By default, the service will be configured to log to files on local disk. See the Recipes and Examples sections for other uses.

Requirements

Platforms

  • Debian/Ubuntu
  • RHEL/CentOS/Scientific/Amazon/Oracle
  • Fedora
  • OmniOS
  • OpenSUSE

Chef

  • Chef 12.5 +

Other

To use the recipe[rsyslog::client] recipe, you'll need to set up the rsyslog.server_search or rsyslog.server_ip attributes. See the Recipes and Examples sections below.

Attributes

See attributes/default.rb for default values.

  • node['rsyslog']['log_dir'] - If the node is an rsyslog server, this specifies the directory where the logs should be stored.
  • node['rsyslog']['working_dir'] - The temporary working directory where messages are buffered
  • node['rsyslog']['server'] - Determined automatically and set to true on the server.
  • node['rsyslog']['server_ip'] - If not defined then search will be used to determine rsyslog server. Default is nil. This can be a string or an array.
  • node['rsyslog']['server_search'] - Specify the criteria for the server search operation. Default is role:loghost.
  • node['rsyslog']['protocol'] - Specify whether to use udp or tcp for remote loghost. Default is tcp. To use both specify both in a string e.g. 'udptcp'.
  • node['rsyslog']['bind'] - Specify the address to which the server should be listening; only use with node['rsyslog']['protocol'] = 'udp' because the feature does not work with the tcp protocol (more info).
  • node['rsyslog']['port'] - Specify the port which rsyslog should connect to a remote loghost.
  • node['rsyslog']['remote_logs'] - Specify whether to send all logs to a remote server (client option). Default is true.
  • node['rsyslog']['per_host_dir'] - "PerHost" directories for template statements in 35-server-per-host.conf. Default value is the previous cookbook version's value, to preserve compatibility. See server recipe below.
  • node['rsyslog']['priv_seperation'] - Whether to use privilege separation or not.
  • node['rsyslog']['priv_user'] - User to run as when using privilege separation. Defult is node['rsyslog']['user']
  • node['rsyslog']['priv_group'] - Group to run as when using privilege separation. Defult is node['rsyslog']['group']
  • node['rsyslog']['max_message_size'] - Specify the maximum allowed message size. Default is 2k.
  • node['rsyslog']['user'] - Who should own the configuration files and directories
  • node['rsyslog']['group'] - Who should group-own the configuration files and directories
  • node['rsyslog']['dir_owner'] - Who should own the log directories
  • node['rsyslog']['dir_group'] - Who should group-own the log directories
  • node['rsyslog']['file_create_mode'] - Mode that should be set when creating log files
  • node['rsyslog']['dir_create_mode'] - Mode that should be set when creating log directories
  • node['rsyslog']['umask'] - Specify the processes umask
  • node['rsyslog']['defaults_file'] - The full path to the defaults/sysconfig file for the service.
  • node['rsyslog']['package_name'] - Specify rsyslog package name
  • node['rsyslog']['service_name'] - The platform-specific name of the service
  • node['rsyslog']['preserve_fqdn'] - Value of the $PreserveFQDN configuration directive in /etc/rsyslog.conf. Default is 'off' for compatibility purposes.
  • node['rsyslog']['high_precision_timestamps'] - Enable high precision timestamps, instead of the "old style" format. Default is 'false'.
  • node['rsyslog']['repeated_msg_reduction'] - Value of $RepeatedMsgReduction configuration directive in /etc/rsyslog.conf. Default is 'on'
  • node['rsyslog']['logs_to_forward'] - Specifies what logs should be sent to the remote rsyslog server. Default is all ( . ).
  • node['rsyslog']['default_log_dir'] - log directory used in 50-default.conf template, defaults to /var/log
  • node['rsyslog']['default_facility_logs'] - Hash containing log facilities and destinations used in 50-default.conf template.
  • node['rsyslog']['default_file_template'] - The name of a pre-defined log format template (ie - RSYSLOG_FileFormat), used for local log files.
  • node['rsyslog']['default_remote_template'] - The name of a pre-defined log format template (ie - RSYSLOG_FileFormat), used for sending to remote servers.
  • node['rsyslog']['templates'] - Allows a user to specify a dynamic filename and the format of the logs
  • node['rsyslog']['rate_limit_interval'] - Value of the $SystemLogRateLimitInterval configuration directive in /etc/rsyslog.conf. Default is nil, leaving it to the platform default.
  • node['rsyslog']['rate_limit_burst'] - Value of the $SystemLogRateLimitBurst configuration directive in /etc/rsyslog.conf. Default is nil, leaving it to the platform default.
  • node['rsyslog']['action_queue_max_disk_space'] - Max amount of disk space the disk-assisted queue is allowed to use (more info).
  • node['rsyslog']['enable_tls'] - Whether or not to enable TLS encryption. When enabled, forces protocol to tcp. Default is false.
  • node['rsyslog']['tls_ca_file'] - Path to TLS CA file. Required for both server and clients.
  • node['rsyslog']['tls_certificate_file'] - Path to TLS certificate file. Required for server, optional for clients.
  • node['rsyslog']['tls_key_file'] - Path to TLS key file. Required for server, optional for clients.
  • node['rsyslog']['tls_auth_mode'] - Value for $InputTCPServerStreamDriverAuthMode/$ActionSendStreamDriverAuthMode, determines whether client certs are validated. Defaults to anon (no validation).
  • node['rsyslog']['tls_permitted_peer'] - Value for ActionSendStreamDriverPermittedPeer, it narrows the list of the allowed hosts. Works with TLS only. Defaults to nil.
  • node['rsyslog']['use_local_ipv4'] - Whether or not to make use the remote local IPv4 address on cloud systems when searching for servers (where available). Default is 'false'.
  • node['rsyslog']['allow_non_local'] - Whether or not to allow non-local messages. If 'false', incoming messages are only allowed from 127.0.0.1. Default is 'false'.
  • node['rsyslog']['custom_remote'] - Array of hashes for configuring custom remote server targets
  • node['rsyslog']['additional_directives'] - Hash of additional directives and their values to place in the main rsyslog config file
  • node['rsyslog']['local_host_name'] - permits to overwrite the system hostname with the one specified in the directive

Recipes

default

Installs the rsyslog package, manages the rsyslog service and sets up basic configuration for a standalone machine.

client

Includes recipe[rsyslog].

Uses node['rsyslog']['server_ip'] or Chef search (in that precedence order) to determine the remote syslog server's IP address. If search is used, the search query will look for the first ipaddress returned from the criteria specified in node['rsyslog']['server_search'].

You can use node['rsyslog']['custom_config'] to define custom entries for sending logs to remote servers. Available attributes:

    'server': Ip/hostname of remote syslog server (Required)
    'port': Port to send logs to
    'logs': Syslog log facilities to send (auth, authpriv, daemon, etc)
    'protocol': Can be tcp or udp
    'remote_template': Rsyslog template used for the messages

Example:

node['rsyslog']['custom_remote'] = [{ 'server' => '10.10.4.4', 'port' => '567', 'logs' => 'auth.*,mail.*', 'protocol' => 'udp', 'remote_template' => 'RSYSLOG_SyslogProtocol23Format'},
                                    { 'server' => '10.0.0.3', 'port' => '555', 'logs' => 'authpriv,daemon.*' } ]

The server key is required; if other keys are left out, the default global values will be used (eg node['rsyslog']['port'] will be used if 'port' is omitted)

If the node itself is a rsyslog server ie it has rsyslog.server set to true then the configuration is skipped.

If the node had an /etc/rsyslog.d/35-server-per-host.conf file previously configured, this file gets removed to prevent duplicate logging.

Any previous logs are not cleaned up from the log_dir.

server

Configures the node to be a rsyslog server. The chosen rsyslog server node should be defined in the server_ip attribute or resolvable by the specified search criteria specified in node['rsyslog']['server_search] (so that nodes making use of the client recipe can find the server to log to).

The server recipe will create the logs in attribute node['rsyslog']['log_dir'], and the configuration in /etc/rsyslog.d/server.conf. This recipe also removes any previous configuration to a remote server by removing the file /etc/rsyslog.d/49-remote.conf.

The cron job used in the previous version of this cookbook is removed, but it does not remove any existing cron job from your system (so it doesn't break anything unexpectedly). We recommend setting up logrotate for the logfiles instead.

The log_dir will be concatenated with per_host_dir to store the logs for each client. Modify the attribute to have a value that is allowed by rsyslogs template matching values, see the rsyslog documentation for this.

Directory structure:

<%= @log_dir %>/<%= @per_host_dir %>/"logfile"

For example for the system with hostname www:

/srv/rsyslog/2011/11/19/www/messages

For example, to change this to just the hostname, set the attribute node['rsyslog']['per_host_dir'] via a role:

"rsyslog" => { "per_host_dir" => "%HOSTNAME%" }

At this time, the server can only listen on UDP or TCP.

Resources

file_input

Configures a text file input monitor to push a log file into rsyslog. Rsyslog must be installed to use this custom resource either using your own wrapper cookbook or the rsyslog::default recipe

Properties:

  • name: name of the resource, also used for the syslog tag. Required.
  • file: file path for input file to monitor. Required.
  • priority: config order priority. Defaults to 99.
  • severity: syslog severity. Must be one of emergency, alert,
  • critical, error, warning, notice, info or debug. If
  • undefined, rsyslog interprets this as notice.
  • facility: syslog facility. Must be one of auth, authpriv,
  • daemon, cron, ftp, lpr, kern, mail, news, syslog,
  • user, uucp, local0, ... , local7. If undefined, rsyslog
  • interprets this as local0.
  • cookbook_source: cookbook containing the template. Defaults to rsyslog.
  • template_source: template file source. Defaults to file-input.conf.erb

Usage

Use recipe[rsyslog] to install and start rsyslog as a basic configured service for standalone systems.

Use recipe[rsyslog::client] to have nodes log to a remote server (which is found via the server_ip attribute or by the recipe's search call -- see client)

Use recipe[rsyslog::server] to set up a rsyslog server. It will listen on node['rsyslog']['port'] protocol node['rsyslog']['protocol'].

If you set up a different kind of centralized loghost (syslog-ng, graylog2, logstash, etc), you can still send log messages to it as long as the port and protocol match up with the server software. See Examples

Use rsyslog_file_input within your recipes to forward log files to your remote syslog server.

Examples

A base role (e.g., roles/base.rb), applied to all nodes so they are syslog clients:

name "base"
description "Base role applied to all nodes
run_list("recipe[rsyslog::client]")

Then, a role for the loghost (should only be one):

name "loghost"
description "Central syslog server"
run_list("recipe[rsyslog::server]")

By default this will set up the clients search for a node with the loghost role to talk to the server on TCP port 514. Change the protocol and port rsyslog attributes to modify this.

If you want to specify another syslog compatible server with a role other than loghost, simply fill free to use the server_ip attribute or the server_search attribute.

Example role that sets the per host directory:

name "loghost"
description "Central syslog server"
run_list("recipe[rsyslog::server]")
default_attributes(
  "rsyslog" => { "per_host_dir" => "%HOSTNAME%" }
)

Default rsyslog options are rendered for RHEL family platforms, in /etc/rsyslog.d/50-default.conf with other platforms using a configuration like Debian family defaults. You can override these log facilities and destinations using the rsyslog['default_facility_logs'] hash.

name "facility_log_example"
run_list("recipe[rsyslog::default]")
default_attributes(
  "rsyslog" => {
    "default_facility_logs" => {
      '*.info;mail.none;authpriv.none;cron.none' => "/var/log/messages",
      'authpriv' => '/var/log/secure',
      'mail.*' => '-/var/log/maillog',
      '*.emerg' => '*'
    }
  }
)

License & Authors

Copyright:: 2009-2017, Chef Software, Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

al_agents Applicable Versions
alphard-chef-loggly Applicable Versions
bluepill Applicable Versions
deis Applicable Versions
elkstack Applicable Versions
logentries-rsyslog Applicable Versions
loggly-rsyslog Applicable Versions
loggly_rsyslog_ng Applicable Versions
mw_server_base Applicable Versions
papertrail-rsyslog Applicable Versions
paramount Applicable Versions
platformstack Applicable Versions
spartan_loggly_rsyslog Applicable Versions
sumologic-syslog Applicable Versions

rsyslog Cookbook CHANGELOG

This file is used to list changes made in each version of the rsyslog cookbook.

6.0.2 (2017-07-04)

  • Updating README to reflect current Chef software version dependency and remove compat_resource cookbook dependency.
  • Update kitchen configs and use delivery local mode instead of Rake
  • Don’t fail parsing metadata.rb on older chef clients
  • Simplify Travis config and fix ChefDK 2.0 failures
  • Let permissions of template resources be configured through attributes
  • Fix CHEF-19 - Add prefix new_resource to several properties

6.0.1 (2017-02-28)

  • Fix Issue #126 multiple remote server configuration template which requires $ActionQueueFileName to be different for each remote server

6.0.0 (2017-02-23)

  • Require Chef 12.5+ and remove dependency on compat_resource

5.1.0 (2016-12-30)

  • Removed empty value from default custom_remote in attributes
  • don't break if custom_remote is not set
  • adding ability to override more options
  • adding ability to set multiple log templates

5.0.1 (2016-12-06)

  • Remove support for Ubuntu 10.04
  • Simplify logic in the attributes file around Fedora
  • Fix comment headers to be yard compatible

5.0.0 (2016-11-14)

  • Make rsyslog only restart once if you define multiple file_input resources.
  • Remove debugging log statement
  • Require chef 12.1
  • Require compat_resource 12.10+
  • Remove chef 11 compat
  • Remove support for arch
  • Depend on the recent compat_resource cookbook

v.4.0.1 (2016-07-20)

  • PR #76 Validate the config file using rsyslogd -N 1 via eherot
  • PR #105 Use correct file name for remote.conf via mfenner
  • PR #105 Add $LocalHostName directive via mfenner
  • PR #105 Change directive :fromhost-ip,!isequal,"127.0.0.1" from using ~ to stop via mfenner
  • PR #110 Add support for permitted peer via dastergon
  • Add SUSE support
  • Clean up travis configuration

v.4.0.0 (2015-12-09)

  • Removed support for Chef Solo. Since this cookbook now supports Chef 12+ only it makes far more sense to use Chef Zero (local mode) if a Chef server is not available.
  • Removed yum from the Berksfile as it wasn't being used
  • Fixed bad variables being passed in the file_input custom resource
  • Added Chefspec matchers

v.3.0.0 (2015-11-09)

  • Breaking change: The file_input LWRP has been updated to be a Chef 12.5 custom_resource, with backwards compatibility to all Chef 12.x released provided by compat_resource. Additionally the 'source' and 'cookbook' attributes in the file_input resource have been renamed to 'template_source' and 'cookbook_source' to prevent failures.
  • Helpers for determining the service provider on Ubuntu have been removed since Chef 12 does the right thing with Init, Upstart, and systemd.
  • rsyslog::client no longer fails if there are no servers to forward logs to. Instead forwarding isn't configuring and a warning is written to the chef client log
  • Fix broken templating of /etc/rsyslog.d/49-remote.conf when relp was enabled. Added testing to prevent future regressions here.
  • Test Kitchen integration tests are now run via Travis so all PRs will be fully tested

v.2.2.0 (2015-10-05)

  • Add why-run support to the file_input LWRP
  • Added support for rsyslog under systemd on Ubuntu 15.04+
  • Added new attribute node['rsyslog']['custom_remote']. See readme for additional information
  • Added source_url and issues_url metadata for Supermarket
  • Fixed 49-relp.conf to honor logs_to_forward so it didn't just forward everything
  • Updated contributing and testing docs
  • Set the minimum supported Chef release to 11.0
  • Added maintainers.toml and maintainers.md files
  • Added Amazon Linux, Oracle, and Scientific Linux to the metadata
  • Removed all pre-Ruby 1.9 hash rockets
  • Updated development dependencies in the
  • Fix a bad example attribute in the readme
  • Updated Travis CI config to test on all modern Ruby releases

v.2.1.0 (2015-07-22)

  • Fixed minor markdown errors in the readme
  • Allow the server to listen on both TCP and UDP. For both set node['rsyslog']['protocol'] to 'udptcp'
  • Move the include for /etc/rsyslog.d/ to the very end of the rsyslog.conf config
  • Added the ability to bind to a specific IP when running the server on UDP with node['rsyslog']['bind']
  • Sync the comments in the rsyslog.conf file with the latest upstream rsyslog release
  • Change emerg to log to :omusrmsg: vs. on modern rsyslog releases to avoid deprecation warnings

v.2.0.0 (2015-05-18)

Note: This version includes several breaking changes for Ubuntu users. Be sure to take care when deploying these changes to production systems.

  • 49-relp.conf now properly uses the list of servers discovered in the client recipe
  • Fixed a typo that prevented file-input.conf from properly templating
  • Added allow_non_local attribute to allow non-local messages. This defaults to false, which preserves the previous functionality
  • The rsyslog directory permissions are now properly set using the user/group attributes instead of root/root
  • Properly drop permissions on Ubuntu systems to syslog/syslog. Introduces 2 new attributes to control the user/group: priv_user and priv_group
  • Remove logging to /dev/xconsole in 50-default.conf on Ubuntu systems. This is generally not something you'd want to do and produces error messages at startup.

v.1.15.0 (2015-02-23)

  • Change minimum supported Fedora release to 20 to align with the Fedora product lifecycle
  • Add supports CentOS to metadata
  • Update Rubocop and Test Kitchen dependencies to the latest versions
  • Update Chefspec to 4.0
  • Fix CentOS 5 support in the Kitchen config
  • Fix rsyslog service notification in the file_input LWRP

v.1.14.0 (2015-01-30)

  • Don't attempt to use journald on Amazon Linux since Amazon Linux doesn't use systemd
  • Fixed setting bad permissions on the working directory by using the rsyslog user/group variables.
  • Fixed bad variable in the 49-relp.conf template that prevented Chef converges from completing.
  • Removed the 'reload' action from the rsyslog service as newer rsyslog releases don't support reload.
  • Updated Chefspecs to remove deprecation warnings and added additional tests.
  • Removed node name from the comment block in the config files.
  • Added a new file_input LWRP for defining configs.
  • Added support for chef solo search cookbook.

v1.13.0 (2014-11-25)

  • Rsyslog's working directory is now an attribute and is set to the appropriate directory on RHEL based distros
  • The working directory is now 0700 vs 0755 for additional security
  • Add the ActionQueueMaxDiskSpace directive with a default of 1GB to prevent out of disk events during large buffering
  • Updated RHEL / Fedora facilities to match those shipped by the distros
  • Updated modules to match those used by journald (systemd) on Fedora 19+ and CentOS 7
  • Added an attribute additional_directives to pass a hash of configs. This is currently only being used to pass directives necessary for journald support on RHEL 7 / Fedora 19+
  • Added basic SUSE support
  • Fixed logic that prevented Ubuntu from properly dropping privileges in Ubuntu >= 11.04
  • Removed references to rsyslog v3 in the config template
  • Added a chefignore file
  • Updated Gemfile with newer releases of Test Kitchen, Rubocop, and Berkshelf
  • Added Fedora 20, Debian 6/7, CentOS 7, and Ubuntu 12.04/14.04 to the Test Kitchen config
  • Removed an attribute that was in the Readme twice
  • Updated Travis to Ruby 2.1.1 to better match Chef 12
  • Updated the Berksfile to point to Supermarket
  • Refactored the specs to be more dry

v1.12.2 (2014-02-28)

Fixing bug fix in rsyslog.conf

v1.12.0 (2014-02-27)

  • [COOK-4021] Allow specifying default templates for local and remote
  • [COOK-4126] rsyslog cookbook fails restarts due to not using upstart

v1.11.0 (2014-02-19)

Bug

  • COOK-4256 - Fix syntax errors in default.conf on rhel

New Feature

  • COOK-4022 - Add use_local_ipv4 option to allow selecting internal interface on cloud systems
  • COOK-4018 - rsyslog TLS encryption support

v1.10.2

No change. Version bump for toolchain.

v1.10.0

New Feature

  • COOK-4021 - Allow specifying default templates for local and remote

Improvement

v1.9.0

New Feature

Improvement

  • COOK-3609 - Add actionqueue to remote rsyslog configurations

Bug

v1.8.0

Improvement

  • COOK-3573 - Add Test Kitchen, Specs, and Travis CI

New Feature

v1.7.0

Improvement

  • COOK-3253 - Enable repeated message reduction
  • COOK-3190 - Allow specifying which logs to send to remote server
  • COOK-2355 - Support forwarding events to more than one server

v1.6.0

New Feature

  • [COOK-2831]: enable high precision timestamps

Bug

  • [COOK-2377]: calling node.save has adverse affects on nodes relying on a searched node's ohai attributes
  • [COOK-2521]: rsyslog cookbook incorrectly sets directory ownership to rsyslog user
  • [COOK-2540]: Syslogd needs to be disabled before starting rsyslogd on RHEL 5

Improvement

  • [COOK-2356]: rsyslog service supports status. Service should use it.
  • [COOK-2357]: rsyslog cookbook copies in wrong defaults file on Ubuntu !9.10/10.04

v1.5.0

  • [COOK-2141] - Add $PreserveFQDN configuration directive

v1.4.0

  • [COOK-1877] - RHEL 6 support and refactoring

v1.3.0

  • [COOK-1189] - template change does not restart rsyslog on Ubuntu

This actually went into 1.2.0 with action :reload, but that change has been reverted and the action is back to :restart.

v1.2.0

  • [COOK-1678] - syslog user does not exist on debian 6.0 and ubuntu versions lower than 11.04
  • [COOK-1650] - enable max message size configuration via attribute

v1.1.0

Changes from COOK-1167:

  • More versatile server discovery - use the IP as an attribute, or use search (see README)
  • Removed cron dependency.
  • Removed log archival; logrotate is recommended.
  • Add an attribute to select the per-host directory in the log dir
  • Works with Chef Solo now.
  • Set debian/ubuntu default user and group. Drop privileges to syslog.adm.

v1.0.0

  • [COOK-836] - use an attribute to specify the role to search for instead of relying on the rsyslog['server'] attribute.
  • Clean up attribute usage to use strings instead of symbols.
  • Update this README.
  • Better handling for chef-solo.

Collaborator Number Metric
            

6.0.2 passed this metric

Contributing File Metric
            

6.0.2 passed this metric

Foodcritic Metric
            

6.0.2 passed this metric

License Metric
            

6.0.2 passed this metric

No Binaries Metric
            

6.0.2 passed this metric

Publish Metric
            

6.0.2 passed this metric

Supported Platforms Metric
            

6.0.2 passed this metric

Testing File Metric
            

6.0.2 passed this metric

Version Tag Metric
            

6.0.2 passed this metric