request_response_stats 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bde5823cb6c377d0f0544a0efb22523aa6758f7
-  data.tar.gz: 14d4ed2106fa3dd22dfcd225121fdf1efc95bbcf
+  metadata.gz: df56081c132cf711319a1a06beaa87a04815af8b
+  data.tar.gz: 3cd442829c9c12d7f0390ab2199dedd7392bb5b4
 SHA512:
-  metadata.gz: 76c678ce28f903ee6a8badfe44e94cff931346ca0cb24ba44203fe17917bcfb4ee2510ba478f6f08ed39875f45e4e58c97d81298ecff8c9b3ba8cbaa57d789e6
-  data.tar.gz: 610074ebd7f4e68aae4854d492a04b8c59dff454cf0ac4ae6d050a238e738bf56dba6187f970ade1502f60194cb36fbaab4be3ec703e8ca78de37ed234f21e70
+  metadata.gz: 2abcebce918f49f31e6186ff78b5b49b25b62f1ff8c344ac2beb0c1c22fdebfaea015fe9eea8b4e9931335c481b2f248a0111cbc516db17a2eac7c676f27fd47
+  data.tar.gz: a0343daad08c6920998efead55aed23138adb361f835a8df1276c71dde78eeda73269c8787b215d79f6f37f1d68e1966570ab2eb45e90a5f323cc71c783b1e2f

data/README.md

@@ -4,7 +4,7 @@
 
 - [RequestResponseStats](#requestresponsestats)
   - [Prerequisites](#prerequisites)
-  - [Installation](#installation)
+  - [Installation and Setup](#installation-and-setup)
   - [Usage](#usage)
     - [Documentation References](#documentation-references)
     - [Checking current data in redis](#checking-current-data-in-redis)
@@ -24,9 +24,9 @@
 
 The gem uses [Redis](https://github.com/redis/redis-rb) as a temporary storage to store the captured stats data. For permanent storage of this data, [MongoDB](https://github.com/mongodb/mongoid) is being used.
 
-You can pass your redis connection (by default, it is assumed to be available through `$redis`) and mongoid_doc_model (by default, it is named `ReqResStat`) thorugh `RequestResponseStats::RequestResponse.new`.
+You can pass your redis connection (by default, it is assumed to be available through `$redis`) and mongoid_doc_model (by default, it is named `ReqResStat`) through `RequestResponseStats::RequestResponse.new`.
 
-## Installation
+## Installation and Setup
 
 Add gem to your application's Gemfile:
 
@@ -46,7 +46,7 @@ Or install it separately as:
 $ gem install request_response_stats
 ```
 
-Add following to the controller whose request response stats are to be captured. For example,
+Include `RequestResponseStats::ControllerConcern` to the controller whose request response stats are to be captured. For example,
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -212,16 +212,15 @@ rrs.redis_record.hashify_all_data["api_req_res_PUBLIC_Munishs-MacBook-Pro.local_
                  "oldmalloc_increase_bytes_limit" => 0
     }
 }
-=> nil
 ```
 
 The gem uses [free](https://linux.die.net/man/1/free) command to capture memory information of the server. If this command is not available (such as on Mac), then zeros are reported, as you can see in memory keys (keys ending with `memory_MB`) in the above example.
 
-The last part of the key (such as `0202` in the above key) represents slot within a day. By default, `GROUP_STATS_BY_TIME_DURATION` is set as `1.minute`, so there are `24*60` slots in a day. You can easily configure these settings by overriding these configuration in`request_response_stats_config.rb`.
+The last part of the key (such as `0202` in the above key) represents slot within a day. By default, `GROUP_STATS_BY_TIME_DURATION` is set as `1.minute`, so there are `24*60` slots in a day. You can easily configure these settings by overriding these configurations in`request_response_stats_config.rb`.
 
 The `request_count` key, within data of a single key, gives the number of requests received for a given endpoint in a given timeslot.
 
-For example,
+For example, consider the key `"api_req_res_PUBLIC_Munishs-MacBook-Pro.local_/words/1/ajax_promote_flag_GET_2017-12-03-0202"`:
 
 ```ruby
 rrs.redis_record.get_slot_range_for_key "api_req_res_PUBLIC_Munishs-MacBook-Pro.local_/words/1/ajax_promote_flag_GET_2017-12-03-0202"
@@ -236,11 +235,10 @@ This means that the server `Munishs-MacBook-Pro.local` received `3` (as reported
 
 ### Manually moving data from Redis to Mongo
 
-Moving freezed, non-support keys from Redis to Mongo:
+Moving only request_response_stats specific, freezed, non-support (that is `{support: false}`) keys from Redis to Mongo:
 
 ```ruby
-rrs.move_data_from_redis_to_mongo
-# => 16
+rrs.move_data_from_redis_to_mongo  # => 16
 ```
 
 Note: Make use of `lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake` to schedule this task using cron.

data/lib/generators/request_response_stats/customization_generator.rb

@@ -2,8 +2,7 @@ module RequestResponseStats
   module Generators
     class CustomizationGenerator < Rails::Generators::Base
       source_root File.expand_path('../../templates', __FILE__)
-
-      desc "Create RequestResponseStats configuration files"
+      desc "Create RequestResponseStats customization files"
 
       def copy_customization_files
         files_to_generate = [
@@ -12,6 +11,7 @@ module RequestResponseStats
           "lib/tasks/move_req_res_cycle_data_from_redis_to_mongo.rake"
         ]
         files_to_generate.each do |file|
+          puts "Generating #{file}.."
           just_file_name = file.split("/")[-1]
           copy_file just_file_name, file
         end

data/lib/request_response_stats/version.rb

@@ -1,5 +1,5 @@
 # File: lib/request_response_stats/version.rb
 
 module RequestResponseStats
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_response_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Munish Goyal