schwad_performance_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dc7e1108b9ce7a1a47286a502350df63f11390d
+  data.tar.gz: f6fe234f315b1e57ca7c8bb5c24b7f162661f286
+SHA512:
+  metadata.gz: 67e02cca112220cfb555a046326c06e4e11ba3c6111772451bda02a3fad12c4ba232040d921b2d8f80c2ee11c321dd68da6fa7c91aa5af2481fe6f7ab927907b
+  data.tar.gz: 3d79833a6f45e85189fa76acb9a67e997e0cf4bc3f4fbed9f855d9b1faf865d7022306d85eaa56df87a5c0e140de297b0ded878a51e17e97596fc82d5b1c3572

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nick.schwaderer@oceanshq.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in schwad_performance_logger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    schwad_performance_logger (0.1.0)
+      get_process_mem
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    get_process_mem (0.2.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  schwad_performance_logger!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nick Schwaderer
+
+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,75 @@
+# SchwadPerformanceLogger
+
+This gem allows you to track memory usage and time passage during the life of
+the SchwadPerformanceLogger object, as well as deltas between each check. The output
+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:
+
+```ruby
+gem 'schwad_performance_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schwad_performance_logger
+
+## Usage
+
+`pl = SchwadPerformanceLogger.new`
+
+```
+**********************************************************************
+Starting initialization. Current memory: 12(Mb), difference of 0 (mb) since beginning and difference of 0 since last log. time passed: 0.004678 seconds, time since last run: 0.004678
+**********************************************************************
+```
+
+Each subsequent log:
+
+`pl.log_performance("Test memo")`
+
+```
+*********************************************************************
+Starting Test memo. Current memory: 12(Mb), difference of 0 (mb) since beginning and difference of 0 since last log. time passed: 22.493993 seconds, time since last run: 9.616874
+*********************************************************************
+```
+
+### Options
+
+To disable any of the outputs:
+
+`SchwadPerformanceLogger.new({puts: false, log: false, csv: false})`
+
+To have the logger 'pause' a number of seconds during the `puts` logging so that
+you can actually see the log as it goes by. This does not affect the 'time' measurement:
+
+`SchwadPerformanceLogger.new({pause: 8})`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/schwad_performance_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SchwadPerformanceLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schwad_performance_logger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schwad_performance_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/schwad_performance_logger.rb

@@ -0,0 +1,16 @@
+require 'schwad_performance_logger/version'
+require 'csv'
+require 'logger'
+require 'get_process_mem'
+require 'schwad_performance_logger/schwad_performance_logger'
+
+
+module SchwadPerformanceLogger
+  def self.new(opts={})
+    if opts.is_a?(Hash)
+      PLogger.new(opts)
+    else
+      puts "I'm sorry, I don't know what you're trying to pass here!\n\n Please refer to the docs or pass an options hash https://github.com/oceanshq/schwad_performance_logger"
+    end
+  end
+end

data/lib/schwad_performance_logger/schwad_performance_logger.rb

@@ -0,0 +1,82 @@
+##
+# Logs performance during life of the object. Defaults to a trifecta of `puts`
+# output as well as logging to CSV (in the root folder) and
+# `log/schwad_performance_logger` for traditional info-level logging. It also gives
+# timing and memory usage info. Options include disabling extra logging,
+# including a 'sleep' parameter to have the application pause at each output
+# (so your puts info is not drowned). This does not impact the time output
+#
+# It also puts out delta memory and time so you can see 'between-log' spikes.
+#
+# This is stored in the system as 'second_delta'
+#
+class PLogger
+
+  attr_accessor :initial_memory, :initial_time, :current_memory, :last_memory, :current_time, :last_time, :delta_memory, :second_delta_memory, :delta_time, :second_delta_time, :sleep_amount, :sleep_adjuster, :logger
+
+  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)
+    @options = options
+    @sleep_amount = options[:pause].to_i
+    @initial_memory = GetProcessMem.new.mb.round
+    @current_memory = @initial_memory
+    @delta_memory = 0
+    @delta_time = 0
+    @initial_time = Time.now
+    @current_time = @initial_time
+    @last_time = @initial_time
+    @last_memory = @initial_memory
+    @sleep_adjuster = -@sleep_amount #This is to remove the sleeps for performance checking.
+    log_performance('initialization')
+  end
+
+  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
+    sleep @sleep_amount
+  end
+
+  private
+
+  def puts_performance(memo)
+    puts '*' * 300
+    puts "Starting #{memo}. Current memory: #{@current_memory}(Mb), difference of #{@delta_memory} (mb) since beginning and difference of #{@second_delta_memory} since last log. time passed: #{@delta_time} seconds, time since last run: #{@second_delta_time}"
+    puts '*' * 300
+  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} ")
+  end
+
+  def another_empty_csv_row
+    CSV.open("schwad_performance_logger_measurements.csv", "ab") do |csv|
+      csv << []
+    end
+  end
+
+  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]
+    end
+  end
+
+  def update_checks
+    @sleep_adjuster += @sleep_amount
+    @last_memory = @current_memory
+    @current_memory = GetProcessMem.new.mb.round
+    @second_delta_memory = @current_memory - @last_memory
+    @delta_memory = @current_memory - @initial_memory
+    @last_time = @current_time
+    @current_time = Time.now
+    @second_delta_time = @current_time - @last_time
+    @delta_time = (@current_time - @initial_time) - @sleep_adjuster
+  end
+end

data/lib/schwad_performance_logger/version.rb

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

data/schwad_performance_logger.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schwad_performance_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "schwad_performance_logger"
+  spec.version       = SchwadPerformanceLogger::VERSION
+  spec.authors       = ["Nick Schwaderer"]
+  spec.email         = ["nicholas.schwaderer@gmail.com"]
+
+  spec.summary       = %q{Track your memory and time performance in console, csv and/or logs.}
+  spec.homepage      = "https://github.com/oceanshq/schwad_performance_logger"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "get_process_mem"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: schwad_performance_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Schwaderer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- nicholas.schwaderer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/schwad_performance_logger.rb
+- lib/schwad_performance_logger/schwad_performance_logger.rb
+- lib/schwad_performance_logger/version.rb
+- schwad_performance_logger.gemspec
+homepage: https://github.com/oceanshq/schwad_performance_logger
+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.1
+signing_key: 
+specification_version: 4
+summary: Track your memory and time performance in console, csv and/or logs.
+test_files: []