Skip to content

/AWS1/CL_CWLMETRICTRANSFMTION

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_metricname TYPE /AWS1/CWLMETRICNAME /AWS1/CWLMETRICNAME

The name of the CloudWatch metric.

iv_metricnamespace TYPE /AWS1/CWLMETRICNAMESPACE /AWS1/CWLMETRICNAMESPACE

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

iv_metricvalue TYPE /AWS1/CWLMETRICVALUE /AWS1/CWLMETRICVALUE

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

Optional arguments:

iv_defaultvalue TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

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

it_dimensions TYPE /AWS1/CL_CWLDIMENSIONS_W=>TT_DIMENSIONS TT_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.

CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

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.

iv_unit TYPE /AWS1/CWLSTANDARDUNIT /AWS1/CWLSTANDARDUNIT

The unit to assign to the metric. If you omit this, the unit is set as None.


Queryable Attributes

metricName

The name of the CloudWatch metric.

Accessible with the following methods

Method Description
GET_METRICNAME() Getter for METRICNAME, with configurable default
ASK_METRICNAME() Getter for METRICNAME w/ exceptions if field has no value
HAS_METRICNAME() Determine if METRICNAME has a value

metricNamespace

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

Accessible with the following methods

Method Description
GET_METRICNAMESPACE() Getter for METRICNAMESPACE, with configurable default
ASK_METRICNAMESPACE() Getter for METRICNAMESPACE w/ exceptions if field has no val
HAS_METRICNAMESPACE() Determine if METRICNAMESPACE has a value

metricValue

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

Accessible with the following methods

Method Description
GET_METRICVALUE() Getter for METRICVALUE, with configurable default
ASK_METRICVALUE() Getter for METRICVALUE w/ exceptions if field has no value
HAS_METRICVALUE() Determine if METRICVALUE has a value

defaultValue

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

Accessible with the following methods

Method Description
GET_DEFAULTVALUE() Getter for DEFAULTVALUE, with configurable default
ASK_DEFAULTVALUE() Getter for DEFAULTVALUE w/ exceptions if field has no value
STR_DEFAULTVALUE() String format for DEFAULTVALUE, with configurable default
HAS_DEFAULTVALUE() Determine if DEFAULTVALUE has a value

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.

CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

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.

Accessible with the following methods

Method Description
GET_DIMENSIONS() Getter for DIMENSIONS, with configurable default
ASK_DIMENSIONS() Getter for DIMENSIONS w/ exceptions if field has no value
HAS_DIMENSIONS() Determine if DIMENSIONS has a value

unit

The unit to assign to the metric. If you omit this, the unit is set as None.

Accessible with the following methods

Method Description
GET_UNIT() Getter for UNIT, with configurable default
ASK_UNIT() Getter for UNIT w/ exceptions if field has no value
HAS_UNIT() Determine if UNIT has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_METRICTRANSFORMATIONS

TYPES TT_METRICTRANSFORMATIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWLMETRICTRANSFMTION WITH DEFAULT KEY
.