Interface IMetricFilterOptions
Properties for a MetricFilter created from a LogGroup.
Namespace: Amazon.CDK.AWS.Logs
Assembly: Amazon.CDK.Lib.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.CloudWatch;
using Amazon.CDK.AWS.Logs;
IFilterPattern filterPattern;
var metricFilterOptions = new MetricFilterOptions {
FilterPattern = filterPattern,
MetricName = "metricName",
MetricNamespace = "metricNamespace",
// the properties below are optional
DefaultValue = 123,
Dimensions = new Dictionary<string, string> {
{ "dimensionsKey", "dimensions" }
},
FilterName = "filterName",
MetricValue = "metricValue",
Unit = Unit.SECONDS
};
Synopsis
Properties
DefaultValue | The value to emit if the pattern does not match a particular event. |
Dimensions | The fields to use as dimensions for the metric. |
FilterName | The name of the metric filter. |
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. |
Unit | The unit to assign to 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.
Dimensions
The fields to use as dimensions for the metric.
virtual IDictionary<string, string> Dimensions { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
One metric filter can include as many as three dimensions.
Default: - No dimensions attached to metrics.
FilterName
The name of the metric filter.
virtual string FilterName { get; }
Property Value
System.String
Remarks
Default: - Cloudformation generated name.
FilterPattern
Pattern to search for log events.
IFilterPattern FilterPattern { get; }
Property Value
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"
Unit
The unit to assign to the metric.
virtual Nullable<Unit> Unit { get; }
Property Value
System.Nullable<Unit>
Remarks
Default: - No unit attached to metrics.