hot_catch 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce4c89223725b3c189db6f67ccca14d5d3f2f92a
+  data.tar.gz: 6cb563238d8ee4e61b38900ada6e32909328f81a
+SHA512:
+  metadata.gz: a821681cac3f21fd3b43f1486a523e9adbe368af0b4b2abc6b0e7c0de6460d8ac269ad8cdc63e319fd9027d400102a0f644c82ae1ff2cae5e453a9b5aa51f62e
+  data.tar.gz: 2172336cfc52925ce9b3d1171d0d47024051350471d3fb5c4bd187df44226d205089177dd0e38eabefe012b89dee501addf7ba3b91409faedf2f20368c9873c5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Davhot
+
+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,27 @@
+# HotCatch
+Данный гем позволяет изменить логирование в базу данных.
+В дальнейшем будет отправлять логи главному приложению.
+
+## Использование
+Логи можно посмотреть в консоли:
+```ruby
+> HotCatchLog.all
+> HotCatchLog.first.log_data
+```
+В данной реализации логи разделены по статусам запросов (поле `status HotCatchLog`).
+Кроме того одинаковые ошибки собираются в одну, при этом увеличивается счётчик в моделе (поле `count_log HotCatchLog`).
+
+## Установка
+1. Добавить гем в `Gemfile`
+```ruby
+gem 'hot_catch'
+```
+2. `$ bundle install`
+3. Запустить генератор установки: `$ rails generate hot_catch:install`
+Для удаления: `$ rails generate hot_catch:uninstall`
+4. `$ rails db:migrate`
+
+Это всё! Теперь все логи формируются в базе данных.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HotCatch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/hot_catch/install_generator.rb

@@ -0,0 +1,57 @@
+# rails generate testgem:install
+
+require 'rails/generators'
+
+module HotCatch
+  class InstallGenerator < Rails::Generators::Base
+     # Включение всех файлов из указанной папки относительно __FILE__ (то есть текущего файла)
+    source_root File.expand_path('../../../hot_catch', __FILE__)
+    # include Rails::Generators::Migration
+
+    def add_model_hot_catch
+      create_file "db/migrate/20170729154223_create_hot_catch_log.rb" do
+<<RUBY
+class CreateHotCatchLog < ActiveRecord::Migration[5.0]
+  def change
+    create_table :hot_catch_logs do |t|
+      t.string :log_data, null: false
+      t.integer :count_log, default: 1, null: false
+      t.string :status, null: false
+
+      t.timestamps
+    end
+  end
+end
+RUBY
+      end
+
+      create_file "app/models/application_record.rb" do
+        "class ApplicationRecord < ActiveRecord::Base
+          self.abstract_class = true
+        end"
+      end unless File.exist? "app/models/application_record.rb"
+
+
+      copy_file "hot_catch_log.rb", "app/models/hot_catch_log.rb"
+    end
+
+
+    def add_rack_logger
+      copy_file "hot_catch_logger.rb", "config/hot_catch_logger.rb"
+    end
+
+    def change_files
+      insert_into_file "config/application.rb", "\nrequire_relative 'hot_catch_logger'\n", :before => "module ExampleApp"
+
+      application "config.middleware.insert_before Rails::Rack::Logger, Rails::Rack::HotCatchLogger\n
+    config.middleware.delete Rails::Rack::Logger"
+
+      insert_string = "\n  require 'hot_catch/custom_log_subscribers.rb'
+  config.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new('hot_catch_buf_file'))\n"
+
+      insert_into_file "config/environments/development.rb", insert_string, :after => "Rails.application.configure do"
+      insert_into_file "config/environments/production.rb",  insert_string, :after => "Rails.application.configure do"
+    end
+
+  end
+end

data/lib/generators/hot_catch/uninstall_generator.rb

@@ -0,0 +1,28 @@
+# rails generate testgem:install
+
+require 'rails/generators'
+
+module HotCatch
+  class UninstallGenerator < Rails::Generators::Base
+    # include Rails::Generators::Migration
+
+    def remove_model_hot_catch
+      remove_file "db/migrate/20170729154223_create_hot_catch_log.rb"
+      remove_file "app/models/hot_catch_log.rb"
+    end
+
+    def remove_rack_logger
+      remove_file "config/hot_catch_logger.rb"
+    end
+
+    def unchange_files
+      gsub_file "config/application.rb", /require_relative 'hot_catch_logger'/, ""
+      gsub_file "config/application.rb", /config.*Logger/, ""
+
+      gsub_file "config/environments/development.rb", /.*\s.*hot_catch_buf_file'\)\)/, ""
+      gsub_file "config/environments/production.rb", /.*\s.*hot_catch_buf_file'\)\)/, ""
+    end
+
+
+  end
+end

