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.
There are four API endpoints that each contain different services on their unique port. You can check the overall health of all services within a given port, or the details of an individual service on a port.
- Console-services status API on port 4433
- Returns status details about the activity service, the classifier, and RBAC.
- Puppet Server status API on port 8140
- Returns status details about Code Manager, file sync client, file sync storage, and Puppet Server.
- Orchestrator status API on port 8143
- Returns status details about the orchestrator, PCP broker, and PCP broker v2.
- PuppetDB status API on port 8081
- Returns status details about PuppetDB.
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 primary server.
-
Authenticating to the status API
Token-based authentication is not required to access the status API. You can choose to authenticate requests by using certificates, or you can access the API without authentication via HTTP. -
Forming requests to the status API
When forming requests to the status API, specify the port that corresponds to the service you want to view the status for. -
Status API: services endpoint
The/services
endpoints provide machine-consumable information about running services. They are intended for scripting and integration with other services. -
Status API: services plaintext endpoint
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. -
Status API: metrics endpoint
Puppet Server is capable of tracking advanced metrics to give you additional insight into its performance and health. -
Metrics API
Puppet Enterprise includes an optional, enabled-by-default web endpoint for Java Management Extension (JMX) metrics, namely managed beans (MBeans).