Put Metric Filter

cloudwatchlogs_put_metric_filter

R Documentation

Creates or updates a metric filter and associates it with the specified log group

Description

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

The maximum number of metric filters that can be associated with a log group is 100.

Using regular expressions in filter patterns 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 filter patterns, 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.

Usage

cloudwatchlogs_put_metric_filter(logGroupName, filterName,
  filterPattern, metricTransformations, applyOnTransformedLogs)

Arguments

logGroupName

[required] The name of the log group.

filterName

[required] A name for the metric filter.

filterPattern

[required] A filter pattern for extracting metric data out of ingested log events.

metricTransformations

[required] A collection of information that defines how metric data gets emitted.

applyOnTransformedLogs

This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see put_transformer.

If the log group uses either a log-group level or account-level transformer, and you specify true, the metric filter will be applied on the transformed version of the log events instead of the original ingested log events.

Value

An empty list.

Request syntax

svc$put_metric_filter(
  logGroupName = "string",
  filterName = "string",
  filterPattern = "string",
  metricTransformations = list(
    list(
      metricName = "string",
      metricNamespace = "string",
      metricValue = "string",
      defaultValue = 123.0,
      dimensions = list(
        "string"
      ),
      unit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
    )
  ),
  applyOnTransformedLogs = TRUE|FALSE
)