sysstat
Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 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 < 9.0.0
- , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'qtechnologies-sysstat', '2.0.0'
Learn more about managing modules with a PuppetfileDocumentation
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::generate_summary: 'yes'
sysstat::disable: 'no'
Setting the disable
setting to 'yes'
will remove the cron entries or disable and stop sysstat-collect.timer, but will leave the package installed.
The generate_summary
option determines whether sa2 or sysstat-summary.timer (often called daily summary) will be active or not.
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.
Copyright 2016 Q-Technologies 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.