Class: Aws::CloudWatchLogs::Types::MetricFilter

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_on_transformed_logsBoolean

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

If this value is ‘true`, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html

Returns:

  • (Boolean)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 4440

class MetricFilter < Struct.new(
  :filter_name,
  :filter_pattern,
  :metric_transformations,
  :creation_time,
  :log_group_name,
  :apply_on_transformed_logs)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeInteger

The creation time of the metric filter, expressed as the number of milliseconds after ‘Jan 1, 1970 00:00:00 UTC`.

Returns:

  • (Integer)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 4440

class MetricFilter < Struct.new(
  :filter_name,
  :filter_pattern,
  :metric_transformations,
  :creation_time,
  :log_group_name,
  :apply_on_transformed_logs)
  SENSITIVE = []
  include Aws::Structure
end

#filter_nameString

The name of the metric filter.

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 4440

class MetricFilter < Struct.new(
  :filter_name,
  :filter_pattern,
  :metric_transformations,
  :creation_time,
  :log_group_name,
  :apply_on_transformed_logs)
  SENSITIVE = []
  include Aws::Structure
end

#filter_patternString

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 4440

class MetricFilter < Struct.new(
  :filter_name,
  :filter_pattern,
  :metric_transformations,
  :creation_time,
  :log_group_name,
  :apply_on_transformed_logs)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_nameString

The name of the log group.

Returns:

  • (String)


4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 4440

class MetricFilter < Struct.new(
  :filter_name,
  :filter_pattern,
  :metric_transformations,
  :creation_time,
  :log_group_name,
  :apply_on_transformed_logs)
  SENSITIVE = []
  include Aws::Structure
end

#metric_transformationsArray<Types::MetricTransformation>

The metric transformations.

Returns:



4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 4440

class MetricFilter < Struct.new(
  :filter_name,
  :filter_pattern,
  :metric_transformations,
  :creation_time,
  :log_group_name,
  :apply_on_transformed_logs)
  SENSITIVE = []
  include Aws::Structure
end