Metrics API v1

Puppet Enterprise (PE) includes an optional web endpoint for Java Management Extension (JMX) metrics managed beans (MBeans).

The metrics/v1/ endpoints are deprecated. We recommend using the Metrics API v2 endpoints instead.

If you choose to use the deprecated v1 endpoints, metrics are returned only when the request contains the level=debug parameter. The response structure might change in future versions.

The v1 endpoints include:

  • GET /metrics/v1/mbeans
  • POST /metrics/v1/mbeans
  • GET /metrics/v1/mbeans/<name>

Set the following parameter in Hiera to enable these endpoints:

puppet_enterprise::master::puppetserver::metrics_webservice_enabled: true

For general information about forming curl commands, authentication in commands, and Windows modifications, go to Using example commands.

For information about Java, refer to the Java documentation: