aws-cdk-lib.aws_logs.MetricFilterOptions

MetricFilterOptions Struct

Properties for a MetricFilter created from a LogGroup.

Source

aws-logs/lib/log-group.ts

Type last changed

v2.220.0 · 14 Oct 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';

declare const filterPattern: logs.IFilterPattern;
const metricFilterOptions: logs.MetricFilterOptions = {
  filterPattern: filterPattern,
  metricName: 'metricName',
  metricNamespace: 'metricNamespace',

  // the properties below are optional
  applyOnTransformedLogs: false,
  defaultValue: 123,
  dimensions: {
    dimensionsKey: 'dimensions',
  },
  filterName: 'filterName',
  metricValue: 'metricValue',
  unit: cloudwatch.Unit.SECONDS,
};

Properties

applyOnTransformedLogsbooleanapply_on_transformed_logsboolapplyOnTransformedLogsBooleanApplyOnTransformedLogsboolApplyOnTransformedLogs*bool= false#

Whether the metric filter is applied on the tranformed logs.

This parameter is valid only for log groups that have an active log transformer. If this value is true, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.

defaultValuenumberdefault_valueint | floatdefaultValueNumberDefaultValuedoubleDefaultValue*float64= No metric emitted.#

The value to emit if the pattern does not match a particular event.

dimensions{ [key: string]: string }dimensionstyping.Mapping[str, str]dimensionsMap<String, String>DimensionsIDictionary<string, string>Dimensions*map[string]*string= No dimensions attached to metric…#

The fields to use as dimensions for the metric.

One metric filter can include as many as three dimensions.

default

Default: No dimensions attached to metrics.

filterNamestringfilter_namestrfilterNameStringFilterNamestringFilterName*string= Cloudformation generated name.#

The name of the metric filter.

filterPatternIFilterPatternfilter_patternIFilterPatternfilterPatternIFilterPatternFilterPatternIFilterPatternFilterPatternIFilterPatternrequired#

Pattern to search for log events.

metricNamestringmetric_namestrmetricNameStringMetricNamestringMetricName*stringrequired#

The name of the metric to emit.

metricNamespacestringmetric_namespacestrmetricNamespaceStringMetricNamespacestringMetricNamespace*stringrequired#

The namespace of the metric to emit.

metricValuestringmetric_valuestrmetricValueStringMetricValuestringMetricValue*string= "1"#

The value to emit for the metric.

notes

Can either be a literal number (typically "1"), or the name of a field in the structure to take the value from the matched event. If you are using a field value, the field value must have been matched using the pattern.

If you want to specify a field from a matched JSON structure, use '$.fieldNam{e}^{\prime },andmakesurethefieldisinthepattern(ifonlya{s}^{\prime }$.fieldName = *').

If you want to specify a field from a matched space-delimited structure, use '$fieldName'.

unitUnitunitUnitunitUnitUnitUnitUnitUnit= No unit attached to metrics.#

The unit to assign to the metric.