wor-prof 0.1.0

data/lib/wor-prof.rb

@@ -0,0 +1,18 @@
+require 'wprof/version'
+require 'wprof/supports/style_support'
+require 'wprof/conf_wprof'
+require 'wprof/reporters/db_report'
+require 'wprof/reporters/external_report'
+require 'wprof/reporters/file_report'
+require 'wprof/wprof_reporter'
+require 'wprof/gen_prof'
+require 'wprof/wprof_subscriptors'
+
+
+module Wprof
+  def self.included(base)
+    load 'wprof/wprof_modules.rb'
+    base.extend(ForHttparty) if base.include?(HTTParty)
+    base.prepend(CustomMethods) unless WProf::Config.get_value(:custom_methods).nil?
+  end
+end

data/lib/wprof/conf_wprof.rb

@@ -0,0 +1,25 @@
+module WProf
+  class Config
+    DEFAULTS_CONFIGS = {
+      db_runtime: true,
+      reporter_type: 'LOGGER',
+      csv_type: 'SPLIT',
+      async: false,
+      httparty_methods_to_trace: %w[get put delete post patch].freeze,
+      external_url: nil,
+      external_headers: nil,
+      custom_methods: nil,
+      file_path: Rails.root.to_s
+    }.freeze
+
+    class << self
+      def get_value(param)
+        unless Rails.application.nil?
+          value = Rails.configuration.x.wprof[param]
+          return value unless value.nil?
+        end
+        DEFAULTS_CONFIGS[param]
+      end
+    end
+  end
+end

data/lib/wprof/gen_prof.rb

@@ -0,0 +1,73 @@
+class GenProf
+  include Wprof::Supports::StyleSupport
+
+  def initialize(event, rec_type)
+    @event = event
+    @db_runtime = WProf::Config.get_value(:db_runtime)
+    @async_report = WProf::Config.get_value(:async)
+    @rec_type = rec_type
+    generate_profiling
+  end
+
+  def generate_profiling
+    generate_common_params
+    generate_custom_params
+    deploy_reporter
+  end
+
+  private
+
+  def generate_common_params
+    @params = {
+      transaction_id: @event.transaction_id,
+      total_time: format_time(@event.duration),
+      start_dt: @event.time,
+      end_dt: @event.end
+    }
+  end
+
+  def generate_custom_params
+    case @rec_type
+    when :standard
+      app_params
+    when :service
+      service_params
+    when :custom
+      custom_params
+    end
+  end
+
+  def app_params
+    for_app_only = {
+      code: @event.payload[:status],
+      controller: @event.payload[:controller],
+      url: @event.payload[:path]
+    }
+    for_app_only[:db_runtime] = format_time(@event.payload[:db_runtime]) if @db_runtime
+    @params.merge!(for_app_only)
+  end
+
+  def service_params
+    for_service_only = {
+      code: @event.payload[:status],
+      service_hostname: @event.payload[:service_hostname],
+      request_uri: @event.payload[:request_uri]
+    }
+    @params.merge!(for_service_only)
+  end
+
+  def custom_params
+    for_customs_only = {
+      method: @event.payload[:method]
+    }
+    @params.merge!(for_customs_only)
+  end
+
+  def deploy_reporter
+    if @async_report
+      WprofReporter.perform_async(@params, @rec_type)
+    else
+      WprofReporter.new.perform(@params, @rec_type)
+    end
+  end
+end

data/lib/wprof/reporters/db_report.rb

@@ -0,0 +1,16 @@
+module Wprof
+  module Reporters
+    module DatabaseReport
+      def db_report
+        case @rec_type
+        when :service
+          WprofService.create(@data)
+        when :standard
+          WprofController.create(@data)
+        when :custom
+          WprofMethod.create(@data)
+        end
+      end
+    end
+  end
+end

data/lib/wprof/reporters/external_report.rb