data/lib/hot_catch.rb

@@ -0,0 +1,3 @@
+module HotCatch
+  require 'hot_catch/custom_log_subscribers.rb'
+end

data/lib/hot_catch/custom_log_subscribers.rb

@@ -0,0 +1,67 @@
+require 'active_record/log_subscriber'
+
+class CustomActiveRecordLogSubscriber < ActiveRecord::LogSubscriber
+  # Убрана подсветка и не логируется таблица hot_catch_buf_file
+  def sql(event)
+    self.class.runtime += event.duration
+    return unless logger.debug?
+
+    payload = event.payload
+
+    return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+    name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+    sql   = payload[:sql]
+    binds = nil
+
+    unless (payload[:binds] || []).empty?
+      casted_params = type_casted_binds(payload[:binds], payload[:type_casted_binds])
+      binds = "  " + payload[:binds].zip(casted_params).map { |attr, value|
+        render_bind(attr, value)
+      }.inspect
+    end
+
+    # name = colorize_payload_name(name, payload[:name])
+    # sql  = color(sql, sql_color(sql), true)
+
+    debug "  #{name}  #{sql}#{binds}" unless payload[:sql].to_s =~ /hot_catch_logs|COMMIT|BEGIN/
+  end
+end
+
+# Отписка от уведомлений ActiveRecord::LogSubscriber
+notifier = ActiveSupport::Notifications.notifier
+subscribers = notifier.listeners_for("sql.active_record")
+subscribers.each {|s| ActiveSupport::Notifications.unsubscribe s }
+
+# Подписка на уведомления CustomActiveRecordLogSubscriber
+CustomActiveRecordLogSubscriber.attach_to :active_record
+# ====================================================================================
+require 'action_controller/log_subscriber'
+
+class CustomActionControllerLogSubscriber < ActionController::LogSubscriber
+  # Статус записывается в лог файл hot_catch_buf_file
+  def process_action(event)
+    payload   = event.payload
+    additions = ActionController::Base.log_process_action(payload)
+
+    status = payload[:status]
+    if status.nil? && payload[:exception].present?
+      exception_class_name = payload[:exception].first
+      status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+    end
+
+    File.open('hot_catch_buf_file', 'a'){ |file| file.puts "!!!#{status}!!!" }
+
+    info do
+
+      message = "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{event.duration.round}ms"
+      message << " (#{additions.join(" | ")})" unless additions.blank?
+      message
+    end
+  end
+end
+
+subscribers = notifier.listeners_for("process_action.action_controller")
+subscribers.each {|s| ActiveSupport::Notifications.unsubscribe s }
+
+CustomActionControllerLogSubscriber.attach_to :action_controller

data/lib/hot_catch/hot_catch_log.rb

