---
title: "PuppetDB: Maintaining and tuning"
layout: default
canonical: "/puppetdb/latest/maintain_and_tune.html"
---

[configure_jetty]: ./configure.html#jetty-http-settings
[configure_heap]: ./configure.html#configuring-the-java-heap-size
[threads]: ./configure.html#command-processing-settings
[memrec]: ./scaling_recommendations.html#bottleneck-java-heap-size
[puppetdb_report_processor]: ./connect_puppet_master.html#enabling-report-storage
[node_ttl]: ./configure.html#node-ttl
[report_ttl]: ./configure.html#report-ttl
[resources_type]: {{puppet}}/type.html#resources
[logback]: ./configure.html#the-logback-logging-config-file
[dashboard]: #monitor-the-performance-dashboard

PuppetDB requires a relatively small amount of maintenance and tuning. However, you should become familiar with the occasional tasks outlined in this guide.

## Monitor the performance dashboard

PuppetDB hosts a performance dashboard on port 8080, which listens only on
localhost by default. The usual way to access it is via an ssh tunnel. For
example,

    ssh -L 8080:localhost:8080 root@<puppetdb server>

and then visit `http://localhost:8080` in the browser. If PuppetDB is running
locally, or on a remote host that is listening for external cleartext
connections from your machine, you can skip the ssh tunnel and visit either
`http://localhost:8080` or `http://<puppetdb server>:8080` directly.

PuppetDB uses this page to display a web-based dashboard with performance information and metrics, including its 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 that shows general variation). It also displays the current version of PuppetDB and checks for updates, showing a link to the latest package if your deployment is out of date.

[![Screenshot of the performance dashboard](./images/perf-dash-small.png)](./images/perf-dash-large.png)

You can use the following URL parameters to change the attributes of the dashboard:

* `width`: width of each sparkline, in pixels
* `height`: height of each sparkline, in pixels
* `nHistorical`: how many historical data points to use in each sparkline
* `pollingInterval`: how often to poll PuppetDB for updates, in milliseconds

For example, `http://localhost:8080/pdb/dashboard/index.html?height=240&pollingInterval=1000`

## Deactivate or expire decommissioned nodes

When you remove a node from your Puppet deployment, it should be marked as **deactivated** in PuppetDB. This will ensure that any resources exported by that node will stop appearing in the catalogs served to the remaining agent nodes.

* PuppetDB can automatically mark nodes that haven't checked in recently as **expired**. Expiration is simply the automatic version of deactivation; the distinction is important only for record keeping. Expired nodes behave the same as deactivated nodes. By default, nodes are expired after 7 days of inactivity; to configure this, use the [`node-ttl` setting][node_ttl].
* If you prefer to manually deactivate nodes, use the following command on your puppet master:

        $ sudo puppet node deactivate <node> [<node> ...]
* Any deactivated or expired node will be reactivated if PuppetDB receives new catalogs or facts for it.

Although deactivated and expired nodes will be excluded from storeconfigs queries, their data is still preserved.

> **Note:** Deactivating a node does not remove (e.g. `ensure => absent`) exported resources from other systems; it only stops _managing_ those resources. If you want to actively destroy resources from deactivated nodes, you will need to purge that resource type by using the [`resources` metatype][resources_type]. Note that some types can't be purged, and several others (such as users) usually _shouldn't_ be purged.

## Clean up old reports

When the [PuppetDB report processor][puppetdb_report_processor] is enabled on your Puppet master, PuppetDB will retain reports for each node for a fixed amount of time. The default setting is 14 days, but this timeframe can be altered by using the [`report-ttl` setting][report_ttl]. Note that the larger the value you provide for this setting, the more history you will retain, and your database size will grow accordingly.

## Clean up the dead letter office

PuppetDB will react to certain types of processing failures by storing a complete copy of the offending input, along with retry timestamps and error traces, in the "dead letter office" (DLO). Over time, the DLO can grow quite large. If you're not actively troubleshooting an issue, you might be able to recover a significant amount of space by deleting the contents of the DLO. It can be found at under [PuppetDB's data directory](https://puppet.com/docs/puppetdb/latest/configure.html#vardir) at `stockpile/discard`, which by default is `/opt/puppetlabs/server/data/puppetdb/stockpile/discard`.

## View the log

PuppetDB's log file lives at `/var/log/puppetlabs/puppetdb/puppetdb.log`. Check the log when you need to confirm that PuppetDB is working correctly or to troubleshoot visible malfunctions. If you have changed the logging settings, examine the [logback.xml file][logback] to find the log.

The PuppetDB packages configure log file rotation via Logback in order to keep
log files from becoming too large.  The "logback.xml" file contains the rotation
parameters.  By default, the active log file is compressed into a .gz file if
it exceeds 200 MB in size.  At most 90 days and at most 1 GB of the most recent
.gz archives are preserved on disk.

## Tune the max heap size

Although we provide [rule-of-thumb memory recommendations][memrec], PuppetDB's RAM usage depends on several factors. Your memory needs will vary depending on the number of nodes, frequency of Puppet runs, and amount of managed resources. For instance, nodes that check in once a day will require significantly less memory than those that check in every 30 minutes.

The best way to manage PuppetDB's max heap size is to estimate a ballpark figure, then [monitor the performance dashboard][dashboard] and [increase the heap size][configure_heap] if the "JVM Heap" metric regularly approaches the maximum. You may need to revisit your memory needs whenever your site grows substantially.

The good news, however, is that memory starvation is actually not very destructive. It will cause `OutOfMemoryError` exceptions to appear in [the log](#view-the-log), but you can restart PuppetDB with a [larger memory allocation][configure_heap] and it'll pick up where it left off --- any requests successfully queued up in PuppetDB *will* get processed.

## Tune the number of threads

When viewing [the performance dashboard][dashboard], note the depth of the message queue (labeled "Command Queue depth"). If it is rising and you have CPU cores to spare, [increasing the number of threads][threads] may help to process the backlog more rapidly.

If you are saturating your CPU, we recommend [lowering the number of threads][threads].  This prevents other PuppetDB subsystems (such as the web server, or the MQ itself) from being starved of resources and can actually _increase_ throughput.

## Redo SSL setup after changing certificates

If you've recently changed the certificates in use by the PuppetDB server, you'll also need to update the SSL configuration for PuppetDB itself.

If you've installed PuppetDB from Puppet packages, you can simply re-run the
`puppetdb ssl-setup` command. Otherwise, you'll need to again perform the SSL
configuration steps outlined in
[the installation instructions](./install_from_source.html).
