rails_requests 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f848e6c17d52d814b96b2e76339d628be9054114d3b9b749ede9890236cd89b
+  data.tar.gz: bf2d49e8bb6552c64cba90124d6caf28b53223af3f7125f28540effc60c55ca5
+SHA512:
+  metadata.gz: 1715b117aa52d3fe59d394483ae45d72aa90558dae6f1708f7cdbff8d2e5f272acf93685a1be3e7e382c521399116dec4b13b87eae77748fa346c344cc094070
+  data.tar.gz: 61910fc724f9b0e216847a40f4087df8e9aed1f1adbb0fc8c36087654ccfd8dd22cf22040c784b7fdfd0a1099e3cf2a6090b49100f8d8b144555ab4c980233ec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Igor Kasyanchuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# RailsRequests
+
+Short description and motivation.
+
+## Usage
+
+Create `config/initializers/rails_requests.rb`
+
+```ruby
+RailsRequests.setup do |config|
+  config.redis = Redis.new
+  config.days  = 3
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_requests'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## TODO
+
+- time/zone
+- redis namespaces
+- skip for tests ?
+- documentation
+- add 1 if 0 (it means one request was)
+- better hint
+
+## Contributing
+
+You are welcome to contribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsRequests'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/rails_requests_controller.rb

@@ -0,0 +1,9 @@
+class RailsRequestsController < ActionController::Base
+
+  def index
+    @data   = RailsRequests.dump
+    @global = RailsRequests::GlobalReport.new.data(:controller_action)
+    #@full   = RailsRequests::FullReport.new.data(:controller_action).sort{|a, b| b[:count] <=> a[:count]}
+  end
+
+end

data/app/views/rails_requests/_css.html.erb

@@ -0,0 +1,106 @@
+<link href="https://fonts.googleapis.com/css?family=Open+Sans&display=swap" rel="stylesheet">
+
+<style>
+  body {
+    font-family: OpenSans, sans-serif;
+    margin: 0;
+    font-size: .8125rem;
+    font-weight: 400;
+    line-height: 1.5;
+    color: #a6b0cf;
+    text-align: left;
+    background-color: #282e38;
+    background: linear-gradient(45deg, #282e38, #382e38);
+    display: flex;
+    width: 100%;
+    flex-direction: column;
+    align-items: center;
+  }
+
+  #chart {
+    width: 100%;
+    min-height: 600px;
+  }
+
+  .card {
+    min-width: 90%;
+    padding: 1em 2em;
+    background-color: #323a46;
+    background-clip: border-box;
+    border: 0 solid #32394e;
+    border-radius: .25rem;
+    box-shadow: 0 0.75rem 6rem rgba(56,65,74,.03);
+  }
+
+  h1 {
+    text-align: center;
+    color: #f6f6f6;
+    font-size: 14px;
+    margin: 0 0 7px 0;
+    padding-top: 14px;
+    padding-bottom: 14px;
+  }
+
+  p.hint {
+    font-size: 10px;
+    text-align: center;
+    color: #aaa;
+  }
+
+  table {
+    border-collapse: collapse;
+    border-radius: 10px;
+    overflow: hidden;
+    width: 100%;
+    margin: 0 auto;
+    position: relative;
+    border-spacing: 1;
+  }
+  table * {
+    position: relative;
+  }
+  table td, table th {
+    padding-left: 8px;
+  }
+  table thead tr {
+    height: 60px;
+  }
+  table tbody tr {
+    height: 50px;
+  }
+  table tbody tr:last-child {
+    border: 0;
+  }
+  table td, table th {
+    text-align: left;
+  }
+  table td.l, table th.l {
+    text-align: right;
+  }
+  table td.c, table th.c {
+    text-align: center;
+  }
+  table td.r, table th.r {
+    text-align: center;
+  }
+
+  th {
+    font-size: 18px;
+    color: #f5f5f5;
+    line-height: 1.2;
+    font-weight: unset;
+  }
+
+  tbody tr {
+    font-size: 15px;
+    color: #f5f5f5;
+    line-height: 1.2;
+    font-weight: unset;
+  }
+
+  tbody tr:hover {
+    color: white;
+    background-color: #282e38;
+  }
+
+</style>

data/app/views/rails_requests/_js.html.erb

@@ -0,0 +1,5 @@
+<%= javascript_include_tag 'https://code.highcharts.com/highcharts.js' %>
+<%= javascript_include_tag 'https://code.highcharts.com/modules/data.js' %>
+<%= javascript_include_tag 'https://code.highcharts.com/modules/exporting.js' %>
+<%= javascript_include_tag 'https://code.highcharts.com/modules/export-data.js' %>
+<%= javascript_include_tag 'https://code.highcharts.com/modules/accessibility.js' %>

data/app/views/rails_requests/index.html.erb

@@ -0,0 +1,107 @@
+<%= render '/rails_requests/js' %>
+<%= render '/rails_requests/css' %>
+
+<title>Number of Requests to the Application</title>
+
+<br/>
+<br/>
+<br/>
+
+<div class="card">
+  <h1>Number of Requests to the Application<h1>
+  <div id="chart"></div>
+  <p class="hint">All requests (site visitors, search engines, bots, etc)</p>
+</div>
+
+<br/>
+<br/>
+<br/>
+
+<div class="card">
+  <h1>Requests (path, total number, average response time)<h1>
+  <table>
+    <thead>
+      <tr>
+        <th></th>
+        <th>Requests</th>
+        <th>Average (ms)</th>
+        <th>Slowest (ms)</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @global.each do |e| %>
+        <tr>
+          <td><%= e[:group] %></td>
+          <td><%= e[:count] %></td>
+          <td><%= e[:average].round(2) %></td>
+          <td><%= e[:slowest].round(2) %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>
+
+<br/>
+<br/>
+<br/>
+
+
+<script>
+  var data = <%= raw @data.to_json %>;
+
+  Highcharts.chart('chart', {
+      chart: {
+          type: 'column',
+          zoomType: 'x',
+          backgroundColor: '#323a46'
+      },
+      title: {
+          text: ''
+      },
+      xAxis: {
+          type: 'datetime',
+          labels: {
+            style: {
+              color: "#a6b0cf"
+            }
+          }
+      },
+      yAxis: {
+          min: 0,
+          title: {
+              text: 'RPM',
+              style: {
+                color: "#f6f6f6"
+              }
+          },
+          labels: {
+            style: {
+              color: "#a6b0cf"
+            }
+          }
+      },
+      legend: {
+          enabled: false
+      },
+      exporting: {
+        buttons: {
+          contextButton: {
+            theme: {
+              fill: "#a6b0cf"
+            }
+          }
+        }
+      },
+      plotOptions: {
+          column: {
+            color: '#ff5b5b',
+          }
+      },
+      series: [{
+          type: 'column',
+          name: 'Requests per minute',
+          data: data
+      }]
+  });
+
+</script>

data/config/routes.rb

@@ -0,0 +1,7 @@
+RailsRequests::Engine.routes.draw do
+  get '/' => 'rails_requests#index', as: :rails_requests
+end
+
+Rails.application.routes.draw do
+  mount_routes
+end

data/lib/rails_requests/base_report.rb

@@ -0,0 +1,19 @@
+module RailsRequests
+  class BaseReport
+    def collect(group)
+      keys   = RailsRequests.redis.keys("*#{Date.current.strftime("%Y%m%d")}*|*total_duration")
+      values = RailsRequests.redis.mget(keys)
+
+      @collection = RailsRequests::Collection.new
+
+      keys.each_with_index do |key, index|
+        @collection.data << RailsRequests::Record.new(key, values[index])
+      end
+
+      @collection.group_by(group).values.inject([]) do |res, (k,v)|
+        res << yield(k, v)
+        res
+      end
+    end
+  end
+end

data/lib/rails_requests/collection.rb

@@ -0,0 +1,34 @@
+module RailsRequests
+  class Collection
+    attr_reader :data
+
+    def initialize
+      @data = []
+    end
+
+    def group_by(type)
+      @data = case type
+      when :controller_action
+        data.group_by(&:controller_action)
+      when :path
+        data.group_by(&:path)
+      else
+        []
+      end
+      self
+    end
+
+    def values
+      return [] if @data.empty?
+      result = {}
+      @data.each do |key, records|
+        result[key] ||= []
+        records.each do |record|
+          result[key] << record.value
+        end
+      end
+      result
+    end
+
+  end
+end

data/lib/rails_requests/engine.rb

@@ -0,0 +1,18 @@
+require_relative './middleware.rb'
+require_relative './collection.rb'
+require_relative './metrics.rb'
+
+module RailsRequests
+  class Engine < ::Rails::Engine
+
+    config.app_middleware.use Middleware
+
+    initializer :configure_metrics, after: :initialize_logger do
+      ActiveSupport::Notifications.subscribe(
+        "process_action.action_controller",
+        Metrics.new
+      )
+    end
+
+  end
+end

data/lib/rails_requests/full_report.rb

@@ -0,0 +1,14 @@
+module RailsRequests
+  class FullReport < BaseReport
+    def data(group)
+      collect(group) do |k, v|
+        {
+          group: k,
+          average: v.sum.to_f / v.size,
+          count: v.size,
+          slowest: v.max
+        }
+      end.sort{|a, b| b[:count] <=> a[:count]}
+    end
+  end
+end

data/lib/rails_requests/global_report.rb

@@ -0,0 +1,14 @@
+module RailsRequests
+  class GlobalReport < BaseReport
+    def data(group)
+      collect(group) do |k, v|
+        {
+          group: k,
+          average: v.sum.to_f / v.size,
+          count: v.size,
+          slowest: v.max
+        }
+      end.sort{|a, b| b[:count] <=> a[:count]}
+    end
+  end
+end

data/lib/rails_requests/metrics.rb

@@ -0,0 +1,45 @@
+class Metrics
+
+  # payload
+  # {
+  #   controller: "PostsController",
+  #   action: "index",
+  #   params: {"action" => "index", "controller" => "posts"},
+  #   headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
+  #   format: :html,
+  #   method: "GET",
+  #   path: "/posts",
+  #   status: 200,
+  #   view_runtime: 46.848,
+  #   db_runtime: 0.157
+  # }  
+
+  def call(event_name, started, finished, event_id, payload)
+    event = ActiveSupport::Notifications::Event.new(event_name, started, finished, event_id, payload)
+
+    record = {
+      controller: event.payload[:controller],
+      action: event.payload[:action],
+      format: event.payload[:format],
+      method: event.payload[:method],
+      path: event.payload[:path],
+      status: event.payload[:status],
+      view_runtime: event.payload[:view_runtime],
+      db_runtime: event.payload[:db_runtime],
+      duration: event.duration
+    }
+
+    namespace = "metrics|#{record[:controller]}|#{record[:action]}|#{finished.strftime("%Y%m%dT%H%M")}|#{finished.to_i}|#{record[:path]}"
+
+    # set("#{namespace}|all", record.to_json)
+    # set("#{namespace}|database", record[:db_runtime])
+    # set("#{namespace}|view_duration", record[:view_runtime])
+    set("#{namespace}|total_duration", record[:duration])
+  end
+
+  def set(key, value)
+    #puts "#{key} = #{value}"
+    RailsRequests.redis.set(key, value)
+    RailsRequests.redis.expire(key, RailsRequests.duration.to_i)
+  end
+end

data/lib/rails_requests/middleware.rb

@@ -0,0 +1,23 @@
+module RailsRequests
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @status, @headers, @response = @app.call(env)
+
+      # if RailsRequests.debug
+      #   key   = RailsRequests.cache_key
+      #   field = RailsRequests.field_key
+      #   puts "key: #{key}, field: #{field}"
+      #   RailsRequests.redis.hincrby(key, field, 1)
+      # else
+        RailsRequests.redis.hincrby(RailsRequests.cache_key, RailsRequests.field_key, 1)
+#      end
+
+      [@status, @headers, @response]
+    end
+
+  end
+end

data/lib/rails_requests/record.rb

@@ -0,0 +1,35 @@
+module RailsRequests
+  class Record
+
+    attr_reader :controller, :action, :datetime, :datetimei, :path, :metric
+
+    # key = metrics|HomeController|index|20200123T0919|1579789173|/|database = 0
+    # value = string
+    def initialize(key, value)
+      @key   = key
+      @value = value
+
+      items = key.split("|")
+
+      @controller = items[1]
+      @action     = items[2]
+      @datetime   = items[3]
+      @datetimei  = items[4].to_i
+      @path       = items[5]
+      @metric     = items[6]
+    end
+
+    def value
+      case metric
+      when "database", "view_duration", "total_duration"
+        @value.to_f
+      when "all"
+        JSON.parse(@value)
+      end
+    end
+
+    def controller_action
+      "#{controller}##{action}"
+    end
+  end
+end

data/lib/rails_requests/routes.rb

@@ -0,0 +1,12 @@
+module ActionDispatch::Routing
+  class Mapper
+    def mount_routes(options = {})
+      begin
+        mount RailsRequests::Engine => '/rails/requests', :as => options[:as] || 'rails_requests'
+      rescue ArgumentError
+        # already added
+        # this cod exist here because engine not includes routing automatically
+      end
+    end
+  end
+end

data/lib/rails_requests/version.rb

@@ -0,0 +1,3 @@
+module RailsRequests
+  VERSION = '0.1.1'
+end

data/lib/rails_requests.rb

@@ -0,0 +1,86 @@
+require "redis"
+require_relative "rails_requests/middleware.rb"
+require_relative "rails_requests/record.rb"
+require_relative "rails_requests/base_report.rb"
+require_relative "rails_requests/global_report.rb"
+require_relative "rails_requests/full_report.rb"
+
+require "rails_requests/engine"
+
+module RailsRequests
+  mattr_accessor :redis
+  @@redis = Redis.new
+
+  mattr_accessor :duration
+  @@duration = 24.hours
+
+  mattr_accessor :debug
+  @@debug = false
+
+  def self.setup
+    yield(self)
+  end
+
+  # date key in redis store
+  def RailsRequests.cache_key(now = Date.current)
+    "date-#{now}"
+  end
+  # write to current slot
+  # time - date -minute
+  def RailsRequests.field_key(now = Time.now)
+    now.strftime("%H:%M")
+  end
+
+  def RailsRequests.days
+    (RailsRequests.duration % 24.days).parts[:days] + 1
+  end
+
+  def RailsRequests.median(array)
+    sorted = array.sort
+    size   = sorted.size
+    center = size / 2
+
+    if size == 0
+      nil
+    elsif size.even?
+      (sorted[center - 1] + sorted[center]) / 2.0
+    else
+      sorted[center]
+    end
+  end  
+
+  def RailsRequests.dump
+  @data = []
+
+    all = {}
+    RailsRequests.days.times do |e|
+      date    = e.days.ago.to_date
+      all[date] = RailsRequests.redis.hgetall(RailsRequests.cache_key(date))
+    end
+
+    stop    = Time.at(60 * (Time.now.to_i / 60))
+    current = stop - RailsRequests.duration
+
+    while current <= stop
+      views = all.dig(current.to_date, current.strftime("%H:%M")) || 0
+
+      @data << [current.to_i * 1000, views.to_i]
+
+      current += 1.minute
+    end
+  
+    @data.sort!
+  end
+
+  # populate test data
+  # run in rails c
+  def RailsRequests.populate_test_data(seed = 20, limit = 10000, days = 7)
+    limit.times do
+      t = rand(86400*days).seconds.ago # within last 7 days
+      RailsRequests.redis.hincrby(RailsRequests.cache_key(t.to_date), RailsRequests.field_key(t), rand(seed))
+    end
+  end
+
+end
+
+require_relative 'rails_requests/routes'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rails_requests
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Track number of requests to your app
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/rails_requests_manifest.js
+- app/controllers/rails_requests_controller.rb
+- app/views/rails_requests/_css.html.erb
+- app/views/rails_requests/_js.html.erb
+- app/views/rails_requests/index.html.erb
+- config/routes.rb
+- lib/rails_requests.rb
+- lib/rails_requests/base_report.rb
+- lib/rails_requests/collection.rb
+- lib/rails_requests/engine.rb
+- lib/rails_requests/full_report.rb
+- lib/rails_requests/global_report.rb
+- lib/rails_requests/metrics.rb
+- lib/rails_requests/middleware.rb
+- lib/rails_requests/record.rb
+- lib/rails_requests/routes.rb
+- lib/rails_requests/version.rb
+homepage: https://github.com/igorkasyanchuk/rails_requests
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Track number of requests to your app
+test_files: []