mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-09-03 04:26:12 +08:00
This commit reworks the initial proposal so that jobs and triggers are treated as first class concepts. `/actuator/quartz` now returns the group names for jobs and triggers. `actuator/quartz/jobs` returns the job names, keyed by the available group names, while `/actuator/quartz/triggers` does the same for triggers. `/actuator/jobs/{groupName}` provides an overview of a job group. It provides a map of job names with the class name of the job. implementation `/actuator/triggers/{groupName}` provides an overview of a trigger group. There are five supported trigger implementations: cron, simple, daily time interval, calendar interval, and custom for any other implementation. Given that each implementation has specific settings, triggers are split in five objects. `/actuator/jobs/{groupName}/{jobName}` provides the full details of a particular job. This includes a sanitized data map and a list of triggers ordered by next fire time. `/actuator/triggers/{groupName}/{triggerName}` provides the full details of a particular trigger. This includes the state, its type, and a dedicate object containing implementation-specific settings. See gh-10364 |
||
---|---|---|
.. | ||
src | ||
build.gradle | ||
README.adoc |
= Spring Boot - Actuator Spring Boot Actuator includes a number of additional features to help you monitor and manage your application when it's pushed to production. You can choose to manage and monitor your application using HTTP or JMX endpoints. Auditing, health and metrics gathering can be automatically applied to your application. The https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready[user guide] covers the features in more detail. == Enabling the Actuator The recommended way to enable the features is to add a dependency to the `spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven-based project, add the following '`Starter`' dependency: [source,xml,indent=0] ---- <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> </dependencies> ---- For Gradle, use the following declaration: [indent=0] ---- dependencies { implementation 'org.springframework.boot:spring-boot-starter-actuator' } ---- == Features * **Endpoints** Actuator endpoints allow you to monitor and interact with your application. Spring Boot includes a number of built-in endpoints and you can also add your own. For example the `health` endpoint provides basic application health information. Run up a basic application and look at `/actuator/health`. * **Metrics** Spring Boot Actuator provides dimensional metrics by integrating with https://micrometer.io[Micrometer]. * **Audit** Spring Boot Actuator has a flexible audit framework that will publish events to an `AuditEventRepository`. Once Spring Security is in play it automatically publishes authentication events by default. This can be very useful for reporting, and also to implement a lock-out policy based on authentication failures.