request_response_stats 0.1.1

data/lib/request_response_stats_config.rb

@@ -0,0 +1,64 @@
+# File: config/initializers/request_response_stat_config.rb
+
+require 'request_response_stats'
+include RequestResponseStats
+
+# Note: The namespace `RequestResponseStats` is requried if you are not including `RequestResponseStats` module
+# Set `RR_INBOUD_STATS` to false (default is `true`) to not capture inbound request stats
+# RequestResponseStats::RR_INBOUND_STATS = true
+# Set `RR_OUTBOUND_STATS` to false (default is `true`) to not capture inbound request stats
+# RequestResponseStats::RR_OUTBOUND_STATS = true
+
+# Configure custom alert code
+# Note: Ideally we should pass below custom code as block while we instantiate `RequestResponse`. But,
+# as we are using the same setting for outbound calls as well.
+module RequestResponseStats
+  def self.custom_alert_code(data)
+    # Custom alert code
+    # current_time = Time.now.utc
+    # service = NotificationService.new(activity: "request_response_alert", uuid: "ReqResNotification-#{current_time.to_s}-#{current_time.nsec}".gsub(" ", "_"))
+    # service.send_req_res_threshold_crossed_alarm_email(data)
+  end
+end
+
+# Enable incoming requests to be captured
+# Add `include RequestResponseStats::ControllerConcern` to the controller whose actions and actions in sub-classes are to be logged for request response stats
+# Example:
+# module Api
+#   class ApiController < ActionController::Base
+#     include RequestResponseStats::ControllerConcern
+#   end
+# end
+
+# Configure popular REST and SOAP libraries
+# Client libraries
+require 'rest-client'
+require 'httparty'
+require 'savon'
+
+# Enable outbound requests to be capture
+module RestClient
+  include CustomClient
+end
+
+module HTTParty
+  include CustomClient
+end
+
+module Savon
+  include CustomClient
+
+  def self.custom_uri_key
+    :wsdl
+  end
+
+  class Client
+    alias_method("#{Savon::RENAME_NAMESPACE}call".to_sym, :call)
+
+    def call(operation_name, locals={}, &block)
+      Savon.log_request_response_stats(operation_name, "locals") do
+        public_send("#{Savon::RENAME_NAMESPACE}call".to_sym, operation_name, locals, &block)
+      end
+    end
+  end
+end

data/lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake

@@ -0,0 +1,18 @@
+# File: lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake
+
+require 'request_response_stats'
+include RequestResponseStats
+
+desc 'Send request response cycle data from redis to mongo'
+namespace :request_response do
+  task :move_from_redis_to_mongo => :environment do
+    Rails.logger.info "RequestResponseStats: Moving stats data from Redis to Mongo at #{Time.now}."
+    rrs = RequestResponse.new(nil, nil)
+    count = rrs.move_data_from_redis_to_mongo
+    Rails.logger.info "RequestResponseStats: Moved #{count} keys."
+  end
+end
+
+# Cron example
+# Moving data from Redis to Mongo at interval of 15 mins
+# 0,15,30,45 * * * * /bin/bash -l -c 'cd /<project_dir> && RAILS_ENV=production bundle exec rake request_response:move_from_redis_to_mongo'

data/request_response_stats.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "request_response_stats/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "request_response_stats"
+  spec.version       = RequestResponseStats::VERSION
+  spec.authors       = ["Munish Goyal"]
+  spec.email         = ["munishapc@gmail.com"]
+
+  spec.summary       = %q{Captures request response statistics}
+  spec.description   = %q{Captures request response statistics such as cycle time, memory allocation, etc. for each request response cycle grouped in configurable granularity level}
+  spec.homepage      = "https://github.com/goyalmunish/request_response_stats"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "mongoid"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: request_response_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Munish Goyal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Captures request response statistics such as cycle time, memory allocation,
+  etc. for each request response cycle grouped in configurable granularity level
+email:
+- munishapc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/req_res_stat_controller.rb
+- lib/request_response_stats.rb
+- lib/request_response_stats/controller_concern.rb
+- lib/request_response_stats/custom_client.rb
+- lib/request_response_stats/dummy_request.rb
+- lib/request_response_stats/dummy_response.rb
+- lib/request_response_stats/redis_record.rb
+- lib/request_response_stats/req_res_stat.rb
+- lib/request_response_stats/request_response.rb
+- lib/request_response_stats/version.rb
+- lib/request_response_stats_config.rb
+- lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake
+- request_response_stats.gemspec
+homepage: https://github.com/goyalmunish/request_response_stats
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Captures request response statistics
+test_files: []