ezmetrics 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc9e49c32e99f5d45f45ca6d3d467e53c09b8502
-  data.tar.gz: ce9f340d9f70ddfd7aebbac487e2d1b4b094527f
+SHA256:
+  metadata.gz: 5ba2e24bca76b2786c1264b779e72764e123094150855cae241d673505df95ad
+  data.tar.gz: 3c297b92a53c51b8b881fbbafb15929b9bac36eb53164c3faab37c2caa72db02
 SHA512:
-  metadata.gz: 295ae4b987d80ec5feb6cbb21e0f5dee0ea6523d140e50840b5637b57c3263f712b5c798eed3c69794fb8618a5236e7f6005a1fee34f4e2f6e8812f97ab636e7
-  data.tar.gz: 8c9523d1385036e83a1eaea18e275c91f2865c391ad60f50a2af76b865843338e1d4408e8f08f037c2af14ba552181f7a82e85be7ea5b7242755f2c4070fb418
+  metadata.gz: 4d1e8118d48cac15dca166c6c4f0d8e38344b28bfcc85343fa87ff4877d34bc7f12b9841241de563723261df5a48210cf1838c09eece3bc15d5f2dde6a58c8c2
+  data.tar.gz: 8e62b7b53f73a6343c8fd6f11e0e8a9f856314dd262c10611cd9bf061636c8801255de58818a1736069679525bed73c949e6f61778910de8a306da30c352e2a2

data/README.md

@@ -4,7 +4,6 @@
 
 A simple tool for capturing and displaying Rails metrics.
 
-
 ## Installation
 
 ```
@@ -16,6 +15,7 @@ gem 'ezmetrics'
 ### Getting started
 
 This tool captures and aggregates Rails application metrics such as
+
 - `duration`
 - `views`
 - `db`
@@ -30,6 +30,7 @@ You can change the timeframe according to your needs and save the metrics by cal
   # Store the metrics for 60 seconds (default behaviour)
   EZmetrics.new.log(duration: 100.5, views: 40.7, db: 59.8, queries: 4, status: 200)
 ```
+
 or
 
 ```ruby
@@ -53,7 +54,6 @@ or
 
 > Please note that you can combine these timeframes, for example - store for 10 minutes, display for 5 minutes.
 
-
 ### Capture metrics
 
 Just add an initializer to your application:
@@ -121,6 +121,86 @@ This will return a hash with the following structure:
 }
 ```
 
+### Output configuration
+
+The output can be easily configured by specifying aggregation options as in the following examples:
+
+1. Single
+
+```ruby
+EZmetrics.new.show(duration: :max)
+```
+
+```ruby
+{
+  duration: {
+    max: 9675
+  }
+}
+```
+
+2. Multiple
+
+```ruby
+EZmetrics.new.show(queries: [:max, :avg])
+```
+
+```ruby
+{
+  queries: {
+    max: 76,
+    avg: 26
+  }
+}
+```
+
+3. Requests
+
+```ruby
+EZmetrics.new.show(requests: true)
+```
+
+```ruby
+{
+  requests: {
+    all: 2000,
+    grouped: {
+      "2xx" => 1900,
+      "3xx" => 15,
+      "4xx" => 80,
+      "5xx" => 5
+    }
+  }
+}
+```
+
+4. Combined
+
+```ruby
+EZmetrics.new.show(views: :avg, :db: [:avg, :max], requests: true)
+```
+
+```ruby
+{
+  views: {
+    avg: 12
+  },
+  db: {
+    avg: 155,
+    max: 4382
+  },
+  requests: {
+    all: 2000,
+    grouped: {
+      "2xx" => 1900,
+      "3xx" => 15,
+      "4xx" => 80,
+      "5xx" => 5
+    }
+  }
+}
+```
+
 ### Performance
 
 The implementation is based on **Redis** commands such as:
@@ -137,11 +217,12 @@ 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*:
+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         |
+|  1 hour  |        0.05        |
+| 12 hours |        0.66        |
+| 24 hours |        1.83        |
+| 48 hours |        4.06        |

data/lib/ezmetrics.rb

@@ -1,7 +1,11 @@
-require "redis" unless defined?(Redis)
-require "json"  unless defined?(JSON)
+require "redis"
+require "redis/connection/hiredis"
+require "oj"
 
 class EZmetrics
+  METRICS               = [:duration, :views, :db, :queries].freeze
+  AGGREGATION_FUNCTIONS = [:max, :avg].freeze
+
   def initialize(interval_seconds=60)
     @interval_seconds = interval_seconds.to_i
     @redis            = Redis.new
@@ -22,9 +26,9 @@ class EZmetrics
     @this_second_metrics = redis.get("#{storage_key}:#{this_second}")
 
     if this_second_metrics
-      @this_second_metrics = JSON.parse(this_second_metrics)
+      @this_second_metrics = Oj.load(this_second_metrics)
 
-      [:duration, :views, :db, :queries].each do |metrics_type|
+      METRICS.each do |metrics_type|
         update_sum(metrics_type)
         update_max(metrics_type)
       end
@@ -47,31 +51,66 @@ class EZmetrics
       this_second_metrics["statuses"][status_group] = 1
     end
 
