MetricFilterOptions

class aws_cdk.aws_logs.MetricFilterOptions(*, filter_pattern, metric_name, metric_namespace, default_value=None, metric_value=None)

Bases: object

__init__(*, filter_pattern, metric_name, metric_namespace, default_value=None, metric_value=None)

Properties for a MetricFilter created from a LogGroup.

Parameters
  • filter_pattern (IFilterPattern) – Pattern to search for log events.

  • metric_name (str) – The name of the metric to emit.

  • metric_namespace (str) – The namespace of the metric to emit.

  • default_value (Union[int, float, None]) – The value to emit if the pattern does not match a particular event. Default: No metric emitted.

  • metric_value (Optional[str]) – 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’. Default: “1”

Attributes

default_value

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

default :default: No metric emitted.

Return type

Union[int, float, None]

filter_pattern

Pattern to search for log events.

Return type

IFilterPattern

metric_name

The name of the metric to emit.

Return type

str

metric_namespace

The namespace of the metric to emit.

Return type

str

metric_value

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’.

default :default: “1”

Return type

Optional[str]