@@ -0,0 +1,60 @@
+class HotCatchLog < ApplicationRecord
+
+  validates :log_data, :status, presence: true
+  validates :count_log, presence: true, numericality: {only_integer: true, greater_than: 0}
+
+  STATUSES = ["STATUS", "SUCCESS", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "WARNING"]
+
+  # Проверка лога на уникальность
+  def self.process_data_log(str)
+    str, status = get_status(str)
+
+    # Если статус не найден, то возможна ошибка в контроллере
+    status = STATUSES[3] if !status && str =~ /ActionController/
+
+    str2 = strip_str(str)
+    opt = true
+
+    HotCatchLog.where(status: status).each do |cur_log|
+      if strip_str(cur_log.log_data) == str2
+        cur_log.count_log += 1
+        cur_log.save
+        opt = false
+        return
+      end
+    end
+
+    if opt && str.strip.present? && status.present?
+      HotCatchLog.create(log_data: format_log(str), status: status)
+    end
+
+  end
+
+  private
+
+  # Метод для сравнения логов
+  def self.strip_str(str)
+    str = str.dup
+  	str.gsub!(/\d+(\.\d+)?ms/, "") # За сколько выполнилось действие
+    str.gsub!(/\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s\+\d{4}/, "") # дата
+    str.gsub!(/#<.*:0x[\d|\w]+>/, "") # Объект (например #<StaticPagesController:0x007f37791686d8>)
+    format_log(str)
+  end
+
+  # Помимо сравнения логов, нужен для форматирования лога и записи в бд
+  def self.format_log(str)
+    str = str.split("\n").select{|x| x.present?}.join("\n") # убирает повторяющиеся переводы строки
+    str.strip! # лишние символы пропусков в начале и конце
+    str
+  end
+
+  # Возвращает статус и лог без статуса
+  def self.get_status(str)
+    status = str.match(/!!!(\d{3})!!!/)
+    status = status[1] if status
+    str = str.gsub(/!!!(\d{3})!!!\s/, "")
+    status = STATUSES[status[0].to_i - 1] if status.present?
+    [str, status]
+  end
+
+end

data/lib/hot_catch/hot_catch_logger.rb

@@ -0,0 +1,114 @@
+require 'active_support/core_ext/time/conversions'
+require 'active_support/core_ext/object/blank'
+require 'active_support/log_subscriber'
+require 'action_dispatch/http/request'
+require 'rack/body_proxy'
+# require 'rack/utils'
+
+require_relative '../app/models/application_record.rb'
+require_relative '../app/models/hot_catch_log.rb'
+
+module Rails
+  module Rack
+    # Sets log tags, logs the request, calls the app, and flushes the logs.
+    #
+    # Log tags (+taggers+) can be an Array containing: methods that the +request+
+    # object responds to, objects that respond to +to_s+ or Proc objects that accept
+    # an instance of the +request+ object.
+    class HotCatchLogger < ActiveSupport::LogSubscriber
+      def initialize(app, taggers = nil)
+        @app          = app
+        @taggers      = taggers || []
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+
+        if logger.respond_to?(:tagged)
+          logger.tagged(compute_tags(request)) { call_app(request, env) }
+        else
+          call_app(request, env)
+        end
+      end
+
+    protected
+
+      def call_app(request, env)
+        instrumenter = ActiveSupport::Notifications.instrumenter
+        instrumenter.start 'request.action_dispatch', request: request
+
+        # Флаг начала запроса
+        logger << "\nBEGIN\n"
+
+        logger.info { started_request_message(request) }
+        resp = @app.call(env)
+        resp[2] = ::Rack::BodyProxy.new(resp[2]) { finish(request) }
+        resp
+      rescue Exception
+        finish(request)
+        raise
+      ensure
+        ActiveSupport::LogSubscriber.flush_all!
+      end
+
+      # Started GET "/session/new" for 127.0.0.1 at 2012-09-26 14:51:42 -0700
+      def started_request_message(request)
+        'Started %s "%s" for %s at %s' % [
+          request.request_method,
+          request.filtered_path,
+          request.ip,
+          Time.now.to_default_s ]
+      end
+
+      def compute_tags(request)
+        @taggers.collect do |tag|
+          case tag
+          when Proc
+            tag.call(request)
+          when Symbol
+            request.send(tag)
+          else
+            tag
+          end
+        end
+      end
+
+      private
+
+      def finish(request)
+        # Если быстро обновлять страницу, то конец лога не успевает записаться.
+        # Для этого записываем последний лог в новый файл и с новым запросом считываем
+        # его и записанный конец лога из изначального лог-файла.
+
+        # Считали данные из основного лог-файла
+        logs = ""
+        File.open('hot_catch_buf_file'){ |file| logs = file.read}
+        File.open('hot_catch_buf_file', 'w'){ |file| file.print "" }
+        logs = logs.split("BEGIN").delete_if{|x| !x.present? }
+
+        # Считали данные из дополнительного лог-файла и записали начало последнего лога
+        add_log = ""
+        File.open('hot_catch_buf_file2'){ |file| add_log = file.read} if File.exist?('hot_catch_buf_file2')
+        File.open('hot_catch_buf_file2', 'w'){ |file| file.print logs[-1] }
+        logs.delete_at(-1)
+
+        # Собираем начало лога и конец
+        add_log = add_log + (logs[0]).to_s
+        HotCatchLog.process_data_log(add_log) unless add_log.strip =~ /assets/
+
+        logs.delete_at(0)
+        # Обрабатываем остальные логи, если есть
+        logs.each {|log| HotCatchLog.process_data_log(log) unless log.strip =~ /assets/}
+
+
+
+        instrumenter = ActiveSupport::Notifications.instrumenter
+        instrumenter.finish 'request.action_dispatch', request: request
+      end
+
+      def logger
+        Rails.logger
+      end
+    end
+  end
+end

data/lib/hot_catch/version.rb

@@ -0,0 +1,3 @@
+module HotCatch
+  VERSION = '0.1.1'
+end

data/lib/tasks/hot_catch_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hot_catch do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: hot_catch
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Davhot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-09 00:00:00.000000000 Z
+dependencies: []
+description: Description of Testgem.
+email:
+- david.home@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/hot_catch/install_generator.rb
+- lib/generators/hot_catch/uninstall_generator.rb
+- lib/hot_catch.rb
+- lib/hot_catch/custom_log_subscribers.rb
+- lib/hot_catch/hot_catch_log.rb
+- lib/hot_catch/hot_catch_logger.rb
+- lib/hot_catch/version.rb
+- lib/tasks/hot_catch_tasks.rake
+homepage: https://myhomepage.com
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Summary of Testgem.
+test_files: []