class Aws::CloudWatchLogs::Types::MetricTransformation

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

@note When making an API call, you may pass MetricTransformation

data as a hash:

    {
      metric_name: "MetricName", # required
      metric_namespace: "MetricNamespace", # required
      metric_value: "MetricValue", # required
      default_value: 1.0,
      dimensions: {
        "DimensionsKey" => "DimensionsValue",
      },
      unit: "Seconds", # accepts 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
    }

@!attribute [rw] metric_name

The name of the CloudWatch metric.
@return [String]

@!attribute [rw] metric_namespace

A custom namespace to contain your metric in CloudWatch. Use
namespaces to group together metrics that are similar. For more
information, see [Namespaces][1].

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace
@return [String]

@!attribute [rw] metric_value

The value to publish to the CloudWatch metric when a filter pattern
matches a log event.
@return [String]

@!attribute [rw] default_value

(Optional) The value to emit when a filter pattern does not match a
log event. This value can be null.
@return [Float]

@!attribute [rw] dimensions

The fields to use as dimensions for the metric. One metric filter
can include as many as three dimensions.

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.

 To help prevent accidental high charges, Amazon disables a metric
filter if it generates 1000 different name/value pairs for the
dimensions that you have specified within a certain amount of time.

 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][1].

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html
@return [Hash<String,String>]

@!attribute [rw] unit

The unit to assign to the metric. If you omit this, the unit is set
as `None`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/MetricTransformation AWS API Documentation

Constants

SENSITIVE