Version information
This version is compatible with:
- Puppet Enterprise 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
- Puppet >= 5.5.8 < 7.0.0
Start using this module
Add this module to your Puppetfile:
mod 'puppet-facette', '2.0.0'
Learn more about managing modules with a PuppetfileDocumentation
Facette
This module works only with Puppet 3.8.7 with the future parser enabled or Puppet 4.
Module description
Facette.io is time series data visualization and graphing software. This module installs and manages Facette for you.
Setup
What facette affects
- Facette APT PPA
- Configuration files
- Package/service/configuration for Facette
- Provider configuration
Beginning with facette
To have Facette installed and configured out of the box simply include the facette module:
include facette
This will set up Facette but not configure any providers meaning it will not be able to read any metrics just yet.
Usage
Adding providers
Defining providers registers data origins in Facette, i.e. where to find sources and their metrics, and how to add them to the catalog.
This is done by passing a hash to the providers
parameter. The key is the
name you want the configuration file to get on disk and the value should be
another hash with all the configuration options.
In order to get access to RRD data outputted by collectd:
class { 'facette':
providers => { 'collectd' => {
'connector' => {
'path' => '/var/lib/collectd/rrd',
'pattern' => '(?P<source>[^/]+)/(?P<metric>.+).rrd',
'type' => 'rrd',
}}},
}
Instead of passing it in through Puppet you can use Hiera instead:
facette::providers:
collectd:
connector:
path: '/var/lib/collectd/rrd'
pattern: '(?P<source>[^/]+)/(?P<metric>.+).rrd'
type: 'rrd'
This will result in /etc/facette/providers/collectd.json
to be created with
the following content:
{
"connector": {
"path": "/var/lib/collectd/rrd",
"pattern": "(?P<source>[^/]+)/(?P<metric>.+).rrd",
"type": "rrd"
}
}
Overriding facette configuration
By default a /etc/facette/facette.json
will be created with a number of
settings. If you wish to override one of these settings simply pass a hash
to the config
parameter.
class { 'facette':
config => { 'base_dir' => '/var' },
}
facette::config:
base_dir: '/var'
The available configuration options for Facette can be found in their documentation.
Controlling package and service state
This module will ensure the package is installed and that the Facette service
is running. You can however tweak this behaviour by alteering the state
parameter.
class { 'facette':
state => { 'package' => 'latest', 'service' => 'stopped' }
}
facette::state:
package: 'latest'
service: 'stopped'
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v2.0.0 (2019-04-30)
Breaking changes:
- modulesync 2.7.0 and drop puppet 4 #37 (bastelfreak)
Merged pull requests:
v1.1.2 (2018-10-20)
Merged pull requests:
- modulesync 2.1.0 and allow puppet 6.x #33 (bastelfreak)
v1.1.1 (2018-09-06)
Merged pull requests:
- allow puppetlabs/apt 6.x #31 (bastelfreak)
- allow puppetlabs/stdlib 5.x #29 (bastelfreak)
- add support for latest herculesteam/augeasproviders_shellvar and puppetlabs/apt #27 (bastelfreak)
- Remove docker nodesets #24 (bastelfreak)
- drop EOL OSs; fix puppet version range #23 (bastelfreak)
v1.1.0 (2017-11-17)
Merged pull requests:
- bump puppet version dependency to >= 4.7.1 \< 6.0.0 #18 (bastelfreak)
v1.0.0 (2017-02-13)
- Initial release
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>= 4.13.1 < 6.0.0)
- herculesteam/augeasproviders_shellvar (>= 2.2.1 < 4.0.0)
- puppetlabs/apt (>= 2.1.0 < 8.0.0)
Copyright 2015 Daniele Sluijters 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.