Forge Home


Provides Tasks to capture data for healthcheck lite


6,668 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

  • 1.0.0 (latest)
released Mar 20th 2019
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, 2017.3.x
  • Puppet >= 5.3.2 < 7.0.0
  • , , , , ,
This module has been deprecated by its author since Apr 7th 2020.

The author has suggested puppetlabs-pe_tech_check as its replacement.

  • collect
  • configure

Start using this module


puppetlabs/healthcheck_lite — version 1.0.0 Mar 20th 2019


Table of Contents

  1. Description
  2. Setup - Installation and preparations
  3. Using healthcheck_lite
  4. Development - Guide for contributing to the module


This module collects Puppet Enterprise data for analysis as part of the HealthCheck Lite service offering. The majority of the data is collected by the Puppet Enterprise Support Script.


Install the healthcheck_lite module

To install the healthcheck_lite module, execute the following command on the Primary Master.

puppet module install puppetlabs-healthcheck_lite --modulepath=/opt/puppetlabs/puppet/modules

Doing so will install this module into the base module path, making its tasks available without interfering with other modules.

Enable the healthcheck_lite module tasks

If your Primary Master has environment caching enabled (which is true by default if Code Manager is being used), flush the environment cache to enable the tasks in this module.

Run the following command on the Primary Master:



Run the healthcheck_lite::configure task

In the Console, run the healthcheck_lite::configure task, targeting the Primary Master.

Or, from the command line of the Primary Master, run:

puppet task run healthcheck_lite::configure --nodes $(facter -p certname)

Task parameters

install_pe_metrics (Boolean, default: true)

Temporarily install and configure the puppet_metrics_collector module, if it is not already installed.

install_pe_tune (Boolean, default: true)

Temporarily install the puppet pe tune subcommand via the pe_tune module. The pe_tune module is the upstream version of the puppet infrastructure tune subcommand.

Note Allow at least one day after executing the healthcheck_lite::configure task for the puppet_metrics_collector module to collect metrics data before executing the healthcheck_lite::collect task.

Run the healthcheck_lite::collect task

In the Console, run the healthcheck_lite::collect task, targeting the Primary Master.

Or, from the command line of the Primary Master, run:

puppet task run healthcheck_lite::collect --nodes $(facter -p certname)

When finished, the healthcheck_lite::collect task will output a list of files. Upload those files from the Primary Master to Puppet for analysis.


This module is developed and maintained by the Puppet Enterprise Support and Technical Sales teams.