1.204.0

interface DimensionProperty

LanguageType name
.NETAmazon.CDK.AWS.Logs.CfnMetricFilter.DimensionProperty
Javasoftware.amazon.awscdk.services.logs.CfnMetricFilter.DimensionProperty
Pythonaws_cdk.aws_logs.CfnMetricFilter.DimensionProperty
TypeScript @aws-cdk/aws-logs » CfnMetricFilter » DimensionProperty

Specifies the CloudWatch metric dimensions to publish with this metric.

Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric.

For more information about publishing dimensions with metrics created by metric filters, see Publishing dimensions with metrics from values in JSON or space-delimited log events .

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 AWS Charges .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as logs from '@aws-cdk/aws-logs';
const dimensionProperty: logs.CfnMetricFilter.DimensionProperty = {
  key: 'key',
  value: 'value',
};

Properties

NameTypeDescription
keystringThe name for the CloudWatch metric dimension that the metric filter creates.
valuestringThe log event field that will contain the value for this dimension.

key

Type: string

The name for the CloudWatch metric dimension that the metric filter creates.

Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).

value

Type: string

The log event field that will contain the value for this dimension.

This dimension will only be published for a metric if the value is found in the log event. For example, $.eventType for JSON log events, or $server for space-delimited log events.

← PreviousNext →