Documentation

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

See: newMetricTransformation smart constructor.

Create a value of MetricTransformation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultValue:MetricTransformation', metricTransformation_defaultValue - (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

$sel:dimensions:MetricTransformation', metricTransformation_dimensions - The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

$sel:unit:MetricTransformation', metricTransformation_unit - The unit to assign to the metric. If you omit this, the unit is set as None.

$sel:metricName:MetricTransformation', metricTransformation_metricName - The name of the CloudWatch metric.

$sel:metricNamespace:MetricTransformation', metricTransformation_metricNamespace - A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

$sel:metricValue:MetricTransformation', metricTransformation_metricValue - The value to publish to the CloudWatch metric when a filter pattern matches a log event.

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

The unit to assign to the metric. If you omit this, the unit is set as None.

The name of the CloudWatch metric.

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

The value to publish to the CloudWatch metric when a filter pattern matches a log event.