From 1f2da6a3411bca46fad0433c907b77785d6eb317 Mon Sep 17 00:00:00 2001
From: Andy Wilkinson <wilkinsona@vmware.com>
Date: Thu, 3 Mar 2022 14:17:28 +0000
Subject: [PATCH] Document SanitizingFunction

Closes gh-29950
---
 .../src/docs/asciidoc/howto/actuator.adoc             | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/actuator.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/actuator.adoc
index 8c82b7551c3..dbd7b49b770 100644
--- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/actuator.adoc
+++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/actuator.adoc
@@ -53,9 +53,20 @@ The sensitive portion of the URI is identified using the format `<scheme>://<use
 For example, for the property `myclient.uri=http://user1:password1@localhost:8081`, the resulting sanitized value is
 `++http://user1:******@localhost:8081++`.
 
+
+
+[[howto.actuator.sanitize-sensitive-values.customizing-sanitization]]
+==== Customizing Sanitization
+Sanitization can be customized in two different ways.
+
 The default patterns used by the `env` and `configprops` endpoints can be replaced using configprop:management.endpoint.env.keys-to-sanitize[] and configprop:management.endpoint.configprops.keys-to-sanitize[] respectively.
 Alternatively, additional patterns can be configured using configprop:management.endpoint.env.additional-keys-to-sanitize[] and configprop:management.endpoint.configprops.additional-keys-to-sanitize[].
 
+To take more control over the santization, define a `SanitizingFunction` bean.
+The `SanitizableData` with which the function is called provides access to the key and value as well as the `PropertySource` from which they came.
+This allows you to, for example, sanitize every value that comes from a particular property source.
+Each `SanitizingFunction` is called before and in addition to the built-in key-based sanitization.
+
 
 
 [[howto.actuator.map-health-indicators-to-metrics]]