Merge pull request #579 from reshmabidikar/aviate-health

Aviate Health Doc

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

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
 

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 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
+
+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].
+
+