Forge Home

pe_status_check

A Puppet Enterprise Module to Promote Preventative Maintenance and Self Service

8,979 downloads

205 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.5.1 (latest)
  • 2.5.0
  • 2.4.1
  • 2.4.0
  • 2.3.1
  • 2.3.0
  • 2.2.0
  • 2.1.1
  • 2.1.0
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.5.0
  • 1.4.0
  • 1.3.0
  • 1.2.0
  • 1.1.0
  • 1.0.0
released Nov 10th 2022
This version is compatible with:
  • Puppet Enterprise 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.16.0 < 8.0.0
  • , , , , , , , ,
Plans:
  • agent_summary
  • infra_summary

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-pe_status_check', '2.5.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-pe_status_check
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-pe_status_check --version 2.5.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/pe_status_check — version 2.5.1 Nov 10th 2022

puppetlabs-pe_status_check

Description

puppetlabs-pe_status_check provides a way to alert the end-user when Puppet Enterprise is not in an ideal state. It uses pre-set indicators and has a simplified output that directs the end-user to the next steps for resolution.

Users of the tool have a greater ability to provide their own self-service resolutions and shorter incident resolution times with Puppet Support due to higher quality information available to our team.

Setup

What pe_status_check affects

This module installs two structured facts named pe_status_check and agent_status_check. Each fact contains an array of key pairs that output an indicator ID and a Boolean value. The pe_status_check fact is confined to only Puppet Enterprise infrastructure agents, and the agent_status_check fact is confined to non-infrastructure agent nodes.

Setup requirements

Install the module, plug-in sync will be used to deliver the required facts for this module, to each agent node in the environment the module is installed in.

Beginning with pe_status_check

This module primarily provides indicators using facts, so installing the module and allowing plug-in sync to occur lets the module start functioning. Collection of the agent_status_check fact is disabled by default so as not to affect all puppet agents indiscriminately

Usage

The facts in this module can be directly consumed by monitoring tools such as Splunk, any element in the structured facts pe_status_check or agent_status_check reporting as false indicates a fault state in Puppet Enterprise. When any element reports as false, look up the incident ID in the reference section for next steps.

Alternatively, assigning the class pe_status_check to the infrastructure notifies on each Puppet run if any indicator is reporting as false, this can be viewed in the Puppet report for each node.

Enabling agent_status_check

By default your normal agent population will not collect the agent_status_check fact, this can be enabled for all agents or a subset of agents, by classifying pe_status_check::agent_status_enable to your nodes.

Disabling agent_status_check

Following the addition of the class pe_status_check::agent_status_enable to an agent node, disable the collection of agent_status_check fact, set the following parameter:

pe_status_check::agent_status_enable::agent_status_enabled = false

Reporting Options

Class declaration pe_status_check (optional)

To activate the notification functions of this module, classify your Puppet Infrastructure with the pe_status_check class using your preferred classification method. Below is an example using site.pp.

node 'node.example.com' {
  include pe_status_check
}

For maximum coverage, report on all default indicators. However, if you need to make exceptions for your environment, classify the array parameter indicator_exclusions with a list of all the indicators you do not want to report on.

This workflow is not available for the agent_status_check fact.

class { 'pe_status_check':
  indicator_exclusions             => ['S0001','S0003','S0003','S0004'],
}

Ad-hoc Report (Plans)

The plans, pe_status_check::infra_summary and pe_status_check::agent_summary summarize the status of each of the checks on target nodes that have the pe_status_check or agent_status_check fact respectively, sample output can be seen below:

