Premium module

puppet_data_connector

pdk
premium
Data Connector for PE Advanced

1,036 downloads

2 latest version

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.1 (latest)
  • 1.0.0
released Jul 15th 2025
This version is compatible with:
  • Puppet Enterprise 2025.4.x, 2025.3.x, 2025.2.x, 2025.1.x, 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
  • AlmaLinux
    ,
    AmazonLinux
    ,
    OracleLinux
    ,
    RedHat
    ,
    RockyLinux
    ,
    SLES
    ,
    Ubuntu

Start using this module

This content is only available to subscribers

Log in to your account or contact sales to purchase access

Need help?
  • 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.1'
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.1

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.1 Jul 15th 2025

Observability Data Connector

Table of Contents

What is the Observability Data Connector module?

The Observability Data Connector module is a Prometheus metrics exporter for Puppet Enterprise Advanced. With the Observability Data Connector, you can export Puppet® transaction and report metrics in Prometheus format. In this way, you can track events in real time to identify and resolve possible issues and optimize the management of your infrastructure.

Important: This document includes references to a third-party product, Prometheus. The user interface and usage of third-party products are subject to change without notice. For the latest published information about Prometheus, see What is Prometheus?

Prerequisites

  • Puppet Enterprise® 2023.7.1 or later.
  • The Observability Data Connector, which is available to Puppet Enterprise Advanced customers as premium content on Puppet Forge. See puppet_data_connector.

Install and configure the Observability Data Connector

Before you can start using the module, you must install and configure it.

Install the module

Install the module by taking one of the following actions:

  • Run the following command: puppet module install puppetlabs-puppet_data_connector
  • Install the module by using Code Manager. For details, see Managing code with Code Manager.

Configure the module

You must classify the Observability Data Connector in the Puppet Enterprise (PE) console.

  1. In the PE console, navigate to Node groups and expand PE Infrastructure.
  2. Select the node group that you want to monitor and navigate to the Classes tab.
  3. Click Refresh to ensure that the puppet_data_connector class is loaded.
  4. Add a new class: puppet_data_connector.
  5. Under Parameter , specify the dropzone parameter to configure the drop zone for the metrics.
  6. Commit your changes and run Puppet on the node group.

Configure a filter for metrics (optional)

The Observability Data Connector can filter metrics to provide a concise view of your data. The filter is a blocklist.

Caution: Any filter parameter that you define removes data from the data set.

When you apply a filter, you can specify attributes from Puppet reports. For a list of attributes, see Report format. You can use the metric_filter parameter for top-level metrics, such as time, resources, events, and changes. You can use the events_filter and resources_filter parameters to specify the attributes listed for events and resources.

You can apply a filter by using a code block, as shown in the following example:

class { 'puppet_data_connector':
  dropzone         => '/opt/puppetlabs/puppet/prometheus_dropzone',
  metric_filter    => [“changes”, “events”],
  events_filter    => [“success”],
  resources_filter => [“failed”],
}

However, to streamline the process, apply the filter in the Puppet Enterprise console, as shown in this example:

filtering

Set the exporter port (optional)

The default port for the Observability Data Connector exporter is 9100. However, you can specify any valid port number.

To set the port number, add the puppet_data_connector::prometheus_exporter::port parameter to the configuration data for the primary server and the compilers configured with the puppet_data_connector class.

In the following example, an exporter port of 9500 is set:

alt_port

For detailed instructions about using the Puppet Enterprise console for classification, see Grouping and classifying nodes).

Run the module

The Observability Data Connector runs automatically during catalog compilation, and the latest data is generated in Prometheus format.

You can also manually start the module by running the following command:

puppet agent -t

Test the module

You can test the module by accessing a URL that includes the fully qualified domain name for Puppet Enterprise and the port. The HTTP GET method then returns raw metrics.

Specify the URL as shown in the following example, where 9100 is the port, and <puppet_enterprise_fqdn> must be replaced with the fully qualified domain name:

http://<puppet_enterprise_fqdn>:9100/metrics

Troubleshooting and support

If the Observability Data Connector does not work as expected, the cause might be network issues or incorrectly configured Prometheus related collectors. For troubleshooting and support tips, see the following sections.

Verify the module installation

Ensure that the module is correctly installed in your module path. Run the following command:

puppet module list

Detect network and configuration issues

The configured port must be visible on the network.

Review log files

All logging information for the Observability Data Connector can be found in the following file:

/var/log/puppetlabs/puppetserver/puppetserver.log

Request support

Puppet offers two types of support: Premium and Standard. The details vary based on the purchased support package. For a detailed description of the Premium and Standard service-level agreements, see Puppet, Inc. Support and Maintenance Services Terms.

This module is licensed for Puppet Enterprise Advanced.


© 2024 Puppet, Inc., a Perforce company. All rights reserved.

Puppet and other identified trademarks are the property of Puppet, Inc., Perforce Software, Inc., or an affiliate. Such trademarks are claimed and/or registered in the U.S. and other countries and regions. All third-party trademarks are the property of their respective holders. References to third-party trademarks do not imply endorsement or sponsorship of any products or services by the trademark holder. Contact Puppet, Inc., for further details.