From 48abf9b7f95e3d2c981d07af4281fc2073810ced Mon Sep 17 00:00:00 2001 From: stephane brossier Date: Mon, 29 Sep 2025 16:31:06 -0700 Subject: [PATCH] aviate health config: Draft doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit TODO • Rethink the naming of the groups - i.e. 'Default properties', 'Default system properties' and 'System properties' is confusing Do we need 2 or 3 categories? • Implement/document and precedence algorithm as described in https://github.com/killbill/technical-support/issues/216 --- userguide/aviate/aviate-health.adoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/userguide/aviate/aviate-health.adoc b/userguide/aviate/aviate-health.adoc index 096d9b158..25b3b90d4 100644 --- a/userguide/aviate/aviate-health.adoc +++ b/userguide/aviate/aviate-health.adoc @@ -93,6 +93,21 @@ The metrics exposed by the Aviate plugin can mainly be categorized in the follow |=== +=== Runtime Properties + +Properties can be specified to configure the Kill Bill system including its plugins. The following https://docs.killbill.io/latest/userguide_configuration#configuration_properties_table[documentation] shows the main configuration properties. + + +The values for these properties can come from a number of sources: + +* Default properties # properties set by Kill Bill system +* Default system properties # e.g. `user.timezone` set to `GMT` +* System properties - either specified as a `-D=` or through a system property file identified by `-Dorg.killbill.server.properties=` +* Environment variable, using the `KB_org_*` syntax +* Per-tenant config # Override of specific system properties on a per tenant level + +This flexibility is offered by default and it allows to adopt different deployment models along with a fine grained granularity at the tenant level. However, to make it easier to understand the runtime values of these properties, we have created the endpoint `/v1/health/config`: It provides the view of what the syystem is running along with the required information about where each property value comes from. + === Queue Metrics Queue metrics can be used to assess the health of the Kill Bill internal queues.