Premium module

puppet_data_connector

Data Connector for PE Advanced

365 downloads

365 latest version

3.1 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.

The Observability Data Connector is a premium feature for Puppet Enterprise Advanced

Empower your teams with faster access to data. The Observability Data Connector helps you understand and improve your systems by collecting and exporting data to your existing observability tools like Grafana, Prometheus, or Splunk plus many more

Version information

  • 1.0.0 (latest)
released Sep 20th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
  • Puppet >= 7.24 < 9.0.0
  • , , , , , ,

Start using this module

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

To install using r10k or Code Manager, follow these steps:

  1. Generate an API token using the button Create a new key at the bottom of your profile and put it in your r10k.yaml file. Find out more here.
  2. Add this module to your Puppetfile:
mod 'puppetlabs-puppet_data_connector', '1.0.0'
Learn more about managing modules with a Puppetfile

To install using bolt, follow these steps:

  1. Generate an API token using the button Create a new key at the bottom of your profile and put it in your bolt-project.yaml file. Find out more here.
  2. Add this module to your Bolt project:
bolt module add puppetlabs-puppet_data_connector
Learn more about using this module with an existing project

To install using manual installation, follow these steps:

  1. Generate an API token using the button Create a new key at the bottom of your profile and put it in your puppet.conf file. Find out more here.
  2. Manually install this module globally with Puppet module tool:
puppet module install puppetlabs-puppet_data_connector --version 1.0.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

puppetlabs/puppet_data_connector — version 1.0.0 Sep 20th 2024

puppetlabs-puppet_data_connector

Table of Contents

Intro

This module installs a custom report processor to export Puppet Report metric data into the Prometheus metric format. It also configures the puppet_data_exporter.service, which runs a node_exporter to expose the metric data for ingestion by Prometheus.

Compatible PE Versions

This module is compatible with PE versions >= 2023.7.1.

Usage

  1. Install the module in your environment.

  2. Classify your Puppet Servers with the puppet_data_connector class. Set the dropzone parameter, which refers to the directory location where the Prometheus metric data files will be created.

    • Optional: Configure the filter parameters.
    • Optional: Configure the puppet_data_connector::prometheus_exporter::port parameter in your hiera data to run the exporter on an alternate port.
      • Default Port: 9100.

    Example:

     class { "puppet_data_connector":
      dropzone => "/opt/puppetlabs/puppet/puppet_data_connector",
     }
    
  3. Run puppet to compile the catalog. Puppet Server will restart during the run and metric data will begin collecting on the next run.

  4. Confirm the data is available on http://$PE_SERVER_FQDN:9100/metrics.

Filtering and Troubleshooting

Filtering is a block list. Adding a filter will remove the data from the data set.

  class { "puppet_data_connector":
    dropzone => "/opt/puppetlabs/puppet/puppet_data_connector",
    metric_filter => ["events","time"], # optional
    events_filter => ["success"], # optional
  }

This example will NOT show "events" or "time" for metrics. It will also not show successes for the events.