Forge Home

scribe_reporter

A report processor that sends whole Puppet reports to a Scribe log server.

8,713 downloads

8,463 latest version

4.5 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

  • 0.2.0 (latest)
  • 0.1.0
released Jul 14th 2015
This version is compatible with:
  • Puppet Enterprise 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, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 2.7.26

Start using this module

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

Add this module to your Puppetfile:

mod 'danzilio-scribe_reporter', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add danzilio-scribe_reporter
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install danzilio-scribe_reporter --version 0.2.0

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

danzilio/scribe_reporter — version 0.2.0 Jul 14th 2015

Puppet Forge Build Status Documentation Status

This is a report processor for Puppet that sends entire Puppet reports to a Scribe log server. This processor requires the scribe gem. This module also contains a scribe_reporter class to manage the configuration file and gem. This module depends on the report_all_the_things module.

This module uses the report_all_the_things module and sends the whole report. Most report processors only send the metrics or logs sections of a report. This sends everything: metrics, logs, resource_statuses, etc... This could potentially be a lot of data. The motivation behind the report_all_the_things module (which this module implements) was to get all of the data into an analytics platform and use those tools to analyze the data. Please take the time to understand the implications of this.

Requirements

  • puppet (this module is tested with 2.7 and up)
  • stdlib
  • scribe gem
  • report_all_the_things module
  • inifile module

Usage

To begin using the scribe_reporter module, you must pass the hosts parameter. The class expects a string or array of strings:

class { 'scribe_reporter':
  hosts => [ 'scribe1.example.com:1463', 'scribe2.example.com:1463' ]
}

This will do three main things:

  1. install the scribe gem
  2. place configuration file in $confdir/scribe.yaml (usually /etc/puppet/scribe.yaml or /etc/puppetlabs/scribe.yaml).
  3. add scribe as a report processor in puppet.conf

The report processor will be synced via pluginsync. Once Puppet has run with this module, it will begin to submit reports to Scribe.

If you don't wish to manage the reports setting in puppet.conf you can set manage_report_processor to false:

class { 'scribe_reporter':
  hosts => [ 'scribe1.example.com:1463', 'scribe2.example.com:1463' ],
  manage_report_processor => false,
}

If you're running in masterless mode, we need to configure the reports setting in the main section of puppet.conf instead of the master section. To do this you need to set the masterless parameter to true:

class { 'scribe_reporter':
  hosts      => [ 'scribe1.example.com:1463', 'scribe2.example.com:1463' ],
  masterless => true
}

If you don't want this module to manage the scribe gem, you can set the manage_package parameter to false:

class { 'scribe_reporter':
  hosts          => [ 'scribe1.example.com:1463', 'scribe2.example.com:1463' ],
  manage_package => false
}

If you choose to manage the scribe gem manually, don't forget to install it with the appropriate gem command before trying to send reports to Scribe.

gem install scribe

Development

  1. Fork it
  2. Create a feature branch
  3. Write a failing test
  4. Write the code to make that test pass
  5. Refactor the code
  6. Submit a pull request

We politely request (demand) tests for all new features. Pull requests that contain new features without a test will not be considered. If you need help, just ask!