aws-cdk-lib.aws_logs.MetricFilterProps

interface MetricFilterProps

LanguageType name
.NETAmazon.CDK.AWS.Logs.MetricFilterProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslogs#MetricFilterProps
Javasoftware.amazon.awscdk.services.logs.MetricFilterProps
Pythonaws_cdk.aws_logs.MetricFilterProps
TypeScript (source)aws-cdk-lib » aws_logs » MetricFilterProps

Properties for a MetricFilter.

Example

new MetricFilter(this, 'MetricFilter', {
  logGroup,
  metricNamespace: 'MyApp',
  metricName: 'Latency',
  filterPattern: FilterPattern.exists('$.latency'),
  metricValue: '$.latency',
});

Properties

NameTypeDescription
filterPatternIFilterPatternPattern to search for log events.
logGroupILogGroupThe log group to create the filter on.
metricNamestringThe name of the metric to emit.
metricNamespacestringThe namespace of the metric to emit.
defaultValue?numberThe value to emit if the pattern does not match a particular event.
dimensions?{ [string]: string }The fields to use as dimensions for the metric.
filterName?stringThe name of the metric filter.
metricValue?stringThe value to emit for the metric.
unit?UnitThe unit to assign to the metric.

filterPattern

Type: IFilterPattern

Pattern to search for log events.


logGroup

Type: ILogGroup

The log group to create the filter on.


metricName

Type: string

The name of the metric to emit.


metricNamespace

Type: string

The namespace of the metric to emit.


defaultValue?

Type: number (optional, default: No metric emitted.)

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


dimensions?

Type: { [string]: string } (optional, default: No dimensions attached to metrics.)

The fields to use as dimensions for the metric.

One metric filter can include as many as three dimensions.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-dimensions


filterName?

Type: string (optional, default: Cloudformation generated name.)

The name of the metric filter.


metricValue?

Type: string (optional, default: "1")

The value to emit for the metric.

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 '$.fieldName', and make sure the field is in the pattern (if only as '$.fieldName = *').

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


unit?

Type: Unit (optional, default: No unit attached to metrics.)

The unit to assign to the metric.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-unit