From 5b12646be29538acd86cb5a2260d867b2c1f04da Mon Sep 17 00:00:00 2001 From: reshmabidikar Date: Wed, 31 Jul 2024 16:33:48 +0530 Subject: [PATCH 1/3] Minor corrections to invoice plugin doc --- userguide/tutorials/invoice_plugin.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/userguide/tutorials/invoice_plugin.adoc b/userguide/tutorials/invoice_plugin.adoc index 592a395cb..87698e9d6 100644 --- a/userguide/tutorials/invoice_plugin.adoc +++ b/userguide/tutorials/invoice_plugin.adoc @@ -27,9 +27,9 @@ Invoice plugins are registered through the per-tenant `org.killbill.invoice.plug === Retries -Invoice generation can be aborted and retried at a later time if the plugin is unable to compute the additional items (e.g. third-party tax service unavailable). The mechanism to do so is very similar to the retry mechanism for notification plugins: the plugin simple needs to throw an `InvoicePluginApiRetryException` with a specified retry schedule. +Invoice generation can be aborted and retried at a later time if the plugin is unable to compute the additional items (e.g. third-party tax service unavailable). The mechanism to do so is very similar to the retry mechanism for notification plugins: the plugin simple needs to throw an https://github.com/killbill/killbill-plugin-api/blob/master/invoice/src/main/java/org/killbill/billing/invoice/plugin/api/InvoicePluginApiRetryException.java[InvoicePluginApiRetryException]. The default retry schedule is `5m, 15m,1h,6h,15h` as defined https://github.com/killbill/killbill-api/blob/7ea823b25e8fd6299350ec62d700e265022be34e/src/main/java/org/killbill/billing/util/queue/QueueRetryException.java#L26[here]. However, users can also specify a custom retry schedule. -Take a look at the https://docs.killbill.io/latest/notification_plugin.html[Notification Plugins] documentation for more details. +Take a look at the https://docs.killbill.io/latest/notification_plugin#_retries[Notification Plugin] documentation for more details. === A note about invoice item ids From 04c187bde4094f7aefd0b773f38fda88370134d7 Mon Sep 17 00:00:00 2001 From: reshmabidikar Date: Thu, 1 Aug 2024 15:49:01 +0530 Subject: [PATCH 2/3] added key value patterns for masking --- userguide/getting-started/includes/tomcat.adoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/userguide/getting-started/includes/tomcat.adoc b/userguide/getting-started/includes/tomcat.adoc index e9f9c1f7b..e8a65d9e6 100644 --- a/userguide/getting-started/includes/tomcat.adoc +++ b/userguide/getting-started/includes/tomcat.adoc @@ -348,6 +348,16 @@ Sometimes, you may wish to mask some sensitive data in the logs. For this, you n . Restart Kill Bill - Sensitive data in the logs (as configured by the system properties above) should now be masked. +Some key-value pattern examples that can be specified corresponding to the `killbill.server.log.obfuscate.patterns` property: + +* \s*=\s*'([^']+)' - Matches `key = 'value'` +* \s*=\s*"([^"]+)" - Matches `key = "value"` +* \s*:\s*'([^']+)' - Matches `key: 'value'` +* \s*=\s*([^ '",{}]+) - Matches `name = value` +* \s*:\s*'([^'",{}]+)' - Matches `key: 'value'` + + + === Setting up KPM in Kaui From fb391dc154616c1e5c7257915375d0677df9e55d Mon Sep 17 00:00:00 2001 From: reshmabidikar Date: Fri, 2 Aug 2024 11:34:27 +0530 Subject: [PATCH 3/3] minor corrections --- userguide/tutorials/invoice_plugin.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/userguide/tutorials/invoice_plugin.adoc b/userguide/tutorials/invoice_plugin.adoc index 87698e9d6..dd234ba15 100644 --- a/userguide/tutorials/invoice_plugin.adoc +++ b/userguide/tutorials/invoice_plugin.adoc @@ -7,7 +7,7 @@ The https://github.com/killbill/killbill-plugin-api/blob/master/invoice/src/main/java/org/killbill/billing/invoice/plugin/api/InvoicePluginApi.java[InvoicePluginApi] exists to develop `invoice plugins`. The core invoice system calls those plugins each time the system is generating a new invoice. The invoice system will first compute all the items based on the existing subscriptions or usage data associated to the account and then invoke the registered plugins to allow to add extra items on that invoice. -Plugins need to implement one api `getAdditionalInvoiceItems`, whose purpose is to to allow plugins to add additional items and which takes the following parameters: +Plugins need to implement one api https://github.com/killbill/killbill-plugin-api/blob/a20776687fc61ce4ca94d84e2b117e4cce0a255c/invoice/src/main/java/org/killbill/billing/invoice/plugin/api/InvoicePluginApi.java#L39[getAdditionalInvoiceItems], whose purpose is to to allow plugins to add additional items and which takes the following parameters: * `invoice`: A copy of the current invoice being generated by the system (including all items generated by the system, and only items generated by the system) * `properties`: An empty list of `PluginProperty`, which means this field exists only for symmetry with other plugin apis, but is not used.