Add docs for validate_dimensions

grafana · Dec 21, 2023 · 6e4711a · 6e4711a
1 parent ccff42f
commit 6e4711a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git 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_<tag
 
 Valid values for `azure_cloud_environment` are `azurecloud`, `azurechinacloud`, `azuregovernmentcloud` and `azurepprivatecloud`.
 
+`validate_dimensions` is disabled by default to reduce the number of azure exporter instances requires when a `resource_type` has metrics with varying dimensions. When `validate_dimensions` is enabled you will need 1 exporter instance per metric + dimension combination which is more tedious to maintain.  
+
 [Kusto query]: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/
 [Azure Monitor essentials]: https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported
 [ISO8601 Duration]: https://en.wikipedia.org/wiki/ISO_8601#Durations

diff --git a/docs/sources/static/configuration/integrations/azure-exporter-config.md b/docs/sources/static/configuration/integrations/azure-exporter-config.md
@@ -153,6 +153,10 @@ The account used by Grafana Agent needs:
 
   # Optional: Which azure cloud environment to connect to, azurecloud, azurechinacloud, azuregovernmentcloud, or azurepprivatecloud
   [azure_cloud_environment: <string> | 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: <bool> | default = false]
 ```
 
 ### Examples