Added descriptions to SamplesForSampleKindAndHost model

killbill · Jan 14, 2025 · e544983 · e544983
1 parent 823e174
commit e544983
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/source/includes/_aviate-health-apis.md b/source/includes/_aviate-health-apis.md
@@ -6,17 +6,17 @@ The [Aviate Health feature](https://docs.killbill.io/latest/aviate-health) provi
 
 ### SamplesForSampleKindAndHost
 
-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