schwad_performance_logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dc7e1108b9ce7a1a47286a502350df63f11390d
-  data.tar.gz: f6fe234f315b1e57ca7c8bb5c24b7f162661f286
+  metadata.gz: 674ca62fc24c2236c78edd52c4c17fab4c46d946
+  data.tar.gz: 8a2f881fc9ab052022799e2f634599c7b9a59d6c
 SHA512:
-  metadata.gz: 67e02cca112220cfb555a046326c06e4e11ba3c6111772451bda02a3fad12c4ba232040d921b2d8f80c2ee11c321dd68da6fa7c91aa5af2481fe6f7ab927907b
-  data.tar.gz: 3d79833a6f45e85189fa76acb9a67e997e0cf4bc3f4fbed9f855d9b1faf865d7022306d85eaa56df87a5c0e140de297b0ded878a51e17e97596fc82d5b1c3572
+  metadata.gz: 13cd63c83a5ab428a8665324a6f691d08b523949797374ea34a283d5c61b36041ffec4b426edb13f7ec5801dd2ca12105584f9046a49bd622534f3a920899e8f
+  data.tar.gz: 5586264c2c7028890803417ee1875c65acec5731b3345d16c68d0181ab40afb044c198df6970eeb9b15078e30fef8abc17a329b20731a84cb1372094fe1693e5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schwad_performance_logger (0.1.0)
+    schwad_performance_logger (0.2.0)
       get_process_mem
 
 GEM
@@ -29,9 +29,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  schwad_performance_logger!
   rake (~> 10.0)
   rspec (~> 3.0)
+  schwad_performance_logger!
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -5,9 +5,6 @@ the SchwadPerformanceLogger object, as well as deltas between each check. The ou
 is `puts`'d to the console, and it also writes to a long-running CSV and per-object
 log file in `logs/schwad_performance_logger`
 
-**THIS GEM IS IN DEVELOPMENT**: Major 'todo' left is to ensure that CSV and logger
-elements actually write to user's root directory and not the gem's.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-`pl = SchwadPerformanceLogger.new`
+`pl = SchwadPerformanceLogger.new({full_memo: 'Check extract method refactoring'})`
 
 ```
 **********************************************************************
@@ -46,6 +43,8 @@ Starting Test memo. Current memory: 12(Mb), difference of 0 (mb) since beginning
 
 ### Options
 
+`full_memo` option adds an extra header in the `log` outputs as well as a header to each new set of csv outputs. This is not to be confused with the 'per-run' message passed to `#log_performance` which is only passed to that check.
+
 To disable any of the outputs:
 
 `SchwadPerformanceLogger.new({puts: false, log: false, csv: false})`
@@ -55,6 +54,20 @@ you can actually see the log as it goes by. This does not affect the 'time' meas
 
 `SchwadPerformanceLogger.new({pause: 8})`
 
+## Usage example:
+
+```
+pl = SchwadPerformanceLogger.new({pause: 3, full_memo: 'Retry object-oriented approach.', log: false})
+pl.log_performance('check status before writing to database')
+
+# code here
+
+pl.log_performance('check status after writing to database')
+
+# code
+
+pl.log_performance('inspect final performance after executing service')
+```
 
 ## Development
 

data/lib/schwad_performance_logger/schwad_performance_logger.rb

@@ -17,11 +17,12 @@ class PLogger
   attr_reader :options
 
   def initialize( options = {} )
-    # system('mkdir log/schwad_performance_logger')
-    # filename = "./log/schwad_performance_logger/performance-#{Time.now.strftime("%e-%m_%l:%M%p")}.log"
-    # File.write(filename, "")
-    # another_empty_csv_row
-    # @logger = Logger.new(filename)
+    system('mkdir log')
+    system('mkdir log/schwad_performance_logger')
+    filename = "./log/schwad_performance_logger/performance-#{Time.now.strftime("%e-%m_%l:%M%p")}.log"
+    File.write(filename, "")
+    another_empty_csv_row
+    @logger = Logger.new(filename)
     @options = options
     @sleep_amount = options[:pause].to_i
     @initial_memory = GetProcessMem.new.mb.round
@@ -39,8 +40,8 @@ class PLogger
   def log_performance(memo=nil)
     update_checks
     puts_performance(memo) unless @options[:puts] == false
-    # logger_performance(memo) unless @options[:log] == false
-    # csv_performance(memo) unless @options[:csv] == false
+    logger_performance(memo) unless @options[:log] == false
+    csv_performance(memo) unless @options[:csv] == false
     sleep @sleep_amount
   end
 
@@ -53,7 +54,7 @@ class PLogger
   end
 
   def logger_performance(memo)
-    @logger.log(1, "\n\n#{memo}: \n\n Current Memory: #{@current_memory} \n\n Memory Since Start: #{@delta_memory}\n\n Memory Since Last Run: #{@second_delta_memory}\n\n Time Passed: #{@delta_time} \n\n Time Since Last Run: #{@second_delta_time} ")
+    @logger.log(1, "#{options[:full_memo]}\n----------------------\n\n#{memo}: \n\n Current Memory: #{@current_memory} \n\n Memory Since Start: #{@delta_memory}\n\n Memory Since Last Run: #{@second_delta_memory}\n\n Time Passed: #{@delta_time} \n\n Time Since Last Run: #{@second_delta_time}\n--------------------\n\n ")
   end
 
   def another_empty_csv_row
@@ -64,7 +65,7 @@ class PLogger
 
   def csv_performance(memo)
     CSV.open("schwad_performance_logger_measurements.csv", "ab") do |csv|
-      csv << [@options[:csv_memo], memo, @current_memory, @delta_memory, @second_delta_memory, @delta_time, @second_delta_time]
+      csv << [@options[:full_memo], memo, @current_memory, @delta_memory, @second_delta_memory, @delta_time, @second_delta_time]
     end
   end
 

data/lib/schwad_performance_logger/version.rb

@@ -1,3 +1,3 @@
 module SchwadPerformanceLogger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schwad_performance_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nick Schwaderer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem