From c304cfa4eba8c93e1096878d579219c6ce2c07f2 Mon Sep 17 00:00:00 2001 From: Nick Hill Date: Thu, 16 Nov 2023 15:54:43 -0800 Subject: [PATCH] docs: Add `per_model_metrics` parameter to metrics.md Functionality added in #90 Signed-off-by: Nick Hill --- docs/metrics.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/metrics.md b/docs/metrics.md index b999135c..77bd9462 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -11,11 +11,13 @@ The `MM_METRICS` env variable can be used to configure or disable how metrics ar | | Purpose | Applies to | Default | |:------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------:|:----------------------------------:| -| `port` | Port on which to send or serve metrics | statsd (UDP push), prometheus (HTTP/HTTPS serve) | 8126 (statsd), 2112 (prometheus) | -| `fq_names` | Whether to use fully-qualified method names in request metrics | statsd, prometheus | false | -| `legacy` | Whether to publish legacy flavour (non-Sysdig) statsd metrics. Note that the legacy metrics are equivalent but have different names to those in the table below | statsd | false | -| `scheme` | Protocol scheme to use for Prometheus metrics, can be http or https | prometheus | https | +| `port` | Port on which to send or serve metrics | statsd (UDP push), prometheus (HTTP/HTTPS serve) | `8126` (statsd), `2112` (prometheus)| +| `fq_names` | Whether to use fully-qualified method names in request metrics | statsd, prometheus | `false` | +| `legacy` | Whether to publish legacy flavour (non-Sysdig) statsd metrics. Note that the legacy metrics are equivalent but have different names to those in the table below | statsd | `false` | +| `scheme` | Protocol scheme to use for Prometheus metrics, can be `http` or `https` | prometheus | `https` | +|`per_model_metrics`|Whether to include the `modelId` and `vModelId` labels in applicable published metrics|prometheus|`false` (*)| +(*) In versions of model-mesh between Sep 5 2023 and Nov 16 2023, the default value of per_model_metrics was (unintentionally) `true`. ### Capturing Prometheus metrics @@ -61,4 +63,4 @@ prometheus.io/scrape: "true" | modelmesh_instance_capacity_bytes | Gauge | Pod | Effective model capacity of pod excluding unload buffer | | modelmesh_instance_used_bytes | Gauge | Pod | Amount of capacity currently in use by loaded models | | modelmesh_instance_used_bps | Gauge | Pod | Amount of capacity used in basis points (100ths of percent) | -| modelmesh_instance_models_total | Gauge | Pod | Number of model copies loaded in pod | \ No newline at end of file +| modelmesh_instance_models_total | Gauge | Pod | Number of model copies loaded in pod |