Status API
The status API allows you to check the health of PE components and services. It can be useful for automated monitoring of your infrastructure, removing unhealthy service instances from a load-balanced pool, checking configuration values, or troubleshooting issues in PE.
You can check the overall health of the console service, as well as the health of the
individual services within the console service:
- Activity service
- Classifier service
- PuppetDB
- Puppet Server
- Role-based access control (RBAC) service
- Code Manager service
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 master.
-
Authenticating to the status API
Token-based authentication is not required to access the status API. You can choose to authenticate requests by using whitelisted certificates, or can access the API without authentication via HTTP. -
Forming requests to the status API
The HTTPS status endpoints are available on the console services API server, which uses port 4433 by default. -
JSON endpoints
These two endpoints provide machine-consumable information about running services. They are intended for scripting and integration with other services. -
Activity service plaintext endpoints
The activity service plaintext endpoints are designed for load balancers that don't support any kind of JSON parsing or parameter setting. They return simple string bodies (either the state of the service in question or a simple error message) and a status code relevant to the status result. -
Metrics endpoints
Puppet Server is capable of tracking advanced metrics to give you additional insight into its performance and health. -
The metrics API
Puppet Enterprise includes an optional, enabled-by-default web endpoint for Java Management Extension (JMX) metrics, namely managed beans (MBeans).
Related information