{
    "nodes": {
        "details": {
            "pe-psql-70aefa-0.region-a.domain.com": {
                "failed_tests_count": 0,
                "passing_tests_count": 13,
                "failed_tests_details": []
            },
            "pe-server-70aefa-0.region-a.domain.com": {
                "failed_tests_count": 1,
                "passing_tests_count": 30,
                "failed_tests_details": [
                    "S0022 Determines if there is a valid Puppet Enterprise license in place at /etc/puppetlabs/license.key on your primary which is not going to expire in the next 90 days"
                ]
            },
            "pe-compiler-70aefa-0.region-a.domain.com": {
                "failed_tests_count": 0,
                "passing_tests_count": 23,
                "failed_tests_details": []
            },
            "pe-compiler-70aefa-1.region-b.domain.com": {
                "failed_tests_count": 0,
                "passing_tests_count": 23,
                "failed_tests_details": []
            }
        },
        "failing": [
            "pe-server-70aefa-0.region-a.domain.com"
        ],
        "passing": [
            "pe-compiler-70aefa-1.region-b.domain.com",
            "pe-compiler-70aefa-0.region-a.domain.com",
            "pe-psql-70aefa-0.region-a.domain.com"
        ]
    },
    "errors": {},
    "status": "failing",
    "failing_node_count": 1,
    "passing_node_count": 3
}

Using a Puppet Query to report status.

As the pe_status_check module uses Puppet's existing fact behavior to gather the status data from each of the agents, it is possible to use PQL (puppet query language) to gather this information.

Consult with your local Puppet administrator to construct a query suited to your organizational needs. Please find some examples of using pe_client_tools to query the status check facts below:

  1. To find the complete output of pe_status_check from all nodes listed by certname:

    puppet query 'facts[certname,value] { name = "pe_status_check" }'
    
  2. To find the complete output of agen_status_check from all nodes listed by certname (this could be a large query based on the number of agent nodes, further filtering is advised ):

    puppet query 'facts[certname,value] { name = "agent_status_check" }'
    
  3. To find those nodes with a specific status check set to false:

    puppet query 'inventory[certname] { facts.pe_status_check.S0001 = false }'
    

Setup Requirements

pe_status_check::infra_summary and pe_status_check::agent_summary utilize hiera to lookup test definitions, this requires placing a static hierarchy in your environment level hiera.yaml.

plan_hierarchy:
  - name: "Static data"
    path: "static.yaml"
    data_hash: yaml_data

See the following documentation for further explanation.

Running the plans

The pe_status_check::infra_summary and pe_status_check::agent_summary plans can be run from the PE console or from the command line. Below are some examples of running the plans from the command line. More information on the parameters in the plan can be seen in the REFERENCE.md.

Example call from the command line to run pe_status_check::infra_summary against all infrastructure nodes:

puppet plan run pe_status_check::infra_summary

Example call from the command line to run pe_status_check::agent_summary against all regular agent nodes:

puppet plan run pe_status_check::agent_summary

Example call from the command line to run against a set of infrastructure nodes:

puppet plan run pe_status_check::infra_summary targets=pe-server-70aefa-0.region-a.domain.com,pe-psql-70aefa-0.region-a.domain.com

Example call from the command line to exclude indicators for pe_status_check::infra_summary:

puppet plan run pe_status_check::infra_summary -p '{"indicator_exclusions": ["S0001","S0021"]}'

Example call from the command line to exclude indicators for pe_status_check::agent_summary:

puppet plan run pe_status_check::agent_summary -p '{"indicator_exclusions": ["AS001","AS002"]}'

Reference

Fact: pe_status_check_role

This fact is used to determine which individual status checks should be run on each individual infrastructure node. The fact queries which Puppet Enterprise Roles have been classified to each node and uses this to make the determination.

Role Description
primary The node is both a certificate authority and a postgres host
replica The node has the primary_master_replica role
pe_compiler The node has both the master and puppetdb roles
postgres The node has just the database role
legacy_compiler The node has the master role but not the puppetdb role
legacy_primary The node is a certificate authority but not a postgres host
unknown The node type could not be determined

A failure to determine node type will result in a safe subset of checks being run that will work on all infrastructure node types.

Fact: pe_status_check

This fact is confined to run on infrastructure nodes only.

Refer below for next steps when any indicator reports a false.

