Class MetricFilterProps

Properties for a MetricFilter.

Inheritance
System.Object
MetricFilterProps
Namespace: Amazon.CDK.AWS.Logs
Assembly: Amazon.CDK.AWS.Logs.dll
Syntax (csharp)
public class MetricFilterProps : Object, IMetricFilterProps, IMetricFilterOptions
Syntax (vb)
Public Class MetricFilterProps
    Inherits Object
    Implements IMetricFilterProps, IMetricFilterOptions
Remarks

ExampleMetadata: lit=test/integ.metricfilter.lit.ts infused

Examples
new MetricFilter(this, "MetricFilter", new MetricFilterProps {
    LogGroup = logGroup,
    MetricNamespace = "MyApp",
    MetricName = "Latency",
    FilterPattern = FilterPattern.Exists("$.latency"),
    MetricValue = "$.latency"
});

Synopsis

Constructors

MetricFilterProps()

Properties

DefaultValue

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

Pattern to search for log events.
LogGroup

The log group to create the filter on.
MetricName

The name of the metric to emit.
MetricNamespace

The namespace of the metric to emit.
MetricValue

The value to emit for the metric.

Constructors

MetricFilterProps()

public MetricFilterProps()

Properties

DefaultValue

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

public Nullable<double> DefaultValue { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Default: No metric emitted.

FilterPattern

Pattern to search for log events.

public IFilterPattern FilterPattern { get; set; }
Property Value

IFilterPattern

LogGroup

The log group to create the filter on.

public ILogGroup LogGroup { get; set; }
Property Value

ILogGroup

MetricName

The name of the metric to emit.

public string MetricName { get; set; }
Property Value

System.String

MetricNamespace

The namespace of the metric to emit.

public string MetricNamespace { get; set; }
Property Value

System.String

MetricValue

The value to emit for the metric.

public string MetricValue { get; set; }
Property Value

System.String

Remarks

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"

Implements