Skip to content

Added documentation for property precedence order, per-tenant configuration and /v1/health/config endpoint. - #632

Merged
reshmabidikar merged 3 commits into
killbill:v3from
vnandwana:health-config
Jan 16, 2026
Merged

reshmabidikar merged 3 commits into
killbill:v3from
vnandwana:health-config

Conversation

@vnandwana

@vnandwana vnandwana commented Oct 29, 2025 •

Copy link
Copy Markdown
Contributor


Includes the `user.timezone` property, which is force set to `GMT`.

This property cannot be overridden.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overriding user.timezone results in the following warning:

Overwrite of user.timezone system property with IST may break database serialization of date. Kill Bill will overwrite to GMT

This code resets the value to GMT.

@reshmabidikar reshmabidikar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not quite follow how this documentation fits into Aviate Health. Does this correspond to a new API endpoint that exposes all the config properties? Is this endpoint provided by the aviate plugin? If so, a couple of suggestions:

  • Add the documentation for this endpoint in the API docs here
  • Add a new section (maybe below the Metrics section) to the Aviate health doc and move this content to this section. Ensure that the API doc points to this documentation.

@sbrossie

sbrossie commented Jan 8, 2026

Copy link
Copy Markdown
Member

@vnandwana Will you rebase this PR based on latest v3 and resubmit any changes that you think are relevant?

@vnandwana

vnandwana commented Jan 10, 2026 •

Copy link
Copy Markdown
Contributor Author

I do not quite follow how this documentation fits into Aviate Health. Does this correspond to a new API endpoint that exposes all the config properties? Is this endpoint provided by the aviate plugin? If so, a couple of suggestions:

  • Add the documentation for this endpoint in the API docs here
  • Add a new section (maybe below the Metrics section) to the Aviate health doc and move this content to this section. Ensure that the API doc points to this documentation.

Hi @reshmabidikar, thank you for your suggestions. I have addressed these comments, please review the changes at your convenience. This branch has been rebased onto the latest v3.

API doc PR -- killbill/slate#352

@reshmabidikar reshmabidikar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I've left a few minor comments.

Comment thread userguide/aviate/aviate-health.adoc Outdated

This provides fine-grained control in multi-tenant deployments, enabling different tenants to customize selected settings while still inheriting defaults from the global configuration.

For more details, see the official documentation: https://docs.killbill.io/latest/plugin_installation#per-tenant-configuration.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better to point to this link as https://docs.killbill.io/latest/plugin_installation#per-tenant-configuration has more to do with per-tenant plugin configuration.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plz share more info on this, the present link is the same as the suggested link.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread userguide/aviate/aviate-health.adoc Outdated
using value from 'EnvironmentVariables': '11s'`


To make it easier to understand the runtime values of these properties, Kill Bill provides the `/v1/health/config` endpoint.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which endpoint does this refer to? Can we point to the doc link for this endpoint?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR for this endpoint is killbill/slate#352 -- if we need to link this API doc, we'll need to merge the Slate PR.


* Runtime Configuration

Properties loaded from a configuration file specified via `-Dorg.killbill.server.properties=<propertyFile>`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this also include the properties defined in catalina.properties in case of a Tomcat configuration? If so, would be good to mention this explicitly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it doesn't.

@sbrossie sbrossie left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given we already merged #627, was this branch rebased to include it?

@vnandwana vnandwana closed this Jan 12, 2026
@vnandwana vnandwana reopened this Jan 12, 2026
@vnandwana

Copy link
Copy Markdown
Contributor Author

Given we already merged #627, was this branch rebased to include it?

Yes, this branch is rebased to the latest v3 branch -- here is the commit for reference 26e6981

@reshmabidikar
reshmabidikar merged commit 4ec7eca into killbill:v3 Jan 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants