ezmetrics 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d26fa5d7a779917ac2ba154e82f29745a22b64261442117d15b286d0e06276
-  data.tar.gz: 44ff087c54cf0e5fdf8763b88deaa59f3ccdfa1e11c12ab5c1da2eebdeea7764
+  metadata.gz: 408332cfc86d05b75d8b6004098d736ad60a624189f46022af822fdf6c24960d
+  data.tar.gz: 6d4ef89fa6a80e28cb443e16f1528b351a93bf7bf50e2a8fc756dc943a25f11f
 SHA512:
-  metadata.gz: 6bf28edd6c644648198905bcdf50a77a0083c53b6eba312b709e9c1cb951adba1c407cbc28ac3ae0588b15185b5aa0132ef1f568ff30af0158b770d388460885
-  data.tar.gz: a08685fea3025b23e5dca7439e9b7f4f2313933363b01a716e68eba800e4b96fce0d976cf25111c0e7a36f655abb6497e3481d39caba881b2ee706e49958b365
+  metadata.gz: 99a4ac48560305d2967cdcc8b248978ee3f0748ab1fb7da2830a3804d732d29664f25bfdc4bd2bfa50c449994913ecd455362f57af1f39f0f45e904e36876c12
+  data.tar.gz: c53617fbc324765b9b388b1280b6d363a3707b002a2718cd0467a16ff24708a8adbf81a812aca111a643924de4834a155efdef252911195570837fdb8f6a9dce

data/README.md

@@ -27,25 +27,25 @@ and stores them for the timeframe you specified, 60 seconds by default.
 You can change the timeframe according to your needs and save the metrics by calling `log` method:
 
 ```ruby
-  # Store the metrics for 60 seconds (default behaviour)
-  EZmetrics.new.log(
-    duration: 100.5,
-    views:    40.7,
-    db:       59.8,
-    queries:  4,
-    status:   200
-  )
+# Store the metrics for 60 seconds (default behaviour)
+EZmetrics.new.log(
+  duration: 100.5,
+  views:    40.7,
+  db:       59.8,
+  queries:  4,
+  status:   200
+)
 ```
 
 ```ruby
-  # Store the metrics for 10 minutes
-  EZmetrics.new(10.minutes).log(
-    duration: 100.5,
-    views:    40.7,
-    db:       59.8,
-    queries:  4,
-    status:   200
-  )
+# Store the metrics for 10 minutes
+EZmetrics.new(10.minutes).log(
+  duration: 100.5,
+  views:    40.7,
+  db:       59.8,
+  queries:  4,
+  status:   200
+)
 ```
 
 ---
@@ -53,13 +53,13 @@ You can change the timeframe according to your needs and save the metrics by cal
 For displaying metrics you need to call `show` method:
 
 ```ruby
-  # Aggregate and show metrics for last 60 seconds (default behaviour)
-  EZmetrics.new.show
+# Aggregate and show metrics for last 60 seconds (default behaviour)
+EZmetrics.new.show
 ```
 
 ```ruby
-  # Aggregate and show metrics for last 10 minutes
-  EZmetrics.new(10.minutes).show
+# Aggregate and show metrics for last 10 minutes
+EZmetrics.new(10.minutes).show
 ```
 
 You can combine these timeframes, for example - store for 10 minutes, display for 5 minutes.
@@ -131,6 +131,47 @@ This will return a hash with the following structure:
 }
 ```
 
+---
+
+If you prefer a single level object - you can change the default output structure by calling `.flatten` before `.show`
+
+```ruby
+EZmetrics.new(1.hour).flatten.show(db: :avg, duration: [:avg, :max])
+```
+
+```ruby
+{
+  db_avg:       182,
+  duration_avg: 205,
+  duration_max: 5171
+}
+```
+
+---
+
+Same for [partitioned aggregation](#partitioning)
+
+```ruby
+EZmetrics.new(1.hour).partition_by(:minute).flatten.show(db: :avg, duration: [:avg, :max])
+```
+
+```ruby
+[
+  {
+    timestamp:    1575242880,
+    db_avg:       387,
+    duration_avg: 477,
+    duration_max: 8566
+  },
+  {
+    timestamp:    1575242940,
+    db_avg:       123,
+    duration_avg: 234,
+    duration_max: 3675
+  }
+]
+```
+
 ### Aggregation
 
 The aggregation can be easily configured by specifying aggregation options as in the following examples:
@@ -221,11 +262,11 @@ EZmetrics.new.show(views: :avg, :db: [:avg, :max], requests: true)
 
 If you want to visualize your metrics by using a **line chart**, you will need to use partitioning.
 
-To aggregate metrics, partitioned by a unit of time you need to call `partition_by({time_unit})` before calling `show`
+To aggregate metrics, partitioned by a unit of time you need to call `.partition_by({time_unit})` before calling `.show`
 
 ```ruby
