Status API

The status API allows you to check the health of PE components. It can be useful in automated monitoring of your PE infrastructure, removing unhealthy service instances from a load-balanced pool, checking configuration values, or when troubleshooting problems in PE.

You can check the overall health of pe-console-services, as well as the health of the individual services within pe-console-services:

  • Activity service
  • Node classifier
  • PuppetDB
  • Puppet Server
  • Role-based access control (RBAC)
  • Code Manager (if configured)

The endpoints provide overview health information in an overall healthy/error/unknown status field, and fine-detail information such as the availability of the database, the health of other required services, or connectivity to the Puppet master.