Container for the parameters to the PutMetricFilter operation. Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
Using regular expressions to create metric filters is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected
high charges, do not specify high-cardinality fields such as IPAddress or requestID
as dimensions. Each different value found for a dimension is treated as a separate
metric and accrues charges as a separate custom metric.
CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatchLogs.AmazonCloudWatchLogsRequest
Amazon.CloudWatchLogs.Model.PutMetricFilterRequest
Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z
Syntax
public class PutMetricFilterRequest : AmazonCloudWatchLogsRequest IAmazonWebServiceRequest
The PutMetricFilterRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutMetricFilterRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
PutMetricFilterRequest(string, string, string, List<MetricTransformation>) |
Instantiates PutMetricFilterRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ApplyOnTransformedLogs | System.Boolean |
Gets and sets the property ApplyOnTransformedLogs. This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.
If the log group uses either a log-group level or account-level transformer, and you
specify |
|
|
FilterName | System.String |
Gets and sets the property FilterName. A name for the metric filter. |
|
|
FilterPattern | System.String |
Gets and sets the property FilterPattern. A filter pattern for extracting metric data out of ingested log events. |
|
|
LogGroupName | System.String |
Gets and sets the property LogGroupName. The name of the log group. |
|
|
MetricTransformations | System.Collections.Generic.List<Amazon.CloudWatchLogs.Model.MetricTransformation> |
Gets and sets the property MetricTransformations. A collection of information that defines how metric data gets emitted. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5