Actuator Endpoints
The BeAPI Framework provides private endpoints for checking stats and properties of the running service.. Below is a list of those endpoints and what each one does
Provided Endpoints
The Beapi Starter provides endpoints that are not visible in your project but can be called via API endpoints. These are also secured via IO State files (like all your other endpoints) but generally don't have to be changed. Below we go over each one of these and the endpoints provided...
env
View the environment variables used by your application
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/env | (List) attempts,procCores,documentationUrl,reservedUris,apichainLimit,chainingEnabled,batchingEnabled,encoding,iostateDir,staticEndpoint,serverType,supportedFormats,throttle,webhook,security |
getProperties
View the properties variables used by your application
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/getProperties | (List) attempts,procCores,documentationUrl,reservedUris,apichainLimit,chainingEnabled,batchingEnabled,encoding,iostateDir,staticEndpoint,serverType,supportedFormats,throttle,webhook,security |
health
Shows the overall health of your application and its dependencies
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/health | (List) application,build |
caches
Displays a complete list of all caches in your application.
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/caches | (Object) caches |
beans
Displays a complete list of all Spring beans in your application.
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/beans | (Object) beans |
logging
View and manage application logs
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/logging | (Object) logging |
db
Displays a complete list of all database info for your application.
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/db | (Object) db |
sessions
Displays a complete list of all session data for your application.
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/sessions | (Object) sessions |
metrics
Shows gathered metrics about your application's performance, such as memory usage and CPU usage
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/metrics | (Object) metrics |
stats
Shows gathered metrics about your application's performance such as request statistics
| Endpoint | Request Params | Response Params |
|---|---|---|
| /{version}/actuator/stats | (Object) stats |