MetricFilterOptions

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

Bases: object

Properties for a MetricFilter created from a LogGroup.

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

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

  • 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”

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_logs as logs

# filter_pattern is of type IFilterPattern

metric_filter_options = logs.MetricFilterOptions(
    filter_pattern=filter_pattern,
    metric_name="metricName",
    metric_namespace="metricNamespace",

    # the properties below are optional
    default_value=123,
    metric_value="metricValue"
)

Attributes

default_value

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

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

“1”

Return type

Optional[str]