From 6e4711a29b7078dc842df50980e43c38f714d54f Mon Sep 17 00:00:00 2001 From: Kyle Eckhart Date: Fri, 3 Nov 2023 10:54:45 -0400 Subject: [PATCH] Add docs for validate_dimensions --- .../flow/reference/components/prometheus.exporter.azure.md | 3 +++ .../configuration/integrations/azure-exporter-config.md | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/docs/sources/flow/reference/components/prometheus.exporter.azure.md b/docs/sources/flow/reference/components/prometheus.exporter.azure.md index ef98bc727533..bb571cf302b6 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.azure.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.azure.md @@ -75,6 +75,7 @@ Omitted fields take their default values. | `azure_cloud_environment` | `string` | Name of the cloud environment to connect to. | `"azurecloud"` | no | | `metric_name_template` | `string` | Metric template used to expose the metrics. | `"azure_{type}_{metric}_{aggregation}_{unit}"` | no | | `metric_help_template` | `string` | Description of the metric. | `"Azure metric {metric} for {type} with aggregation {aggregation} as {unit}"` | no | +| `validate_dimensions` | `bool` | Enable dimension validation in the azure sdk | `false` | no | The list of available `resource_type` values and their corresponding `metrics` can be found in [Azure Monitor essentials][]. @@ -90,6 +91,8 @@ Tags in `included_resource_tags` will be added as labels with the name `tag_ | default = "azurecloud"] + + # Optional: validation is disabled by default to reduce the number of azure exporter instances required when a `resource_type` has metrics with varying dimensions. + # Choosing to enable `validate_dimensions` will require 1 exporter instance per metric + dimension combination which can be very tedious to maintain. + [validate_dimensions: | default = false] ``` ### Examples