Puppet Enterprise metrics

You can use Puppet Enterprise (PE) metrics for your own performance tuning or provide them to Support for troubleshooting.

About the puppet_metrics_collector module

The puppet_metrics_collector module can collect metrics from the status endpoints of Puppet Enterprise (PE) services.

The puppet_metrics_collector module is installed with PE and is disabled by default.

Important: If you have a version of this module, from the Forge or other sources, specified in the code, you must remove this version before upgrading to allow the version bundled with PE to be asserted.
Two parameters control metrics collection:
  • puppet_enterprise::enable_metrics_collection: Collect metrics from PE services, such as Puppet Server and PuppetDB.
  • puppet_enterprise::enable_system_metrics_collection: Collect metrics from the operating system the PE services run on.

Visit the puppet_metrics_collector Forge page to learn about this module's other classes and features, such as retention time, collection frequency, and parameters for specific services.

You can use the puppet_metrics_dashboard module to view PE metrics.

Enable or disable metrics collection

The puppet_metrics_collector module is disabled by default, and you can manually configure the metrics collection parameters.

These parameters accept Boolean values.

  1. Set these parameters totrue to enable each category of metrics collection:
    • puppet_enterprise::enable_metrics_collection: Control metrics collection for Puppet Enterprise (PE) services.
    • puppet_enterprise::enable_system_metrics_collection: Control metrics collection for the operating system the PE services run on.
  2. Run Puppet: puppet agent -t
Results
Metrics collection is now enabled. To disable one or both streams of metrics collection, set either or both parameters to false and run Puppet.