Indicator ID Description Self-service steps What to include in a Support ticket
S0001 Determines if the puppet service is running on agents. Starts the puppet service - puppet resource service puppet ensure=running If the service fails to start, open a Support ticket referencing S0001, and provide syslog and any errors output when attempting to restart the service.
S0002 Determines if the pxp-agent service is running. Starts the pxp-agent service - puppet resource service pxp-agent ensure=running If the service fails to start, open a Support ticket referencing S0002, provide syslog any errors output when attempting to restart the service, and /var/log/puppetlabs/pxp-agent/pxp-agent.log
S0003 Determines if infrastructure components are running in noop. Do not routinely configure noop on PE infrastructure nodes, as it prevents the management of key infrastructure settings. Disable this setting on infrastructure components. If you are unable to disable noop or encounter an error when disabling noop, open a Support ticket referencing S0003, and provide any errors output when attempting to change the setting.
S0004 Determines if the Puppet Server status endpoint is returning any errors. Execute puppet infrastructure status. Which ever service returns in a state that is not running, examine the logging for that service to indicate the fault. Open a Support ticket referencing S0004, provide the output of puppet infrastructure status and any service logs associated with the errors.
S0005 Determines if certificate authority (CA) cert expires in the next 90 days. Install the puppetlabs-ca_extend module and follow steps to extend the CA cert. Open a Support ticket referencing S0005 and provide support script output from the primary server, and any errors encountered when using the ca_extend module.
S0006 Determines if Puppet metrics collector is enabled and collecting metrics. Metrics collector is a tool that lets you monitor a PE installation. If it is not enabled, enable it. If you have issues enabling metrics, open a ticket referencing S0006 and provide the output of the support script.
S0007 Determines if there is at least 20% disk free on the PostgreSQL data partition. Determines if growth is slow and expected within the TTL of your data. If there's an unexpected increase, use this article to troubleshoot PuppetDB If your Puppet Practitioner is unable to find a cause for the growth and the suggested KB does not help, open a Support ticket referencing S0007 and provide details about large files and folders, rate of growth, and a full support script from the affected node.
S0008 Determines if there is at least 20% disk free on the codedir data partition. This can indicate you are deploying more code from the code repo than there is space for on the infrastructure components, or that something else is consuming space on this partition. Run puppet config print codedir, check that codedir partition indicated has enough capacity for the code being deployed, and check that no other outside files are consuming this data mount.
S0009 Determines if pe-puppetserver service is running and enabled on relevant components. Checks that the service can be started and enabled by running puppet resource service pe-puppetserver ensure=running, examines /var/log/puppetlabs/puppetserver/puppetserver.log for failures. If you are unable to explain the service outage from the logging, or are unable to start the service, open a Support ticket referencing S0009 and provide the /var/log/puppetlabs/puppetserver/puppetserver.log, showing an unsuccessful startup.
S0010 Determines if pe-puppetdb service is running and enabled on relevant components. Checks that the service can be started and enabled by running puppet resource service pe-pupeptdb ensure=running, examines /var/log/puppetlabs/puppetdb/puppetdb.log for failures. If you are unable to explain the service outage from the logging, or are unable to start the service, open a Support ticket referencing S0010 and provide the /var/log/puppetlabs/puppetdb/puppetdb.log log, showing an unsuccessful startup.
S0011 Determines if pe-postgres service is running and enabled on relevant components. Checks that the service can be started and enabled by running puppet resource service pe-postgres ensure=running, examines /var/log/puppetlabs/postgresql/<postgresversion>/postgresql-<today>.log for failures. If you are unable to explain the service outage from the logging, or are unable to start the service, open a Support ticket referencing S0011 and provide the /var/log/puppetlabs/postgresql/<postgresversion>/ postgresql-<today>.log log, showing an unsuccessful startup
S0012 Determines if Puppet produced a report during the last run interval. Troubleshoot Puppet run failures. Open a Support ticket referencing S0012 and provide the output of puppet agent -td > debug.log 2>&1
S0013 Determines if the catalog was successfully applied during the last Puppet run. Troubleshoot Puppet run failures. Open a Support ticket referencing S0013 and provide the output of puppet agent -td > debug.log 2>&1
S0014 Determines if anything in the command queue is older than a Puppet run interval. This can indicate that the PuppetDB performance is inadequate for incoming requests. Review PuppetDB performance. Use metrics to pinpoint the issue. If your are unable to determine the reason from the metrics, open a Support ticket referencing S0014 and provide the output of the support script. and the findings from your analysis of the metrics
S0015 Determines if the infrastructure agent host certificate is expiring in the next 90 days. Puppet Enterprise has built in functionalilty to regenerate infrastructure certificates, see the following documentation If the documented steps fail to resolve your issue, open a support ticket referencing S0015 and provide the error message received when running the steps.
S0016 Determines if there are any OutOfMemory errors in the puppetserver log. Increase the Java heap size for that service. Open a Support ticket referencing S0016 and provide puppet metrics, /var/log/puppetlabs/puppetserver/puppetserver.log, and the output of puppet infra tune.
S0017 Determines if there are any OutOfMemory errors in the puppetdb log. Increase the Java heap size for that service. Open a Support ticket referencing S0017 and provide puppet metrics, /var/log/puppetlabs/puppetdb/puppetdb.log, and the output of puppet infra tune.
S0018 Determines if there are any OutOfMemory errors in the orchestrator log. Increase the Java heap size for that service. Open a Support ticket referencing S0018 and provide puppet metrics, /var/log/puppetlabs/orchestration-services/orchestration-services.log, and output of puppet infra tune.
S0019 Determines if there are sufficent jRubies available to serve agents. Insufficient jRuby availability results in queued puppet agents and overall poor system performance. There can be many causes: Insufficient server tuning for load, a thundering herd, and insufficient system resources for scale. If self-sevice fails to resolve the issue, open a ticket referencing S0019 and provide a description of actions so far and the output of the support script.
S0021 Determines if free memory is less than 10%. Ensure your system hardware availability matches the recommended configuration, note this assumes no third-party software using significant resources, adapt requirements accordingly for third-party requirements. Examine metrics from the server and determine if the memory issue is persistent If you have issues with memory utilization in Puppet Enterprise that can not be explained, open a Support ticket, referencing S0021 and provide the output of the support script
S0022 Determines if there is a valid Puppet Enterprise license in place at /etc/puppetlabs/license.key on the primary server which is not expiring in the next 90 days. Get help with Puppet Enterprise license issues Open a Support ticket referencing S0022 and provide the output of the following commands ls -la /etc/puppetlabs/license.key and cat /etc/puppetlabs/license.key.
S0023 Determines if certificate authority CRL expires in the next 90 days. The solution is to reissue a new CRL from the Puppet CA, note this will also remove any revoked certificates. To do this follow the instructions in this module Open a Support ticket referencing S0023 and provide support script output from the primary server, and errors or output collected from the resolution steps
S0024 Determines if there are files in the puppetdb discard directory newer than 1 week old Recent files indicate an issue that causes PuppetDB to reject incoming data. Investigate Puppetdb logs at the time the data was rejected to find a cause, If you are unable to determine a reason for the rejections from logging, Open a Support ticket referencing S0024 and provide a copy of the PuppetDB log for the time in question, along with a sample of the most recent file in the following directory /opt/puppetlabs/server/data/puppetdb/stockpile/discard/
S0025 Determines if the host copy of the CRL expires in the next 90 days. If the Output of S0023 on the primary server is also false use the resolution steps in S0023. If S0023 on the Primary is True, follow this article Open a Support ticket referencing S0025 and provide any errors you received in following the resolution steps
S0026 Determines if pe-puppetserver JVM Heap-Memory is set to an inefficient value. Due to an odditity in how JVM memory is utilised, most applications are unable to consume heap memory between ~31GB and ~48GB as such is if you have heap memory set within this value, you should reduce it to more efficiently allocate server resources. To set heap refer to Increase the Java heap size for this service.
S0027 Determines if if pe-puppetdb JVM Heap-Memory is set to an inefficient value. Due to an odditity in how JVM memory is utilised, most applications are unable to consume heap memory between ~31GB and ~48GB as such is if you have heap memory set within this value, you should reduce it to more efficiently allocate server resources. To set heap refer to Increase the Java heap size for this service.
S0029 Determines if number of current connections to Postgresql DB is approaching 90% of the max_connections defined. First determine the need to increase connections, evaluate if this message appears on every puppet run, or if idle connections from recent component restarts may be to blame. If persistent, impact is minimal unless you need to add more components such as Compilers or Replicas, if you plan to increase the number of components on your system, increase max_connections value. To increase the maximum number of connections in postgres, adjust puppet_enterprise::profile::database::max_connections. Consider also increasing shared_buffers if that is the case as each connection consumes RAM. Should you be unable to determine the reason for a recent increase in connection use, or are having issue upping the number of connections available, open a Support ticket referencing S0029 and provide the current and future value for puppet_enterprise::profile::database::max_connections and we will assist.
S0030 Determines when infrastructure components have the setting use_cached_catalog set to true. Don't configure use_cached_catalog on PE infrastructure nodes. It prevents the management of key infrastructure settings. Disable this setting on all infrastructure components. See our documentation for more information If you encounter errors after disabling use_cached_catalog, open a Support ticket referencing S0030 and provide the errors.
S0031 Determines if old PE agent packages exist on the primary server. Remove the old PE agent packages.
S0033 Determines if Hiera 5 is in use. Upgrading to Hiera 5 offers some major advantages If you're having issues upgrading to Hiera 5 or if your global Hiera configuration file was erroneously modified, open a Support ticket referencing S0033. Provide your global Hiera configuration file puppet config print hiera_config; the default location is /etc/puppetlabs/puppet/hiera.yaml.
S0034 Determines if your PE deployment has not been upgraded in the last year. Upgrade your PE instance. If you have issues during a Puppet Upgrade, open a ticket and provide your current version and the version you would like to upgrade to and state any problems, providing any logging that is helpful.
S0035 Determines if puppet module list is returning any warnings If S0035 returns false, i.e., warnings are present, you should run puppet module list --debug and resolve the issues shown. The Puppetfile does NOT include Forge module dependency resolution. You must make sure that you have every module needed for all of your specified modules to run.Please refer to Managing environment content with a Puppetfile for more info on Puppetfile and refer to the specific module page on the forge for further information on specific dependancies If you are unable to remove all the warnings, then please refer to Get help for supported modules and raise a support request
S0036 Determines if max-queued-requests is set above 150. The maximum value for jruby_puppet_max_queued_requests is 150 If you are unable to change the value of jruby_puppet_max_queued_requests or encounter an error when changing it, open a Support ticket referencing S0036 and provide any errors output when attempting to change the setting.
S0038 Determines whether the number of environments within $codedir/environments is less than 100 Having a large number of code environments can negatively affect Puppet Server performance. See the Configuring Puppet Server documentation for more information. You should examine if you need them all, any unused environments should be removed. If all are required you can ignore this warning.
S0039 Determines if Puppets Server has reached its queue-limit-hit-rate,and is sending messages to agents. Check the max-queued-requests article for more information. If the article is unable to solve your issue, open a Support ticket referencing S0039, indicating the investigation so far, and any issues you encountered, then provide the support script output from the primary server.
S0040 Determines if PE is collecting system metrics. If system metrics are not collected by default, the sysstat package is not installed on the impacted PE infrastructure component. Install the package and set the parameter puppet_enterprise::enable_system_metrics_collection to true. See the documentation. After system metrics are configured, you do not see any files in /var/log/sa or if the /var/log/sa directory does not exist, open a Support ticket.
S0041 Determines if the pxp broker on a compiler has an established connection to another pxp broker To resolve a connection issue from a compiler to a pcp broker examine the following log /var/log/puppetlabs/puppetserver/pcp-broker.log for an explanation, Compilers should be attempting to make a connection to port 8143 on the primary server, ssl can not be terminated on a network appliance and must passthrough directly to the primary server. Ensure the connnection attempt is not to another compiler in the pool If unable to make a connection to a broker, raise a ticket with the support team quoting S0041 and attaching the file /var/log/puppetlabs/puppetserver/pcp-broker.log along with the conclusions of your investigation so far
S0042 Determines if the pxp-agent has an established connection to a pxp broker Ensure the pxp-agent service is running. Check S0002 can make that determination. if running check /var/log/puppetlabs/pxp-agent/pxp-agent.log (on *nix) or C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log (on Windows), for connection issues, first ensuring the agent is connecting to the proper endpoint, for example, a compiler and not the primary. This fact can also be used as a target filter for running tasks, ensuring time is not wasted sending instructions to agents not connected to a broker If unable to make a connection to a broker, raise a ticket with the support team quoting S0042 and attaching the file /var/log/puppetlabs/pxp-agent/pxp-agent.log (on *nix) or C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log (on Windows), along with the conclusions of your investigation so far

