Merge pull request #543 from reshmabidikar/log-masking-and-other-impr…

…ovements

Log masking and other improvements

userguide/getting-started/includes/docker.adoc

@@ -41,7 +41,7 @@ The next step is to create a YAML file called `docker-compose.yml`, similar to t
 
 Ensure that you specify the latest versions of the Kill Bill, Kaui and MariaDB images in your `docker-compose` file. The latest versions at the time of writing are as follows:
 
-* Kill Bill - `killbill/killbill:0.24.7`
+* Kill Bill - `killbill/killbill:0.24.9`
 * Kaui - `killbill/kaui:3.0.6`
 * MariaDB - `killbill/mariadb:0.24`
 
@@ -52,7 +52,7 @@ volumes:
   db:
 services:
   killbill:
-    image: killbill/killbill:0.24.7
+    image: killbill/killbill:0.24.9
     ports:
       - "8080:8080"
     environment:
@@ -69,7 +69,6 @@ services:
       - KAUI_CONFIG_DAO_USER=root
       - KAUI_CONFIG_DAO_PASSWORD=killbill
       - KAUI_KILLBILL_URL=http://killbill:8080
-      - KAUI_SECRET_KEY_BASE=<any string value>
   db:
     image: killbill/mariadb:0.24
     volumes:

userguide/getting-started/includes/tomcat.adoc

@@ -330,6 +330,21 @@ The steps above configure the application so that the Kill Bill and Kaui logs ar
   <log_file_path>/killbill.out
   <log_file_path>/kaui.out
 
+=== Masking Data in Logs
+
+Sometimes, you may wish to mask some sensitive data in the logs. For this, you need to do the following:
+
+. Set the following system properties (Refer https://docs.killbill.io/latest/userguide_configuration#_logging_properties[docs]):
+[source,properties]
+  killbill.server.log.obfuscate.keywords=xxx
+  killbill.server.log.obfuscate.patterns=xxx
+  killbill.server.log.obfuscate.patterns.separator=xxx
+. In your `logback.xml`, configure the `ObfuscatorConverter` by adding the following line below `<jmxConfigurator />`:
+[source,xml]
+ <conversionRule conversionWord="maskedMsg" converterClass="org.killbill.billing.server.log.obfuscators.ObfuscatorConverter" />
+. Restart Kill Bill - Sensitive data in the logs (as configured by the system properties above) should now be masked.
+
+
 === Setting up KPM in Kaui
 
 KPM stands for *Kill Bill Package Manager*. It can be used to manage https://docs.killbill.io/latest/plugin_introduction.html[plugins]. You can read https://github.com/killbill/killbill-cloud/tree/master/kpm[this] article to know more about kpm.

userguide/platform/userguide_configuration.adoc

@@ -136,6 +136,13 @@ In case of a https://docs.killbill.io/latest/development.html#_running_the_appli
 mvn -Dorg.killbill.server.properties=file:///PROJECT_ROOT/profiles/killbill/src/main/resources/killbill-server.properties
 ----
 
+Additional system properties can also be set at the commandline as follows:
+
+[source,bash]
+----
+mvn -Dorg.killbill.server.properties=file:///PROJECT_ROOT/profiles/killbill/src/main/resources/killbill-server.properties -Dkillbill.server.log.obfuscate.keywords=accountnumber,authenticationdata,bankaccountnumber,banknumber
+----
+
 == Kaui Configuration
 
 In addition to Kill Bill, Kaui can also be configured via some configuration properties. These can either be set as system properties or environment variables. Note that in case of a Tomcat installation, system properties can be specified in the `catalina.properties` file.