ezmetrics 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 518d9350ed026801311bdc695857fdd057856f6b7fe40715bf8072c990e8e5b8
-  data.tar.gz: 7d36fbd3e63994789ce8ac04212fb44c30041fd33f7173fbfdf1a6257beea99a
+  metadata.gz: 0affbdfcda841ffe4eec9105ded5526b13d209ccf0aa564e1b84c91651079d0e
+  data.tar.gz: 8c0f3879ee0f2cedeba7f6b0526f679ef9962e2270c7639837821f226a0f3580
 SHA512:
-  metadata.gz: 42e990916d474ed52f08330bd7210b4c6f464a0199354cfc1fe3710817b9d57790d445d0d1f88c8fccd6daeb627638a80dd8b578c685544f6a4f9c7765522a5f
-  data.tar.gz: 5b49eec021acaef39af2c9401681fa85f02d368f36231a60a64faf595e5b0c1432ce07a67fb86ce9c8b3041835fd4480da86ea5d91f7ca0939ef5b40592e6a49
+  metadata.gz: 28d6883722e140005b24071ab637104d6d0e16e22a75fffac734b242fafbb88c1ecdbfd4d4d44a11439a8cbac5d0ad5dcfba705ed26a706f6abb83f55f3f5513
+  data.tar.gz: b02ddcabf2669f9458a21dd37e0495218eedff6f15047c923b81d6fbcd311ce34ed2d27c7ea664a97aebaf806eac653dd4ec09fb3ee526607da796ec4c3a54f2

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/ezmetrics.svg)](https://badge.fury.io/rb/ezmetrics)
 
-A simple tool for capturing and displaying Rails metrics.
+Simple, lightweight and fast metrics aggregation for Rails.
 
 ## Installation
 
@@ -28,12 +28,24 @@ You can change the timeframe according to your needs and save the metrics by cal
 
 ```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)
+  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)
+  EZmetrics.new(10.minutes).log(
+    duration: 100.5,
+    views:    40.7,
+    db:       59.8,
+    queries:  4,
+    status:   200
+  )
 ```
 
 ---
@@ -50,7 +62,7 @@ For displaying metrics you need to call `show` method:
   EZmetrics.new(10.minutes).show
 ```
 
-> Please note that you can combine these timeframes, for example - store for 10 minutes, display for 5 minutes.
+You can combine these timeframes, for example - store for 10 minutes, display for 5 minutes.
 
 ### Capture metrics
 
@@ -119,7 +131,7 @@ This will return a hash with the following structure:
 }
 ```
 
-### Aggregation options
+### Aggregation
 
 The aggregation can be easily configured by specifying aggregation options as in the following examples:
 
@@ -205,6 +217,59 @@ EZmetrics.new.show(views: :avg, :db: [:avg, :max], requests: true)
 }
 ```
 
+### Partitioning
+
+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)
+```
+
+This will return an array of objects with the following structure:
+
+```ruby
+[
+  {
+    timestamp: # UNIX timestamp
+    data:      # a hash with aggregated metrics
+  }
+]
+```
+
+like in the example below:
+
+```ruby
+[
+  {
+    timestamp: 1575242880,
+    data: {
+      duration: {
+        avg: 477,
+        max: 8566
+      },
+      db: {
+        avg: 387
+      }
+    }
+  },
+  {
+    timestamp: 1575242940,
+    data: {
+      duration: {
+        avg: 234,
+        max: 3675
+      },
+      db: {
+        avg: 123
+      }
+    }
+  }
+]
+```
+
+Available time units for partitioning: `second`, `minute`, `hour`, `day`. Default: `minute`.
+
 ### Performance
 
 The aggregation speed relies on the performance of **Redis** (data storage) and **Oj** (json serialization/parsing).
@@ -215,8 +280,6 @@ You can check the **aggregation** time by running:
 EZmetrics::Benchmark.new.measure_aggregation
 ```
 
-The result of running this benchmark on a _2017 Macbook Pro 2.9 GHz Intel Core i7 with 16 GB of RAM_:
-
 | Interval | Duration (seconds) |
 | :------: | :----------------: |
 | 1 minute |        0.0         |
@@ -224,3 +287,21 @@ The result of running this benchmark on a _2017 Macbook Pro 2.9 GHz Intel Core i
 | 12 hours |        0.49        |
 | 24 hours |        1.51        |
 | 48 hours |        3.48        |
+
+---
+
+To check the **partitioned aggregation** time you need to run:
+
+```ruby
+EZmetrics::Benchmark.new.measure_aggregation(:minute)
+```
+
+| Interval | Duration (seconds) |
+| :------: | :----------------: |
+| 1 minute |        0.0         |
+|  1 hour  |        0.05        |
+| 12 hours |        0.74        |
+| 24 hours |        2.12        |
+| 48 hours |        4.85        |
+
+The benchmarks above were run on a _2017 Macbook Pro 2.9 GHz Intel Core i7 with 16 GB of RAM_

data/lib/ezmetrics.rb

@@ -5,6 +5,7 @@ require "oj"
 class EZmetrics
   METRICS               = [:duration, :views, :db, :queries].freeze
   AGGREGATION_FUNCTIONS = [:max, :avg].freeze
+  PARTITION_UNITS       = [:second, :minute, :hour, :day].freeze
 
   def initialize(interval_seconds=60)
     @interval_seconds = interval_seconds.to_i
@@ -36,6 +37,7 @@ class EZmetrics
       this_second_metrics["statuses"][status_group] += 1
     else
       @this_second_metrics = {
+        "second"       => this_second,
         "duration_sum" => safe_payload[:duration],
         "duration_max" => safe_payload[:duration],
         "views_sum"    => safe_payload[:views],
@@ -57,23 +59,38 @@ class EZmetrics
   end
 
   def show(options=nil)
-    @options          = options || default_options
-    interval_start    = Time.now.to_i - interval_seconds
-    interval_keys     = (interval_start..Time.now.to_i).to_a
-    @interval_metrics = redis.mget(interval_keys).compact.map { |hash| Oj.load(hash) }
+    @options = options || default_options
+    partitioned_metrics ? aggregate_partitioned_data : aggregate_data
+  end
 
-    return {} unless interval_metrics.any?
+  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"]) }
+    self
+  end
+
+  private
 
+  attr_reader :redis, :interval_seconds, :interval_metrics, :requests,
+    :storage_key, :safe_payload, :this_second_metrics, :partitioned_metrics, :options
+
+  def aggregate_data
+    return {} unless interval_metrics.any?
     @requests = interval_metrics.sum { |hash| hash["statuses"]["all"] }
     build_result
   rescue
     {}
   end
 
-  private
-
-  attr_reader :redis, :interval_seconds, :interval_metrics, :requests,
-    :storage_key, :safe_payload, :this_second_metrics, :options
+  def aggregate_partitioned_data
+    partitioned_metrics.map do |partition, metrics|
+      @interval_metrics = metrics
+      @requests = interval_metrics.sum { |hash| hash["statuses"]["all"] }
+      { timestamp: partition, data: build_result }
+    end
+  rescue
+    new(options)
+  end
 
   def build_result
     result = {}
@@ -95,6 +112,22 @@ class EZmetrics
     result
   end
 
+  def second_to_partition_unit(time_unit, second)
+    return second if time_unit == :second
+    time_unit_depth = { minute: 4, hour: 3, day: 2 }
+    reset_depth     = time_unit_depth[time_unit]
+    time_to_array   = Time.at(second).to_a[0..5].reverse
+    Time.new(*time_to_array[0..reset_depth]).to_i
+  end
+
+  def interval_metrics
+    @interval_metrics ||= begin
+      interval_start    = Time.now.to_i - interval_seconds
+      interval_keys     = (interval_start..Time.now.to_i).to_a
+      redis.mget(interval_keys).compact.map { |hash| Oj.load(hash) }
+    end
+  end
+
   def aggregate(metrics, aggregation_function)
     return unless AGGREGATION_FUNCTIONS.include?(aggregation_function)
     return avg("#{metrics}_sum") if aggregation_function == :avg

data/lib/ezmetrics/benchmark.rb

@@ -16,11 +16,11 @@ class EZmetrics::Benchmark
     }
   end
 
-  def measure_aggregation
+  def measure_aggregation(partition_by=nil)
     write_metrics
     print_header
     intervals.each do |interval, seconds|
-      result = measure_aggregation_time(interval, seconds)
+      result = measure_aggregation_time(interval, seconds, partition_by)
       print_row(result)
     end
     cleanup_metrics
@@ -36,6 +36,7 @@ class EZmetrics::Benchmark
     seconds.times do |i|
       second = start - i
       payload = {
+        "second"          => second,
         "duration_sum"    => rand(10000),
         "duration_max"    => rand(10000),
         "views_sum"       => rand(1000),
@@ -45,11 +46,11 @@ class EZmetrics::Benchmark
         "queries_sum"     => rand(100),
         "queries_max"     => rand(100),
         "statuses"        => {
-          "2xx" => rand(10),
-          "3xx" => rand(10),
-          "4xx" => rand(10),
-          "5xx" => rand(10),
-          "all" => rand(40)
+          "2xx" => rand(1..10),
+          "3xx" => rand(1..10),
+          "4xx" => rand(1..10),
+          "5xx" => rand(1..10),
+          "all" => rand(1..40)
         }
       }
       redis.setex(second, seconds, Oj.dump(payload))
@@ -63,9 +64,15 @@ class EZmetrics::Benchmark
     redis.del(interval_keys)
   end
 
-  def measure_aggregation_time(interval, seconds)
+  def measure_aggregation_time(interval, seconds, partition_by)
     iterations.times do
-      durations << ::Benchmark.measure { EZmetrics.new(seconds).show }.real
+      durations << ::Benchmark.measure do
+        if partition_by
+          EZmetrics.new(seconds).partition_by(partition_by).show
+        else
+          EZmetrics.new(seconds).show
+        end
+      end.real
     end
 
     return {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezmetrics
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Nicolae Rotaru
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: A simple tool for capturing and displaying Rails metrics.
+description: Simple, lightweight and fast metrics aggregation for Rails.
 email: nyku.rn@gmail.com
 executables: []
 extensions: []
@@ -76,10 +76,11 @@ files:
 - README.md
 - lib/ezmetrics.rb
 - lib/ezmetrics/benchmark.rb
-homepage: https://github.com/nyku/ezmetrics
+homepage: https://nyku.github.io/ezmetrics
 licenses:
 - GPL-3.0
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/nyku/ezmetrics
 post_install_message: 
 rdoc_options: []
 require_paths: