Merge pull request #329 from reshmabidikar/work-for-TS-185

Added descriptions to SamplesForSampleKindAndHost model
killbill · Jan 15, 2025 · 1104e1b · 1104e1b
2 parents 56daa5f + 3699598
commit 1104e1b
Showing 1 changed file with 12 additions and 40 deletions.
diff --git a/source/includes/_aviate-health-apis.md b/source/includes/_aviate-health-apis.md
@@ -4,19 +4,19 @@ The [Aviate Health feature](https://docs.killbill.io/latest/aviate-health) provi
 
 ## Models
 
-### SamplesForSampleKindAndHost
+### MetricsResult
 
-It has the following fields:
+Represents metric result. It has the following fields:
 
 
-| Name                          | Type   | Generated by | Description                 |
-|-------------------------------|--------|--------------|-----------------------------|
-| **nodeName**                  | string | system       | Node name                   |
-| **eventGroup**                | string | system       | Event Group                 |
-| **eventCategory**             | string | system       | Event Category              |
-| **sampleKind**                | string | system       | Sample Kind                 |
-| **sampleSerializationFormat** | string | system       | Sample Serialization Format |
-| **samples**                   | string | system       | Samples                     |
+| Name                          | Type   | Generated by | Description                                                                                                                                                                                           |
+|-------------------------------|--------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **nodeName**                  | string | system       | Name of the node for which data is being captured.                                                                                                                                                    |
+| **eventGroup**                | string | system       | Represents the metric type. Possible values are `gauge`/`meter`/`timer`                                                                                                                               |
+| **eventCategory**             | string | system       | Represents the metric name.                                                                                                                                                                           |
+| **sampleKind**                | string | system       | Represents the sample kind. Possible values are `value`/`count`/`{one_minute/five_minute/fifteen_minute}_rate`/`mean_rate`/`tp99`/`tp999`/`tp75`/`tp98`/`tp95`/`min`/`max`/`count`/`median`/`std_dev` |
+| **sampleSerializationFormat** | string | system       | Sample Serialization Format . Hardcoded to `csv` at the time of writing                                                                                                                               |
+| **samples**                   | string | system       | Comma separated list of timestamp and data value.                                                                                                                                                     |
 
 
 ### HealthData
@@ -341,6 +341,8 @@ This endpoint returns metric data. This data can be used to assess the health of
 
 Some metrics are global to the deployment (i.e. independent of the number of Kill Bill nodes/containers deployed) and some others are per-node - in which case the `nodeName` parameter can be used to return metrics for a specific node.
 
+All the metrics exposed by the Aviate Plugin are documented [here](https://docs.killbill.io/latest/aviate-health#_aviate_metrics).
+
 **HTTP Request**
 
 `GET /plugins/aviate-plugin/v1/health/metrics`
@@ -426,36 +428,6 @@ None
 | **metricName**  | List of String         | false    | None         | Name of the metric for which to return data.(See list below). To obtain data for multiple metrics, include a separate `metricName` parameter for each metric.                                                                                                                                  |
 | **granularity** | SampleGranularity           | false    | `MINUTE`      | Specifies the time unit for the intervals between consecutive data points. One of `MINUTE`, `HOUR`, `DAY`)                                                                                                                                                                                                                                                                                                                                                            |
 
-Below is the list of metric names. Any of these can be specified as the value for the `metricName` parameter.
-
-* queue.bus.late
-* queue.bus.incoming
-* queue.bus.processing
-* queue.notifications.late
-* queue.notifications.incoming
-* queue.notifications.processing
-* logs.rates.warn
-* logs.rates.error
-* servlets.responses.ok
-* servlets.responses.created
-* servlets.responses.badRequest
-* servlets.responses.noContent
-* servlets.responses.notFound
-* servlets.responses.serverError
-* servlets.responses.other
-* main.pool.TotalConnections
-* main.pool.ActiveConnections
-* main.pool.IdleConnections
-* main.pool.Wait
-* osgi.pool.TotalConnections
-* osgi.pool.ActiveConnections
-* osgi.pool.IdleConnections
-* osgi.pool.Wait
-* shiro.pool.TotalConnections
-* shiro.pool.ActiveConnections
-* shiro.pool.IdleConnections
-* shiro.pool.Wait
-
 **Response**
 
 If successful, returns a status code of 200 and the requested metric data.