ezmetrics 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bd4e2f35cc2cf1b50efbac72d107041dc68129e
-  data.tar.gz: 179ed567aac638d1ab0d3a4ed86eaad458c55fd1
+  metadata.gz: dc9e49c32e99f5d45f45ca6d3d467e53c09b8502
+  data.tar.gz: ce9f340d9f70ddfd7aebbac487e2d1b4b094527f
 SHA512:
-  metadata.gz: e805073975368174e1ce2fd62ce3ddeece44a50bb0141f4a2d7fb9a1b8392c1083667656f29217a1beef6f9add360af0bbba3fe4016263dfa20421af247e1bbf
-  data.tar.gz: 7364788497b995a02cb3385220a7f9e861cc4d7db6377f29850c6d22e25d99b25b6fdbaaa00a6ffb224573739262219136d9739e3676f65af6b4ba03a72c6606
+  metadata.gz: 295ae4b987d80ec5feb6cbb21e0f5dee0ea6523d140e50840b5637b57c3263f712b5c798eed3c69794fb8618a5236e7f6005a1fee34f4e2f6e8812f97ab636e7
+  data.tar.gz: 8c9523d1385036e83a1eaea18e275c91f2865c391ad60f50a2af76b865843338e1d4408e8f08f037c2af14ba552181f7a82e85be7ea5b7242755f2c4070fb418

data/README.md

@@ -15,14 +15,14 @@ gem 'ezmetrics'
 
 ### Getting started
 
-This tool captures and aggregates metrics such as
+This tool captures and aggregates Rails application metrics such as
 - `duration`
 - `views`
 - `db`
 - `queries`
 - `status`
 
-for a 60 seconds timeframe by default.
+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:
 
@@ -54,7 +54,9 @@ or
 > Please note that you can combine these timeframes, for example - store for 10 minutes, display for 5 minutes.
 
 
-### Add an initializer to your Rails application
+### Capture metrics
+
+Just add an initializer to your application:
 
 ```ruby
 # config/initializers/ezmetrics.rb
@@ -81,6 +83,8 @@ end
 
 ### Display metrics
 
+As simple as:
+
 ```ruby
 EZmetrics.new.show
 ```
@@ -117,3 +121,27 @@ This will return a hash with the following structure:
 }
 ```
 
+### Performance
+
+The implementation is based on **Redis** commands such as:
+
+- [`get`](https://redis.io/commands/get)
+- [`mget`](https://redis.io/commands/mget)
+- [`setex`](https://redis.io/commands/setex)
+
+which are extremely fast.
+
+You can check the **aggregation** time by running:
+
+```ruby
+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         |
+|  1 hour  |        0.11        |
+| 12 hours |        1.6         |
+| 24 hours |        3.5         |

data/lib/ezmetrics.rb

@@ -153,4 +153,6 @@ class EZmetrics
       requests: {}
     }
   end
-end
+end
+
+require "ezmetrics/benchmark"

data/lib/ezmetrics/benchmark.rb

@@ -0,0 +1,87 @@
+require "benchmark"
+
+class EZmetrics::Benchmark
+
+  def initialize
+    @start      = Time.now.to_i
+    @redis      = Redis.new
+    @durations  = []
+    @iterations = 3
+    @intervals  = {
+      "1.minute" => 60,
+      "1.hour  " => 3600,
+      "12.hours" => 43200,
+      "24.hours" => 86400
+    }
+  end
+
+  def measure_aggregation
+    write_metrics
+    print_header
+    intervals.each do |interval, seconds|
+      result = measure_aggregation_time(interval, seconds)
+      print_row(result)
+    end
+    cleanup_metrics
+    print_footer
+  end
+
+  private
+
+  attr_reader :start, :redis, :durations, :intervals, :iterations
+
+  def write_metrics
+    seconds = intervals.values.max
+    seconds.times do |i|
+      second = start - i
+      payload = {
+        "duration_sum" => rand(10000),
+        "duration_max" => rand(10000),
+        "views_sum"    => rand(1000),
+        "views_max"    => rand(1000),
+        "db_sum"       => rand(8000),
+        "db_max"       => rand(8000),
+        "queries_sum"  => rand(100),
+        "queries_max"  => rand(100),
+        "statuses"     => {
+          "2xx" => rand(10),
+          "3xx" => rand(10),
+          "4xx" => rand(10),
+          "5xx" => rand(10),
+          "all" => rand(40)
+        }
+      }
+      redis.setex("ez-metrics:#{second}", seconds, JSON.generate(payload))
+    end
+    nil
+  end
+
+  def cleanup_metrics
+    interval_start = Time.now.to_i - intervals.values.max - 100
+    interval_keys  = (interval_start..Time.now.to_i).to_a.map { |second| "ez-metrics:#{second}" }
+    redis.del(interval_keys)
+  end
+
+  def measure_aggregation_time(interval, seconds)
+    iterations.times do
+      durations << ::Benchmark.measure { EZmetrics.new(seconds).show }.real
+    end
+
+    return {
+      interval: interval.gsub(".", " "),
+      duration: (durations.sum.to_f / iterations).round(2)
+    }
+  end
+
+  def print_header
+    print "\n#{'─'*31}\n| Interval | Duration (seconds)\n#{'─'*31}\n"
+  end
+
+  def print_row(result)
+    print "| #{result[:interval]} | #{result[:duration]}\n"
+  end
+
+  def print_footer
+    print "#{'─'*31}\n"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezmetrics
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Nicolae Rotaru
@@ -47,6 +47,7 @@ files:
 - LICENSE
 - README.md
 - lib/ezmetrics.rb
+- lib/ezmetrics/benchmark.rb
 homepage: https://github.com/nyku/ezmetrics
 licenses:
 - GPL-3.0