14.2 Built-In Endpoints
When the management
dependency is added to your project, the following built-in endpoints are enabled by default:
Endpoint | URI | Description |
---|---|---|
| Returns information about the loaded bean definitions in the application (see BeansEndpoint) | |
| Returns information about the “health” of the application (see HealthEndpoint) | |
| Returns static information from the state of the application (see InfoEndpoint) | |
| Returns information about available loggers and permits changing the configured log level (see LoggersEndpoint) | |
| Return the application metrics. Requires the | |
| Refreshes the application state (see RefreshEndpoint) | |
| Returns information about URIs available to be called for your application (see RoutesEndpoint) | |
| Returns information about the environment and its property sources (see EnvironmentEndpoint) | |
| 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:
Endpoint | URI | Description |
---|---|---|
| Returns information about the caches and permits invalidating them (see CachesEndpoint) | |
| 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:
endpoints:
all:
port: 8085
In the above example the management endpoints are exposed only over port 8085.
JMX
Micronaut provides functionality to register endpoints with JMX. See the section on JMX to get started.