Class | AWS::CloudWatch::MetricCollection |
In: |
lib/aws/cloud_watch/metric_collection.rb
|
Parent: | Object |
Returns a new collection that will filter results when enumerated.
@example Filtering by a namespace
traffic_metrics = metrics.filter('namespace', 'traffic')
@example Filtering by a metric name
my_metric = metrics.filter('metric_name', 'my-metric').first
@example Filtering by one or more dimensions
metrics = metrics.filter('dimensions', [ { :name => 'n1', :value => 'v1' }, { :name => 'n2', :value => 'v2' }, { :name => 'n3', :value => 'v3' }, ])
@param [String,Symbol] name @param [String,Array<String>] value @return [MetricCollection]
Returns a collection filtered by the given dimension:
metric = metrics.with_dimension('name', 'value').first
You can chain calls to with_dimension. Additional dimensions are added.
metrics = metrics. with_dimension('d1', 'v1'). with_dimension('d2', 'v2'). with_dimension('d3', 'v3') metrics.each{|metric|} # filtered by all three dimensions
@param [String] name @param [String] value @return [MetricCollection]
Returns a collection filtered by the given dimensions.
metrics.with_dimensions([ { :name => 'd1', :value => 'v1' }, { :name => 'd2', :value => 'v2' }, { :name => 'd3', :value => 'v3' }, ]).each do |metric| # ... end
Multiple calls to with_dimensions will add to previous dimensions. @param [Array<Hash>] dimensions An array of dimensions. Each dimension
should be a Hash with a `:name` and `:value`.
@return [MetricCollection]