14.2 Built-In Endpoints

When the management dependency is added to your project, the following built-in endpoints are enabled by default:

Table 1. Default Endpoints
EndpointURIDescription

BeansEndpoint

/beans

Returns information about the loaded bean definitions in the application (see BeansEndpoint)

HealthEndpoint

/health

Returns information about the “health” of the application (see HealthEndpoint)

InfoEndpoint

/info

Returns static information from the state of the application (see InfoEndpoint)

LoggersEndpoint

/loggers

Returns information about available loggers and permits changing the configured log level (see LoggersEndpoint)

MetricsEndpoint

/metrics

Return the application metrics. Requires the micrometer-core configuration on the classpath.

RefreshEndpoint

/refresh

Refreshes the application state (see RefreshEndpoint)

RoutesEndpoint

/routes

Returns information about URIs available to be called for your application (see RoutesEndpoint)

EnvironmentEndpoint

/env

Returns information about the environment and its property sources (see EnvironmentEndpoint)

ThreadDumpEndpoint

/threaddump

Returns information about the current threads in the application.

In addition, the following built-in endpoint(s) are provided by the management dependency but are not enabled by default:

Table 2. Disabled Endpoints
EndpointURIDescription

CachesEndpoint

/caches

Returns information about the caches and permits invalidating them (see CachesEndpoint)

ServerStopEndpoint

/stop

Shuts down the application server (see ServerStopEndpoint)

It is possible to open all endpoints for unauthenticated access defining endpoints.all.sensitive: false but this should be used with care because private and sensitive information will be exposed.

Management Port

By default all management endpoints are exposed over the same port as the application. You can alter this behaviour by specifying the endpoints.all.port setting:

  1. endpoints:
  2. all:
  3. port: 8085

In the above example the management endpoints will be exposed only over port 8085.

JMX

Micronaut provides functionality to register endpoints with JMX. See the section on JMX to get started.