diff --git a/docs/sources/reference/components/prometheus/prometheus.exporter.cloudwatch.md b/docs/sources/reference/components/prometheus/prometheus.exporter.cloudwatch.md index 1c5269772b..ac96595f32 100644 --- a/docs/sources/reference/components/prometheus/prometheus.exporter.cloudwatch.md +++ b/docs/sources/reference/components/prometheus/prometheus.exporter.cloudwatch.md @@ -116,12 +116,13 @@ prometheus.exporter.cloudwatch "queues" { You can use the following arguments with `prometheus.exporter.cloudwatch`: | Name | Type | Description | Default | Required | -|---------------------------|---------------------|--------------------------------------------------------------------------------|---------|----------| +| ------------------------- | ------------------- | ------------------------------------------------------------------------------ | ------- | -------- | | `sts_region` | `string` | AWS region to use when calling [STS][] for retrieving account information. | | yes | | `aws_sdk_version_v2` | `bool` | Use AWS SDK version 2. | `false` | no | | `fips_disabled` | `bool` | Disable use of FIPS endpoints. Set 'true' when running outside of USA regions. | `true` | no | | `debug` | `bool` | Enable debug logging on CloudWatch exporter internals. | `false` | no | | `discovery_exported_tags` | `map(list(string))` | List of tags (value) per service (key) to export in all metrics. | `{}` | no | +| `labels_to_snake_case` | `bool` | Convert label names to snake_case. | `false` | no | If you define the `["name", "type"]` under `"AWS/EC2"` in the `discovery_exported_tags` argument, it exports the name and type tags and its values as labels in all metrics. This affects all discovery jobs. @@ -133,7 +134,7 @@ This affects all discovery jobs. You can use the following blocks with `prometheus.exporter.cloudwatch`: | Name | Description | Required | -|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | [`discovery`][discovery] | Configures a discovery job. You can configure multiple jobs. | no\* | | `discovery` > [`role`][role] | Configures the IAM roles the job should assume to scrape metrics. Defaults to the role configured in the environment {{< param "PRODUCT_NAME" >}} runs on. | no | | `discovery` > [`metric`][metric] | Configures the list of metrics the job should scrape. You can define multiple metrics inside one job. | yes | @@ -191,15 +192,18 @@ prometheus.exporter.cloudwatch "discover_instances" { You can configure the `discovery` block one or multiple times to scrape metrics from different services or with different `search_tags`. | Name | Type | Description | Default | Required | -|-------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|----------| +| ----------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------- | | `regions` | `list(string)` | List of AWS regions. | | yes | | `type` | `string` | CloudWatch service alias (`"alb"`, `"ec2"`, etc) or namespace name (`"AWS/EC2"`, `"AWS/S3"`, etc). Refer to [supported-services][] for a complete list. | | yes | | `custom_tags` | `map(string)` | Custom tags to be added as a list of key / value pairs. When exported to Prometheus format, the label name follows the following format: `custom_tag_{key}`. | `{}` | no | | `dimension_name_requirements` | `list(string)` | List of metric dimensions to query. Before querying metric values, the total list of metrics are filtered to only those that contain exactly this list of dimensions. An empty or undefined list results in all dimension combinations being included. | `{}` | no | -| `delay` | `duration` | Delay the start time of the CloudWatch metrics query by this duration. | `0` | no | +| `delay` | `duration` | Delay the start time of the CloudWatch metrics query by this duration. | `0` | no | +| `period` | `duration` | Default period for metrics in this job. | `5m` | no | +| `length` | `duration` | Default length for metrics in this job. | `5m` | no | | `nil_to_zero` | `bool` | When `true`, `NaN` metric values are converted to 0. Individual metrics can override this value in the [metric][] block. | `true` | no | | `recently_active_only` | `bool` | Only return metrics that have been active in the last 3 hours. | `false` | no | | `search_tags` | `map(string)` | List of key / value pairs to use for tag filtering (all must match). The value can be a regular expression. | `{}` | no | +| `add_cloudwatch_timestamp` | `bool` | When `true`, use the timestamp from CloudWatch instead of the scrape time. | `false` | no | [supported-services]: #supported-services-in-discovery-jobs @@ -248,7 +252,7 @@ static "