Choose the information that is collected by the support script in Puppet Enterprise

When you work with Support, we might ask you to gather troubleshooting information using the command puppet enterprise support.

The support script command gathers Puppet Enterprise configuration, logs, and other diagnostics, creating a single file that you can send to Support. You might want to change the information collected by the command if:

• Diagnostics take too long to run.
• The size of the output file is too large.
• A diagnostic collects information that you do not want to share with Support.
• Support asks for diagnostics that are not collected by default.

Version and installation information

PE version: All supported versions

Get more information about the basics of running and uploading the support script.

Solution

You can choose the information collected by the support script by passing options to it.

2019.8.12 and later 2019.8, and 2019.7 and later

In Puppet Enterprise 2019.8.12 and later 2019.8, and 2019.7 and later you can use wildcards to choose the information collected by the support script.

For example:

• To collect only Puppet Server information, run puppet enterprise support --only 'puppetserver*'

• To collect only logs and metrics for all services, run puppet enterprise support --only '*.logs,*.metrics'

Learn more about the support script.

All supported versions

Use these steps to view a list of support script diagnostics, choose support script diagnostics, and run the support script. To help you collect diagnostics, we’ve included some examples.

• To view a list of diagnostics collected by the support script, pass the --list option when running the command:

  puppet enterprise support --v3 --list

  Diagnostics that aren’t collected by default are listed as opt-in.

• To change the diagnostics collected and output by the support script, use the puppet enterprise support --v3 command with the following options. Each option accepts a comma-separated list of diagnostics printed by the --list option. The data collected by each diagnostic is described in our Getting Support documentation.

  Options

  These options turn diagnostics off:

  • --disable - The script does not collect and output requested diagnostics. The script collects and outputs other diagnostics.

  • --only - The support script collects and outputs only the requested diagnostics.

  This option turns diagnostics on:

  • --enable - The support script collects and outputs requested opt-in diagnostics in addition to other diagnostics.

Examples

• To gather a support script that does not include Puppet Server diagnostics, run:

  puppet enterprise support --v3 --disable puppetserver

• To gather a support script that only includes performance metrics for Puppet Server, PuppetDB, and the PE Orchestrator, run:

  puppet enterprise support --v3 --only puppetserver.metrics,puppetdb.metrics,pe.orchestrator.metrics

• To add classifier data to the diagnostics collected by the support script, run:

  puppet enterprise support --v3 --enable pe.console.classifier-groups