Enable and view the PuppetDB performance dashboard for Puppet Enterprise 3.3.2 to 2019.1

Using the following steps to enable and view the PuppetDB performance dashboard will help you adjust the Java heap size. The performance console shows performance information and metrics including JVM heap size, memory use, queue depth, command processing metrics, duplication rate, and query stats. It displays min/max/median of each metric over a configurable duration, as well as an animated SVG sparkline (a simple line chart).

Note: Links to our documentation are for Puppet Enterprise 2019.1. Make sure you've got the right version of our docs for your deployment.

Version and installation information

PE version: 3.3.2 to 2019.1

Solution

Note: If you enable cleartext HTTP with the following steps, you must configure your firewall to protect unverified access to PuppetDB. Unencrypted HTTP is the only way to view the performance dashboard, since PuppetDB uses host verification for SSL.

PE 2015.2 to 2019.1

To enable and view the performance dashboard:

1. Log into the console.

2. Select Nodes > Classification.

3. Select the PE PuppetDB node group.

4. Click the Classes tab.

5. Locate the puppet_enterprise::profile::puppetdb class, from the parameters drop-down list, select listen_address, and update the value to 0.0.0.0.

   Note: setting the listen_address to 0.0.0.0 allows all IP addresses to access the PuppetDB performance console.

6. Click Add parameter, and click the Commit changes button.

7. Log into your PuppetDB node as root. (On a monolithic installation, PuppetDB is on the master.)

8. Run puppet agent -t.

9. View the performance dashboard by navigating to http://<PuppetDB IP address>:<port>, replacing <PuppetDB IP address> with the IP address and <port> with the port of your PuppetDB node (8080 by default).

To disable the performance dashboard:

1. Log into the console.

2. Select Nodes > Classification.

3. Select the PE PuppetDB node group.

4. Click the Classes tab.

5. Locate the puppet_enterprise::profile::puppetdb class. Next to listen_address click Remove.

6. Click Commit changes.

PE 3.8 and PE 3.7

To enable and view the performance dashboard:

1. Log into the console.

2. Select Classification in the main navigation bar at the top of the page..

3. Select the PE PuppetDB node group.

4. Click the Classes tab.

5. Locate the puppet_enterprise::profile::puppetdb class, and from the parameters drop-down list, select listen_address, and update the value to 0.0.0.0.

6. Click Add parameter, and click the Commit changes button.

7. Log into your PuppetDB node as root. (On a monolithic installation, PuppetDB is on the master.)

8. Run puppet agent -t.

9. Navigate to http://<PuppetDB IP address:8080>/dashboard/index.html, replacing <PuppetDB IP address:8080> with the IP address and port of your PuppetDB node.

PE 3.3.2

To enable and view the performance dashboard:

1. Log into the console.

2. Select Nodes in the main navigation bar at the top of the page.

3. Select your PuppetDB node. (On a monolithic installation, PuppetDB is on the master.)

4. Click Edit.

5. Under Classes, locate the pe_puppetdb::pe class, and click Edit parameters.

6. Scroll down to the the listen_address parameter and update the value with the name of your node.

7. Click Done.

8. Log into the PuppetDB node as root.

9. Run puppet agent -t.

10. Navigate to http://<PuppetDB IP address:8080>/dashboard/index.html, replacing <PuppetDB IP address:8080> with the IP address and port of your PuppetDB node.