-    redis.setex("#{storage_key}:#{this_second}", interval_seconds, JSON.generate(this_second_metrics))
-
+    redis.setex("#{storage_key}:#{this_second}", interval_seconds, Oj.dump(this_second_metrics))
     true
   rescue => error
     formatted_error(error)
   end
 
-  def show
+  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.map { |second| "#{storage_key}:#{second}" }
-    @interval_metrics = redis.mget(interval_keys).compact.map { |hash| JSON.parse(hash) }
+    @interval_metrics = redis.mget(interval_keys).compact.map { |hash| Oj.load(hash) }
 
-    return empty_metrics_object unless interval_metrics.any?
+    return {} unless interval_metrics.any?
 
     @requests = interval_metrics.map { |hash| hash["statuses"]["all"] }.compact.sum
-
-    metrics_object
+    build_result
   rescue
-    empty_metrics_object
+    {}
   end
 
   private
 
-  attr_reader :redis, :interval_seconds, :interval_metrics, :requests, :storage_key,
-    :safe_payload, :this_second_metrics
+  attr_reader :redis, :interval_seconds, :interval_metrics, :requests,
+    :storage_key, :safe_payload, :this_second_metrics, :options
+
+  def build_result
+    result = {}
+
+    if options[:requests]
+      result[:requests] = {
+        all: requests,
+        grouped: {
+          "2xx" => count("2xx"),
+          "3xx" => count("3xx"),
+          "4xx" => count("4xx"),
+          "5xx" => count("5xx")
+        }
+      }
+    end
+
+    options.each do |metrics, aggregation_functions|
+      next unless METRICS.include?(metrics)
+      aggregation_functions = [aggregation_functions] unless aggregation_functions.is_a?(Array)
+      next unless aggregation_functions.any?
+
+      aggregation_functions.each do |aggregation_function|
+        result[metrics] ||= {}
+        result[metrics][aggregation_function] = aggregate(metrics, aggregation_function)
+      end
+    end
+    result
+  ensure
+    result
+  end
+
+  def aggregate(metrics, aggregation_function)
+    return unless AGGREGATION_FUNCTIONS.include?(aggregation_function)
+    return avg("#{metrics}_sum".to_sym) if aggregation_function == :avg
+    return max("#{metrics}_max".to_sym) if aggregation_function == :max
+  end
 
   def update_sum(metrics)
     this_second_metrics["#{metrics}_sum"] += safe_payload[metrics.to_sym]
@@ -94,65 +133,23 @@ class EZmetrics
     interval_metrics.map { |h| h["statuses"][group.to_s] }.sum
   end
 
-  def formatted_error(error)
+  def default_options
     {
-      error:     error.class.name,
-      message:   error.message,
-      backtrace: error.backtrace.reject { |line| line.match(/ruby|gems/) }
+      duration: AGGREGATION_FUNCTIONS,
+      views:    AGGREGATION_FUNCTIONS,
+      db:       AGGREGATION_FUNCTIONS,
+      queries:  AGGREGATION_FUNCTIONS,
+      requests: true
     }
   end
 
-  def metrics_object
-    {
-      duration: {
-        avg: avg(:duration_sum),
-        max: max(:duration_max)
-      },
-      views: {
-        avg: avg(:views_sum),
-        max: max(:views_max)
-      },
-      db: {
-        avg: avg(:db_sum),
-        max: max(:db_max)
-      },
-      queries: {
-        avg: avg(:queries_sum),
-        max: max(:queries_max)
-      },
-      requests: {
-        all:     requests,
-        grouped: {
-          "2xx" => count("2xx"),
-          "3xx" => count("3xx"),
-          "4xx" => count("4xx"),
-          "5xx" => count("5xx")
-        }
-      }
-    }
-  end
-
-  def empty_metrics_object
+  def formatted_error(error)
     {
-      duration: {
-        avg: 0,
-        max: 0
-      },
-      views: {
-        avg: 0,
-        max: 0
-      },
-      db: {
-        avg: 0,
-        max: 0
-      },
-      queries: {
-        avg: 0,
-        max: 0
-      },
-      requests: {}
+      error:     error.class.name,
+      message:   error.message,
+      backtrace: error.backtrace.reject { |line| line.match(/ruby|gems/) }
     }
   end
 end
 
-require "ezmetrics/benchmark"
+require "ezmetrics/benchmark"

data/lib/ezmetrics/benchmark.rb

@@ -11,7 +11,8 @@ class EZmetrics::Benchmark
       "1.minute" => 60,
       "1.hour  " => 3600,
       "12.hours" => 43200,
-      "24.hours" => 86400
+      "24.hours" => 86400,
+      "48.hours" => 172800
     }
   end
 
@@ -35,15 +36,15 @@ class EZmetrics::Benchmark
     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"     => {
+        "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),
@@ -51,7 +52,7 @@ class EZmetrics::Benchmark
           "all" => rand(40)
         }
       }
-      redis.setex("ez-metrics:#{second}", seconds, JSON.generate(payload))
+      redis.setex("ez-metrics:#{second}", seconds, Oj.dump(payload))
     end
     nil
   end
@@ -84,4 +85,4 @@ class EZmetrics::Benchmark
   def print_footer
     print "#{'─'*31}\n"
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezmetrics
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Nicolae Rotaru
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Rails metrics aggregation tool.