About the puppet_metrics_collector module

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

The puppet_metrics_collector module is installed with PE and is partially enabled by default.

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.

The following two parameters control metrics collection:

puppet_enterprise::enable_metrics_collection

A Boolean specifying whether the primary server collects metrics from PE services, such as Puppet Server and PuppetDB .

Default: true

puppet_enterprise::enable_system_metrics_collection

A Boolean specifying whether your infrastructure nodes collect metrics from the operating system your PE services run on. To allow the collection of system metrics, sysstat must be installed and enabled on your operating system.

Default: false

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_operational_dashboards module to view PE metrics.

You can also use APIs or our Splunk plugin to View and manage Puppet Server metrics.