@@ -0,0 +1,13 @@
+module Wprof
+  module Reporters
+    module ExternalReport
+      def generate_external_report
+        options = { body: @data }
+        headers = WProf::Config.get_value(:external_headers)
+        options.merge!(headers) unless headers.nil?
+        HTTParty.post(WProf::Config.get_value(:external_url),
+                      options)
+      end
+    end
+  end
+end

data/lib/wprof/reporters/file_report.rb

@@ -0,0 +1,59 @@
+module Wprof
+  module Reporters
+    module FileReport
+      def generate_file_report
+        require 'csv'
+        csv_type = WProf::Config.get_value(:csv_type) # rubocop:disable Lint/UselessAssignment
+        path = WProf::Config.get_value(:file_path)
+        send('write_#{csv_type.undercase}_file', path)
+      end
+
+      def write_mix_file(path)
+        CSV.open("#{path}/wprof.csv", 'ab') do |csv|
+          @data.to_a.each do |elem|
+            csv << elem
+          end
+        end
+      end
+
+      def write_split_file(path)
+        make_files(path)
+        case @rec_type
+        when :service
+          CSV.open("#{path}/wprofservice.csv", 'ab') do |csv|
+            csv << @data.values
+          end
+        when :standard
+          CSV.open("#{path}/wprofcontroller.csv", 'ab') do |csv|
+            csv << @data.values
+          end
+        when :custom
+          CSV.open("#{path}/wprofmethods.csv", 'ab') do |csv|
+            csv << @data.values
+          end
+        end
+      end
+
+      def make_files(path)
+        unless File.exist?("#{path}/wprofservice.csv")
+          params = %w[transaction_id total_time start_dt end_dt code service_hostname request_uri]
+          CSV.open("#{path}/wprofservice.csv", 'wb') do |csv|
+            csv << params
+          end
+        end
+        unless File.exist?("#{path}/wprofcontroller.csv")
+          params = %w[transaction_id total_time start_dt end_dt code controller url db_runtime]
+          CSV.open("#{path}/wprofcontroller.csv", 'wb') do |csv|
+            csv << params
+          end
+        end
+        unless File.exist?("#{path}/wprofmethods.csv") # rubocop:disable Style/GuardClause
+          params = %w[transaction_id total_time start_dt end_dt method]
+          CSV.open("#{path}/wprofmethods.csv", 'wb') do |csv|
+            csv << params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wprof/supports/style_support.rb

@@ -0,0 +1,9 @@
+module Wprof
+  module Supports
+    module StyleSupport
+      def format_time(time)
+        time.round(4)
+      end
+    end
+  end
+end

data/lib/wprof/version.rb

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

data/lib/wprof/wprof_modules.rb

@@ -0,0 +1,32 @@
+module ForHttparty
+  httparty_methods_to_trace = WProf::Config.get_value(:httparty_methods_to_trace)
+  httparty_methods_to_trace.each do |name_method|
+    define_method(name_method.to_s) do |*arg|
+      ActiveSupport::Notifications.instrument 'wprof.service', data = {} do
+        rest = super(*arg)
+        begin
+          data[:status] = rest&.code
+          data[:service_hostname] = rest&.request&.path&.hostname
+          data[:request_uri] = rest&.request&.path&.request_uri
+        rescue StandardError => e
+          err_message = "WProf ERROR when try parsing service response: #{e}"
+          Rails.logger.warn(err_message)
+        end
+        rest
+      end
+    end
+  end
+end
+
+module CustomMethods
+  custom_methods = WProf::Config.get_value(:custom_methods)
+  unless custom_methods.nil?
+    custom_methods.each do |name_method|
+      define_method(name_method.to_s) do |*arg|
+        ActiveSupport::Notifications.instrument 'wprof.custom', method: name_method.to_s do
+          super(*arg)
+        end
+      end
+    end
+  end
+end

data/lib/wprof/wprof_reporter.rb

