Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aviate Health Doc #579

Merged
merged 3 commits into from
Dec 6, 2024
Merged

Aviate Health Doc #579

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa792bc
Aviate Health - initial commit
reshmabidikar Dec 6, 2024
da88dea
Minor corrections
reshmabidikar Dec 6, 2024
def1715
Fixed typo
reshmabidikar Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions html5/_main_toc.html.slim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ nav.sidebar-nav
li.bd-sidenav-active
a.nav-link href="/latest/how-to-install-the-aviate-plugin.html"
| Aviate Plugin Installation
li.bd-sidenav-active
a.nav-link href="/latest/aviate-health.html"
| Aviate Health
li
.icon-title
a.bd-toc-link.main-link role="button" Manuals
Expand Down
2 changes: 1 addition & 1 deletion userguide/aviate/aviate-catalog-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Refer to the https://docs.killbill.io/latest/userguide_configuration.html[__Kill

=== Using Catalog Plugin APIs

Once the plugin is installed and enabled, you can start using the Catalog Plugin APIs. As mentioned earlier, the Aviate catalog plugin exposes endpoints that operate at a plan/product/pricelist level. These endpoints allow plan/product/pricelist creation/modification and deletion. At the time of writing, only plan-level endpoints are supported. The catalog API endpoints are documented in our https://apidocs.killbill.io/aviate-catalog-apis[slate docs].
Once the plugin is installed and enabled, you can start using the Catalog Plugin APIs. As mentioned earlier, the Aviate catalog plugin exposes endpoints that operate at a plan/product/pricelist level. These endpoints allow plan/product/pricelist creation/modification and deletion. At the time of writing, only plan-level endpoints are supported. The catalog API endpoints are documented in our https://apidocs.killbill.io/aviate-catalog-apis[api docs].

== Catalog Versioning

Expand Down
29 changes: 29 additions & 0 deletions userguide/aviate/aviate-health.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,32 @@
include::{sourcedir}/aviate/includes/aviate-card.adoc[]

== Introduction

Aviate Health is a feature provided by the Aviate plugin. It is designed to give users valuable insights into the overall health and performance of a KillBill installation. As part of this feature, the aviate plugin exposes dedicated health-related endpoints that allow you to monitor and manage various aspects of your KillBill setup. Some of the capabilities offered by this feature include viewing detailed health metrics for all nodes within a KillBill installation, identifying and resolving issues such as stuck bus or notification entries, and generating comprehensive diagnostic reports to aid in troubleshooting and system optimization.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Kill Bill


== Getting Started with Aviate Health

This section provides a step-by-step approach to start using Aviate Health.

=== Installing the Plugin

The Aviate plugin can be installed as documented in the https://docs.killbill.io/latest/how-to-install-the-aviate-plugin.html[How to Install the Aviate Plugin] doc.

=== Enabling Aviate Health

When the Aviate plugin is installed, Aviate Heath is enabled by default.

The following configuration property controls this feature:

[source,bash]
----
com.killbill.billing.plugin.aviate.enableHealthReporter=true
----

Refer to the https://docs.killbill.io/latest/userguide_configuration.html[__Kill Bill Configuration Guide__] to know more about setting configuration properties.

=== Using Health APIs

As mentioned earlier, Aviate Health exposes endpoints that allow monitoring the health of a KB installation and fixing problems if any. Once the aviate plugin is installed, you can start using the Aviate Health APIs. These are documented in our https://apidocs.killbill.io/aviate-health-apis[api docs].


Loading