From aa792bccdcd3b9ddc9b381e61b9801d634c68aec Mon Sep 17 00:00:00 2001 From: reshmabidikar Date: Fri, 6 Dec 2024 12:15:08 +0530 Subject: [PATCH 1/3] Aviate Health - initial commit --- html5/_main_toc.html.slim | 3 +++ userguide/aviate/aviate-catalog-plugin.adoc | 2 +- userguide/aviate/aviate-health.adoc | 29 +++++++++++++++++++++ 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/html5/_main_toc.html.slim b/html5/_main_toc.html.slim index dca03ea7a..b96d944b7 100644 --- a/html5/_main_toc.html.slim +++ b/html5/_main_toc.html.slim @@ -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 diff --git a/userguide/aviate/aviate-catalog-plugin.adoc b/userguide/aviate/aviate-catalog-plugin.adoc index b20fd766b..da7ed4daf 100644 --- a/userguide/aviate/aviate-catalog-plugin.adoc +++ b/userguide/aviate/aviate-catalog-plugin.adoc @@ -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 diff --git a/userguide/aviate/aviate-health.adoc b/userguide/aviate/aviate-health.adoc index b5f8c2fa2..8ab915dc4 100644 --- a/userguide/aviate/aviate-health.adoc +++ b/userguide/aviate/aviate-health.adoc @@ -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. + +== Getting Started with Aviate Health + +This section provides a step-by-step approach to get started with 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. The Health API endpoints are documented in our https://apidocs.killbill.io/aviate-health-apis[api docs]. + + From da88dea6540fe80f391ab5a0ff85f1d2113b7332 Mon Sep 17 00:00:00 2001 From: reshmabidikar Date: Fri, 6 Dec 2024 12:19:44 +0530 Subject: [PATCH 2/3] Minor corrections --- userguide/aviate/aviate-health.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/userguide/aviate/aviate-health.adoc b/userguide/aviate/aviate-health.adoc index 8ab915dc4..b1466fb9e 100644 --- a/userguide/aviate/aviate-health.adoc +++ b/userguide/aviate/aviate-health.adoc @@ -8,7 +8,7 @@ Aviate Health is a feature provided by the Aviate plugin. It is designed to give == Getting Started with Aviate Health -This section provides a step-by-step approach to get started with aviate health +This section provides a step-by-step approach to start using Aviate Health. === Installing the Plugin @@ -29,6 +29,6 @@ Refer to the https://docs.killbill.io/latest/userguide_configuration.html[__Kill === Using Health APIs -As mentioned earlier, aviate health exposes endpoints that allow monitoring the health of a KB installation and fixing problems if any. The Health API endpoints are documented in our https://apidocs.killbill.io/aviate-health-apis[api docs]. +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]. From def171595045d0fac8cdcf28e8fe93db59cc8ef4 Mon Sep 17 00:00:00 2001 From: reshmabidikar Date: Fri, 6 Dec 2024 18:48:08 +0530 Subject: [PATCH 3/3] Fixed typo --- userguide/aviate/aviate-health.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/userguide/aviate/aviate-health.adoc b/userguide/aviate/aviate-health.adoc index b1466fb9e..7df03ed6d 100644 --- a/userguide/aviate/aviate-health.adoc +++ b/userguide/aviate/aviate-health.adoc @@ -4,7 +4,7 @@ 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. +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 Kill Bill 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 Kill Bill setup. Some of the capabilities offered by this feature include viewing detailed health metrics for all nodes within a Kill Bill installation, identifying and resolving issues such as stuck bus or notification entries, and generating comprehensive diagnostic reports to aid in troubleshooting and system optimization. == Getting Started with Aviate Health