Package software.amazon.awscdk.services.logs

Interface CfnMetricFilter.DimensionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMetricFilter.DimensionProperty.Jsii$Proxy

Enclosing class:

CfnMetricFilter

@Stability(Stable)
public static interface CfnMetricFilter.DimensionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.logs.*;
 DimensionProperty dimensionProperty = DimensionProperty.builder()
         .key("key")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMetricFilter.DimensionProperty.Builder	A builder for CfnMetricFilter.DimensionProperty
static final class	CfnMetricFilter.DimensionProperty.Jsii$Proxy	An implementation for CfnMetricFilter.DimensionProperty

Method Summary

Modifier and Type	Method	Description
static CfnMetricFilter.DimensionProperty.Builder	builder()
String	getKey()	The name for the CloudWatch metric dimension that the metric filter creates.
String	getValue()	The log event field that will contain the value for this dimension.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKey

@Stability(Stable)
@NotNull
String getKey()

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 (:).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html#cfn-logs-metricfilter-dimension-key

getValue

@Stability(Stable)
@NotNull
String getValue()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html#cfn-logs-metricfilter-dimension-value

builder

@Stability(Stable)
static CfnMetricFilter.DimensionProperty.Builder builder()

Returns:

a CfnMetricFilter.DimensionProperty.Builder of CfnMetricFilter.DimensionProperty