Fact: agent_status_check

This fact is confined to run on only agent nodes that a NOT infrastructure nodes.

Refer below for next steps when any indicator reports a false.

Indicator ID Description Self-service steps What to include in a Support ticket
AS001 Determines if the agent host certificate is expiring in the next 90 days. Puppet Enterprise has a plan built into extend agent certificates. Use a puppet query to find expiring host certificates and pass the node ID to this plan: puppet plan run enterprise_tasks::agent_cert_regen agent=$(puppet query 'inventory[certname] { facts.agent_status_check.AS001 = false }' \| jq -r '.[].certname' \| paste -sd, -) master=$(puppet config print certname) If the plan fails to run, open a support ticket referencing AS001 and provide the error message received when running the plan.
AS002 Determines if the pxp-agent has an established connection to a pxp broker Ensure the pxp-agent service is running, if running check /var/log/puppetlabs/pxp-agent/pxp-agent.log (on *nix) or C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log (on Windows) — Contains the for connection issues, first ensuring the agent is connecting to the proper endpoint, for example, a compiler and not the primary. This fact can also be used as a target filter for running tasks, ensuring time is not wasted sending instructions to agents not connected to a broker If unable to make a connection to a broker, raise a ticket with the support team quoting AS002 and attaching the file /var/log/puppetlabs/pxp-agent/pxp-agent.log (on *nix) or C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log (on Windows) along with the conclusions of your investigation so far
AS003 Determines the certname configuration parameter is incorrectly set outside of the [main] section of the puppet.conf file. The Puppet documentation states clearly certname should always be placed solely in the [main] section to prevent unforseen issues with the operation of the puppet agent https://puppet.com/docs/puppet/7/configuration.html#certname If unable to determine why the indicator is being raised. Open a ticket with the support team quoting AS003 and attaching the file puppet.conf along with the conclusions of your investigation so far .
AS004 Determines if the host copy of the CRL expires in the next 90 days. If the Output of S0023 on the primary server is also false use the resolution steps in S0023. If S0023 on the Primary is True, follow this article Open a Support ticket referencing AS004 and provide any errors you recieved in following the resolution steps

How to report an issue or contribute to the module

If you are a PE user and need support using this module or encounter issues, our Support team is happy to help you. Open a ticket at the Support Portal. If you have a reproducible bug or are a community user, you can open an issue directly in the GitHub issues page of the module. We also welcome PR contributions to improve the module. Please see further details about contributing.


Supporting Content

Articles

The Support Knowledge base is a searchable repository for technical information and how-to guides for all Puppet products.

This Module has the following specific Article(s) available:

  1. Find and fix common issues in Puppet Enterprise using the puppetlabs-pe_status_check module

Videos

The Support Video Playlist is a resource of content generated by the support team

This Module has the following specific video content available:

  1. Preventative Maintenance With PE Status Check