-  # Aggregate metrics for last hour, partition by minute
-  EZmetrics.new(1.hour).partition_by(:minute).show(duration: [:avg, :max], db: :avg)
+# Aggregate metrics for last hour, partition by minute
+EZmetrics.new(1.hour).partition_by(:minute).show(duration: [:avg, :max], db: :avg)
 ```
 
 This will return an array of objects with the following structure:

data/lib/ezmetrics.rb

@@ -63,6 +63,11 @@ class EZmetrics
     partitioned_metrics ? aggregate_partitioned_data : aggregate_data
   end
 
+  def flatten
+    @flat = true
+    self
+  end
+
   def partition_by(time_unit=:minute)
     time_unit = PARTITION_UNITS.include?(time_unit) ? time_unit : :minute
     @partitioned_metrics = interval_metrics.group_by { |h| second_to_partition_unit(time_unit, h["second"]) }
@@ -71,7 +76,7 @@ class EZmetrics
 
   private
 
-  attr_reader :redis, :interval_seconds, :interval_metrics, :requests,
+  attr_reader :redis, :interval_seconds, :interval_metrics, :requests, :flat,
     :storage_key, :safe_payload, :this_second_metrics, :partitioned_metrics, :options
 
   def aggregate_data
@@ -86,7 +91,7 @@ class EZmetrics
     partitioned_metrics.map do |partition, metrics|
       @interval_metrics = metrics
       @requests = interval_metrics.sum { |hash| hash["statuses"]["all"] }
-      { timestamp: partition, data: build_result }
+      flat ? { timestamp: partition, **build_result } : { timestamp: partition, data: build_result }
     end
   rescue
     new(options)
@@ -95,7 +100,9 @@ class EZmetrics
   def build_result
     result = {}
 
-    result[:requests] = { all: requests, grouped: count_all_status_groups } if options[:requests]
+    if options[:requests]
+      append_requests_to_result(result, { all: requests, grouped: count_all_status_groups })
+    end
 
     options.each do |metrics, aggregation_functions|
       next unless METRICS.include?(metrics)
@@ -103,8 +110,8 @@ class EZmetrics
       next unless aggregation_functions.any?
 
       aggregation_functions.each do |aggregation_function|
-        result[metrics] ||= {}
-        result[metrics][aggregation_function] = aggregate(metrics, aggregation_function)
+        aggregated_metrics = aggregate(metrics, aggregation_function)
+        append_metrics_to_result(result, metrics, aggregation_function, aggregated_metrics)
       end
     end
     result
@@ -112,6 +119,22 @@ class EZmetrics
     result
   end
 
+  def append_requests_to_result(result, aggregated_requests)
+    return result[:requests] = aggregated_requests unless flat
+
+    result[:requests_all] = aggregated_requests[:all]
+    aggregated_requests[:grouped].each do |group, counter|
+      result[:"requests_#{group}"] = counter
+    end
+  end
+
+  def append_metrics_to_result(result, metrics, aggregation_function, aggregated_metrics)
+    return result[:"#{metrics}_#{aggregation_function}"] = aggregated_metrics if flat
+
+    result[metrics] ||= {}
+    result[metrics][aggregation_function] = aggregated_metrics
+  end
+
   def second_to_partition_unit(time_unit, second)
     return second if time_unit == :second
     time = Time.at(second)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezmetrics
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Nicolae Rotaru