Forge Home

sysstat

Puppet module to manage the installation and configuration of Sysstat on various OSes

32,651 downloads

311 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.2.6 (latest)
  • 1.2.5
  • 1.2.4
  • 1.2.3
  • 1.2.2
  • 1.2.0
  • 1.1.1
  • 1.1.0
  • 1.0.2
  • 1.0.1
released Jul 11th 2022
This version is compatible with:
  • Puppet Enterprise 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 8.0.0
  • , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'qtechnologies-sysstat', '1.2.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add qtechnologies-sysstat
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install qtechnologies-sysstat --version 1.2.6

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

qtechnologies/sysstat — version 1.2.6 Jul 11th 2022

puppet-sysstat

Puppet module to manage the installation and configuration of Sysstat on various OSes.

This module will install the sysstat package, update the sysstat crontab file and the main sysstat configuration file. It has reasonable defaults, but the defaults can be overidden through hiera.

Instructions

Call the class from your code, e.g. class { 'sysstat': } or include 'sysstat'. All the values specified for Hiera below can also be inserted as parameters to the module if you prefer not to use Hiera directly.

Optionally put the following variables into hiera and adjust to your requirements. The values listed below are the defaults.

  sysstat::sa1_options: "-S ALL"
  # interval is in minutes - how often to launch sa1
  sysstat::sa1_interval: 2
  # duration is in minutes - how to run sa1 each time
  sysstat::sa1_duration: 2
  # samples - how many samples to take while running
  sysstat::sa1_samples: 1
  sysstat::sa2_options: "-A"
  sysstat::sa2_hour: '23'
  sysstat::sa2_minute: '53'
  sysstat::history: 10
  # compressafter is in days
  sysstat::compressafter: 31
  sysstat::sadc_options: "-S DISK"
  sysstat::zip: "bzip2"
  sysstat::installpkg: 'yes'
  sysstat::generate_summary: 'yes'
  sysstat::disable: 'no'

Setting the disable setting to 'yes' will remove the cron entries, but leave the package installed.

The generate_summary option determines whether or not sa2 is active (often called daily summary).

Limitations

The sa1 invocation duration needs to a minute or greater. If sub minute sample sizes are required, set the sa1_samples parameter to greater than 1 to take multiple samples per invocation of sa1.

Platform Notes

Suse

On Suse based systems, the defaults for these parameters are different to match how it ships:

  sysstat::sa2_hour: '5,11,17,23'
  sysstat::sa2_minute: '55'

Debian\Ubuntu

Debian based systems normally use the cron.daily to run the summary reports. This Puppet module will convert this behavior to align with the Red Hat way. Let me know if this creates any issues for anyone and it can be made into an option or better still create a pull request adding the functionality.

AIX

AIX assumes the sysstat package will be installed as part of the initial OS install, so this module does not provide the ability to install the package otherwise.

Development

If you would like to contribute to or comment on this module, please do so at it's Github repository. Thanks.