2691828d2b
Edit the actuator docs so that more "You can..." phrasing is used. For example "Auditing can be enabled by providing" becomes "You can enable auditing by providing" See gh-27759
19 lines
1.2 KiB
Plaintext
19 lines
1.2 KiB
Plaintext
[[actuator.auditing]]
|
|
== Auditing
|
|
Once Spring Security is in play, Spring Boot Actuator has a flexible audit framework that publishes events (by default, "`authentication success`", "`failure`" and "`access denied`" exceptions).
|
|
This feature can be very useful for reporting and for implementing a lock-out policy based on authentication failures.
|
|
|
|
You can enable auditing by providing a bean of type `AuditEventRepository` in your application's configuration.
|
|
For convenience, Spring Boot offers an `InMemoryAuditEventRepository`.
|
|
`InMemoryAuditEventRepository` has limited capabilities, and we recommend using it only for development environments.
|
|
For production environments, consider creating your own alternative `AuditEventRepository` implementation.
|
|
|
|
|
|
|
|
[[actuator.auditing.custom]]
|
|
=== Custom Auditing
|
|
To customize published security events, you can provide your own implementations of `AbstractAuthenticationAuditListener` and `AbstractAuthorizationAuditListener`.
|
|
|
|
You can also use the audit services for your own business events.
|
|
To do so, either inject the `AuditEventRepository` bean into your own components and use that directly or publish an `AuditApplicationEvent` with the Spring `ApplicationEventPublisher` (by implementing `ApplicationEventPublisherAware`).
|