Interface IMetricFilterOptions

Properties for a MetricFilter created from a LogGroup.

Namespace: Amazon.CDK.AWS.Logs

Assembly: Amazon.CDK.AWS.Logs.dll

Syntax (csharp)

public interface IMetricFilterOptions

Syntax (vb)

Public Interface IMetricFilterOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Logs;

IFilterPattern filterPattern;

MetricFilterOptions metricFilterOptions = new MetricFilterOptions {
    FilterPattern = filterPattern,
    MetricName = "metricName",
    MetricNamespace = "metricNamespace",

    // the properties below are optional
    DefaultValue = 123,
    MetricValue = "metricValue"
};

Synopsis

Properties

DefaultValue	The value to emit if the pattern does not match a particular event.
FilterPattern	Pattern to search for log events.
MetricName	The name of the metric to emit.
MetricNamespace	The namespace of the metric to emit.
MetricValue	The value to emit for the metric.

Properties

DefaultValue

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

virtual Nullable<double> DefaultValue { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: No metric emitted.

FilterPattern

Pattern to search for log events.

IFilterPattern FilterPattern { get; }

Property Value

IFilterPattern

MetricName

The name of the metric to emit.

string MetricName { get; }

Property Value

System.String

MetricNamespace

The namespace of the metric to emit.

string MetricNamespace { get; }

Property Value

System.String

MetricValue

The value to emit for the metric.

virtual string MetricValue { get; }

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"