@@ -0,0 +1,34 @@
+class WprofReporter
+  include Sidekiq::Worker
+  include Wprof::Reporters::FileReport
+  include Wprof::Reporters::DatabaseReport
+  include Wprof::Reporters::ExternalReport
+
+  def perform(data, rec_type)
+    @data = data
+    @rec_type = rec_type.to_sym
+    reporter
+  rescue StandardError => error
+    Rails.logger.warn("An error was raised when WProf tried to send data to reporter: #{error}")
+  end
+
+  def reporter
+    reporter_type = WProf::Config.get_value(:reporter_type)
+    case reporter_type
+    when 'LOGGER'
+      logger_report
+    when 'FILE'
+      generate_file_report
+    when 'DATABASE'
+      db_report
+    when 'EXTERNAL'
+      generate_external_report
+    else
+      logger_report
+    end
+  end
+
+  def logger_report
+    Rails.logger.info(@data)
+  end
+end

data/lib/wprof/wprof_subscriptors.rb

@@ -0,0 +1,16 @@
+module WprofSubscriptors
+  ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    GenProf.new(event, :standard)
+  end
+
+  ActiveSupport::Notifications.subscribe 'wprof.service' do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    GenProf.new(event, :service)
+  end
+
+  ActiveSupport::Notifications.subscribe 'wprof.custom' do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    GenProf.new(event, :custom)
+  end
+end

data/wor-prof.gemspec

@@ -0,0 +1,36 @@
+require File.expand_path("../lib/wprof/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'wor-prof'
+  s.version     = Wprof::VERSION
+  s.date        = '2019-04-05'
+  s.summary     = 'Wor-Profiling Gem for Rails'
+  s.description = "Wor-prof (Wprof) is a gem for Ruby On Rails which its only purpose is to measure a RoR app's performance through a profile with different times of response.
+  Catch all request and save them into a database, csv file or send to external service, it's easy to configure and use. Wprof can take measure of HTTParty requests and your own methods."
+  s.authors     = ['mcolombo87']
+  s.author      = 'Maximiliano Colombo'
+  s.email       = ['maximiliano.colombo@wolox.com.ar', 'mcolombo87@gmail.com']
+  s.require_paths = ['lib']
+  s.files       = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec)/}) }
+
+  s.homepage    =
+    'https://github.com/Wolox/wor-prof'
+  s.license = 'MIT'
+  s.extra_rdoc_files = ['README.md', 'doc/user-guide_en.md','doc/user-guide_es.md' ]
+  s.required_ruby_version = '>= 2.4'
+
+  s.add_dependency 'rails', '>= 4.0.2'
+  s.add_dependency 'sidekiq', '~> 5.2'
+  s.add_dependency 'httparty', '~> 0.15'
+  s.add_development_dependency "bundler", "~> 1.17"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency 'factory_bot_rails'
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'rails', '>= 4.0.2'
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency 'sidekiq', '~> 5.2'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-console'
+end

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification
+name: wor-prof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maximiliano Colombo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  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: |-
+  Wor-prof (Wprof) is a gem for Ruby On Rails which its only purpose is to measure a RoR app's performance through a profile with different times of response.
+    Catch all request and save them into a database, csv file or send to external service, it's easy to configure and use. Wprof can take measure of HTTParty requests and your own methods.
+email:
+- maximiliano.colombo@wolox.com.ar
+- mcolombo87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- doc/user-guide_en.md
+- doc/user-guide_es.md
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doc/user-guide_en.md
+- doc/user-guide_es.md
+- lib/generators/wprof_generator.rb
+- lib/generators/wprof_model_generator.rb
+- lib/wor-prof.rb
+- lib/wprof/conf_wprof.rb
+- lib/wprof/gen_prof.rb
+- lib/wprof/reporters/db_report.rb
+- lib/wprof/reporters/external_report.rb
+- lib/wprof/reporters/file_report.rb
+- lib/wprof/supports/style_support.rb
+- lib/wprof/version.rb
+- lib/wprof/wprof_modules.rb
+- lib/wprof/wprof_reporter.rb
+- lib/wprof/wprof_subscriptors.rb
+- wor-prof.gemspec
+homepage: https://github.com/Wolox/wor-prof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Wor-Profiling Gem for Rails
+test_files: []