Puppet icon

Puppet

Puppet

Plugin: go.d.plugin Module: puppet

Overview

This collector monitors Puppet metrics, including JVM heap and non-heap memory, CPU usage, and file descriptors.

It uses Puppet’s metrics API endpoint /status/v1/services to gather the metrics.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

By default, it detects Puppet instances running on localhost that are listening on port 8140. On startup, it tries to collect metrics from:

  • https://127.0.0.1:8140

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/puppet.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/puppet.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Name Description Default Required
url The base URL where the Puppet instance can be accessed. https://127.0.0.1:8140 yes
timeout HTTPS request timeout. 1 no
username Username for basic HTTPS authentication. no
password Password for basic HTTPS authentication. no
proxy_url Proxy URL. no
proxy_username Username for proxy basic HTTPS authentication. no
proxy_password Password for proxy basic HTTPS authentication. no
method HTTPS request method. POST no
body HTTPS request body. no
headers HTTPS request headers. no
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. no no
tls_skip_verify Server certificate chain and hostname validation policy. Controls whether the client performs this check. no no
tls_ca Certification authority that the client uses when verifying the server’s certificates. no
tls_cert Client TLS certificate. no
tls_key Client TLS key. no

Examples

Basic with self-signed certificate

Puppet with self-signed TLS certificate.

jobs:
  - name: local
    url: https://127.0.0.1:8140
    tls_skip_verify: yes

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

jobs:
  - name: local
    url: https://127.0.0.1:8140
    tls_skip_verify: yes

  - name: remote
    url: https://192.0.2.1:8140
    tls_skip_verify: yes

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Puppet instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric Dimensions Unit
puppet.jvm_heap committed, used MiB
puppet.jvm_nonheap committed, used MiB
puppet.cpu execution, GC percentage
puppet.fdopen used descriptors

Alerts

There are no alerts configured by default for this integration.

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the puppet collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn’t working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that’s not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
    
  • Switch to the netdata user.

    sudo -u netdata -s
    
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m puppet
    

Getting Logs

If you’re encountering problems with the puppet collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep puppet

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:

grep puppet /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:

docker logs netdata 2>&1 | grep puppet

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo