Add property to disable Spring Security observations

Setting 'management.observations.spring-security.enabled' installs an
ObservationPredicate, which prevents all observations starting with
'spring.security.' to be created.

Closes gh-34802
This commit is contained in:
Moritz Halbritter
2023-06-13 10:42:52 +02:00
parent 6eede829d2
commit 491e12ab5e
5 changed files with 79 additions and 0 deletions

View File

@@ -37,4 +37,16 @@ Commons key-values are applied to all observations as low cardinality key-values
The preceding example adds `region` and `stack` key-values to all observations with a value of `us-east-1` and `prod`, respectively.
[[actuator.observability.preventing-observations]]
=== Preventing Observations
If you'd like to prevent some observations from being reported, you can register beans of type `ObservationPredicate`.
Observations are only reported if all the `ObservationPredicate` beans return `true` for that observation.
include::code:MyObservationPredicate[]
The preceding example will prevent all observations with a name starting with "denied.prefix.".
TIP: If you want to prevent Spring Security from reporting observations, set the property configprop:management.observations.spring-security.enabled[] to `false`.
The next sections will provide more details about logging, metrics and traces.