restash_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f4f285f9235a1d159cb46e296d7718b29c86514
+  data.tar.gz: 563ec6ccee616fcea16146d1f05e04fea2725b54
+SHA512:
+  metadata.gz: a63b259e876f4973613f3826b1742f5a07880f6e065c596a7e74571347397a2c2cdacce1bb438ff0bea56d90b4d0c0558f643a8e545557544881515446988b64
+  data.tar.gz: d4730a1093aa64599df276fe242cc67f0d73fe8a6b75a8c4983e21d0904b0de7918f6bb6211cc6e248783d5a3321ce1ecaf9c3964325908b0db30c4327cca51d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 dmitri@yotpo.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in restash_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gitelzon Dmitri
+
+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,74 @@
+# RestashRails
+
+This gem is sending Json structured logs from your Rails app to destination you define.
+We propose Logstash as a receiver. <br>
+Logs sent via TCP socket with timeout, you'll define or with default of 10ms 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restash_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restash_rails
+
+## Usage
+Data is written to host and port you provide via configs. 
+We open TCP socket with timeout option you provide.
+We send it in json format. So the logstash is one of the receivers you can use, 
+without any special config.
+We also let you to path yours app custom exceptions and there statuses.
+If you not, gem won't be possible to translate an exception to an appropriate status.
+As a result, some responses will be logged without an exception status
+Pay attention that we won't let you override Rails native exceptions statuses.
+
+##### In application.rb
+
+```ruby
+#Restahs rails won't work unless you enable it
+config.restash_rails.enabled = true
+
+#If you want to leave original Rails Logs
+config.restash_rails.keep_original_logs = true
+
+#Host and port the data will be sent to 
+config.restash_rails.host = '127.0.0.1'
+config.restash_rails.port = '9200'
+
+#TCP Timeout options
+config.restash_rails.timeout_options = {connect_timeout: DEFAULT_TIMEOUT, write_timeout: DEFAULT_TIMEOUT, read_timeout: DEFAULT_TIMEOUT}
+
+#exception_statuses 
+error_401 = {:status => 401, :types => [Exceptions::AccessDenied, Exceptions::MyException]}
+error_422 = {:status => 422, :types => [Exceptions::InvalidParams]}
+config.exception_statuses = [error_401, error_422]
+```
+
+All those configs can also be paassed as yaml file
+```ruby
+RESTASH_RAILS_CONF =  YAML::load(PATH_TO_YOUR_CONFIG_FILE)
+config.restash_rails = RESTASH_RAILS_CONF[Rails.env]
+```
+## 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/YotpoLtd/restash-rails. 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](http://opensource.org/licenses/MIT).
+

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 "restash_rails"
+
+# 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/restash_rails/formatters/default.rb

@@ -0,0 +1,19 @@
+module RestashRails
+  module Formatter
+    class Default
+      def format_message(message = nil)
+        log_message = {}
+        message.is_a?(Hash) ? log_message.merge!(message) : log_message[:log_message] = message
+        return log_message
+      rescue => e
+        {
+            severity: 'ERROR',
+            log_message: 'Failed to format logstash message',
+            exception: { class: e.class, message: e.message },
+            logstash_message: log_message,
+            log_tag: :logstash_formatter_failed
+        }
+      end
+    end
+  end
+end

data/lib/restash_rails/log_subscriber/log_subscriber.rb

@@ -0,0 +1,24 @@
+require 'restash_rails/log_subscriber/subscribers/active_record'
+require 'restash_rails/log_subscriber/subscribers/active_support'
+require 'restash_rails/log_subscriber/subscribers/action_view'
+require 'restash_rails/log_subscriber/subscribers/action_mailer'
+
+module RestashRails
+  module LogSubscriber
+    def subscribe_logs(configs)
+      RestashRails::LogSubscriber::ActiveSupport.attach_to :action_controller
+      RestashRails::LogSubscriber::ActiveRecord.attach_to :active_record
+      RestashRails::LogSubscriber::ActionView.attach_to :action_view
+      RestashRails::LogSubscriber::ActionMailer.attach_to :action_mailer
+      require 'restash_rails/resque/logging' if is_true?(configs[:resque_log])
+      if is_true?(configs[:cache_log])
+        require 'restash_rails/log_subscriber/subscribers/cache'
+        RestashRails::LogSubscriber::Cache.attach_to :active_support
+      end
+    end
+
+    def is_true?(variable)
+      (variable.present? && (variable == true || variable == 'true'))
+    end
+  end
+end

data/lib/restash_rails/log_subscriber/subscribers/action_mailer.rb

@@ -0,0 +1,23 @@
+require 'action_mailer/log_subscriber'
+
+module RestashRails
+  module LogSubscriber
+    class ActionMailer < ::ActionMailer::LogSubscriber
+      def deliver(event)
+        ::RestashRails.logger.info(generate_message(event, 'deliver'))
+      end
+
+      private
+
+      def generate_message(event, action)
+        {
+            to: event.payload[:to],
+            duration: event.duration.round(2),
+            action: action,
+            log_tag: :action_mailer
+        }
+
+      end
+    end
+  end
+end

data/lib/restash_rails/log_subscriber/subscribers/action_view.rb

@@ -0,0 +1,25 @@
+require 'action_view/log_subscriber'
+
+module RestashRails
+  module LogSubscriber
+    class ActionView < ::ActionView::LogSubscriber
+      def render_template(event)
+        ::RestashRails.logger.info(generate_message(event))
+      end
+      alias :render_partial :render_template
+      alias :render_collection :render_template
+
+      private
+
+      def generate_message(event)
+        message = {
+            duration: event.duration.round(2),
+            identifier: from_rails_root(event.payload[:identifier]),
+            log_tag: :action_view
+        }
+        message.merge!(layout: from_rails_root(event.payload[:layout])) unless event.payload[:layout].nil?
+        return message
+      end
+    end
+  end
+end

data/lib/restash_rails/log_subscriber/subscribers/active_record.rb

@@ -0,0 +1,22 @@
+require 'active_record/log_subscriber'
+
+module RestashRails
+  module LogSubscriber
+    class ActiveRecord < ::ActiveRecord::LogSubscriber
+      def sql(event)
+        ::RestashRails.logger.debug(generate_message(event))
+      end
+
+      private
+
+      def generate_message(event)
+        {
+            sql: event.payload[:sql].to_s,
+            duration: event.duration.round(2),
+            name: event.payload[:name],
+            log_tag: :active_record
+        }
+      end
+    end
+  end
+end

data/lib/restash_rails/log_subscriber/subscribers/active_support.rb

@@ -0,0 +1,74 @@
+require 'active_support/log_subscriber'
+require 'restash_rails/rails_ext/action_pack/action_controller/metal/instrumentation'
+
+module RestashRails
+  module LogSubscriber
+    class ActiveSupport < ::ActionController::LogSubscriber
+      def process_action(event)
+        log_message = generate_message(event)
+        if log_message[:response_code] >= 500
+          logger.error(log_message)
+        elsif log_message[:response_code] >= 300
+          logger.warn(log_message)
+        else
+          logger.info(log_message)
+        end
+      end
+
+      def redirect_to(event)
+        log_message = generate_message(event)
+        logger.info (log_message)
+      end
+
+      def logger
+        ::RestashRails.logger
+      end
+
+      private
+
+      def exception_formatter(payload)
+        return {} if payload[:exception].nil?
+        exception = payload[:exception]
+        { class: exception.class, message: exception.message, backtrace: exception.backtrace }
+      end
+
+
+      def extract_status(payload)
+        if (status = payload[:status])
+          status.to_i
+        elsif (error = payload[:exception])
+          exception, message = error
+          get_error_status_code(exception)
+        else
+          200
+        end
+      end
+
+      def get_error_status_code(exception)
+        status = ::ActionDispatch::ExceptionWrapper.rescue_responses[exception]
+        ::Rack::Utils.status_code(status)
+      end
+
+      def generate_message(event)
+        payload = event.payload
+        excepted_params = %w(controller action format id)
+        {
+            controller: payload[:controller].to_s,
+            action: payload[:action].to_s,
+            request_method: payload[:method].to_s,
+            uuid: payload[:request_id],
+            response_code: extract_status(payload),
+            path: payload[:path].to_s,
+            format: payload[:format].to_s,
+            request_params: (payload[:params].except(*excepted_params) rescue {}),
+            duration: event.duration.to_f.round(2),
+            redirect_to: payload[:location] || '',
+            db_duration: ((payload[:db_runtime] * 100).round(2)/100.0 rescue 0.0),
+            view_duration: ((payload[:view_runtime] * 100).round(2)/100.0 rescue 0.0),
+            log_tag: :action_controller,
+            exception: exception_formatter(payload)
+        }
+      end
+    end
+  end
+end

data/lib/restash_rails/log_subscriber/subscribers/cache.rb

@@ -0,0 +1,69 @@
+require 'restash_rails/rails_ext/active_support/cache/store'
+require 'active_support/log_subscriber'
+
+module RestashRails
+  module LogSubscriber
+    class Cache < ::ActiveSupport::LogSubscriber
+      def cache_read(event)
+        log(event)
+      end
+      def cache_delete_tag_tree(event)
+        log(event)
+      end
+      def cache_delete_wiled_card(event)
+        log(event)
+      end
+      def cache_write_value(event)
+        log(event)
+      end
+      def cache_write_tags(event)
+        log(event)
+      end
+      def cache_write(event)
+        log(event)
+      end
+      def cache_fetch(event)
+        log(event)
+      end
+      def cache_delete_tag_keys(event)
+        log(event)
+      end
+      def cache_delete(event)
+        log(event)
+      end
+
+      def logger
+        ::RestashRails.logger
+      end
+
+      private
+
+      def log(event)
+        message = generate_message(event)
+        (duration > 100) ?
+            logger.debug(message.merge({ execution: 'slow' })) :
+            logger.debug(message)
+      end
+
+      def generate_message(event)
+        payload = event.payload
+        message = {
+            name: event.name,
+            duration: event.duration,
+            cache_key: payload[:key],
+            host: payload[:host],
+            port: payload[:port],
+            expire_in: payload[:expire_in],
+            log_tag: :cache
+        }
+        message.merge(exception_formatter(payload))
+      end
+
+      def exception_formatter(payload)
+        return {} if payload[:exception].nil?
+        exception_class, message = payload[:exception]
+        { exception_class: exception_class, message: message}
+      end
+    end
+  end
+end

data/lib/restash_rails/logger.rb

@@ -0,0 +1,93 @@
+require 'tcp_timeout'
+
+module RestashRails
+  class Logger
+    include ::Logger::Severity
+    attr_accessor :app_name, :level, :outputter, :formatter, :logstash_host, :logstash_port, :timeout_options
+    DEFAULT_TIMEOUT = 0.010
+
+    def initialize(configs)
+      self.level = configs[:level] || 'DEBUG'
+      @logstash_host = configs[:host] || '127.0.0.1' #logstash host
+      @logstash_port = configs[:port].to_i || 5960 #logstash port
+      @app_name = configs[:app_name] || ENV['APP_NAME'] || Rails.application.class.name
+      #TCP connection timeouts in milliseconds
+      if configs[:timeout_options].present?
+        configs[:timeout_options].each{ |k,v| configs[:timeout_options][k] = v.to_f }
+        @timeout_options = configs[:timeout_options]
+      else
+        @timeout_options = { connect_timeout: DEFAULT_TIMEOUT, write_timeout: DEFAULT_TIMEOUT, read_timeout: DEFAULT_TIMEOUT }
+      end
+      set_formatter(configs)
+    end
+
+    ::Logger::Severity.constants.each do |severity|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+
+            def #{severity.downcase}?                # def debug?
+              log_severity_allowed?(#{severity})     #   log_severity_allowed?(DEBUG)
+            end                                      # end
+
+            def #{severity.downcase}(message = nil)     # def debug(message = nil)
+              log('#{severity.upcase}', message)        #   log('DEBUG', message)
+            end                                         # end
+      METHOD
+    end
+
+    def level=(level)
+      return @level if @level.present?
+      if level.is_a?(Integer)
+        ::Logger::Severity.constants.each { |severity|
+          return @level = severity if level == severity
+        }
+        raise "Log level #{level} not recognised"
+      else
+        desired_level = level.to_s.upcase
+        raise "Log level #{level} not recognised" unless self.class.constants.include?(desired_level.to_sym)
+        return  @level = class_eval(desired_level)
+      end
+    end
+    
+    private
+
+    def set_formatter(configs)
+      formatter_name = configs[:formatter] || Formatter::Default
+      @formatter = formatter_name.new
+    end
+
+    def log(severity, message = nil)
+      severity_value = class_eval(severity.to_s.upcase)
+      return unless log_severity_allowed?(severity_value)
+      log_message = {}
+      log_message[:severity] = severity
+      log_message[:app_name] = app_name
+      log_message[:rails_env] = environment
+      log_message.merge!(formatter.format_message(message))
+      log_message = log_message.with_indifferent_access
+      log_message[:log_tag] ||= :custom
+      write(log_message)
+    end
+
+    def log_severity_allowed?(severity)
+      return false unless severity.is_a?(Integer)
+      severity >= level
+    end
+
+    def write(data)
+      json_data = data.to_json
+      sock = ::TCPTimeout::TCPSocket.new(logstash_host, logstash_port, timeout_options)
+      sock.write(json_data)
+      sock.close
+    rescue => e
+      failures_logger = ::Logger.new(STDOUT)
+      failures_logger.error({ status: "Failed to write data to #{logstash_host}:#{logstash_port}",  exception: e, data: data })
+    end
+
+    def environment
+      (defined?(ENV['RAILS_ENV']) && ENV['RAILS_ENV']) ||
+          (defined?(Rails.env) && Rails.env) ||
+          (defined?(ENV['RACK_ENV']) && ENV['RACK_ENV']) ||
+          :unknown
+    end
+  end
+end

data/lib/restash_rails/logs_unsubscriber.rb

@@ -0,0 +1,47 @@
+require 'action_view/log_subscriber'
+require 'action_controller/log_subscriber'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/ordered_options'
+require 'restash_rails/rails_ext/rack/logger'
+
+module RestashRails
+  module LogsUnsubscriber
+    def disable_additional_logs
+      disable_rack_cache_verbose_output(Rails.application) if defined?(Rails)
+      ::ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+        case subscriber.class.name
+          when 'ActionView::LogSubscriber'
+            unsubscribe(:action_view, subscriber)
+          when 'ActionController::LogSubscriber'
+            unsubscribe(:action_controller, subscriber)
+          when 'ActionMailer::LogSubscriber'
+            unsubscribe(:action_mailer, subscriber)
+          when 'ActiveRecord::LogSubscriber'
+            unsubscribe(:active_record, subscriber)
+        end
+      end
+    end
+
+    private
+
+    def unsubscribe(component, subscriber)
+      events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+      events.each do |event|
+        ::ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+          if listener.instance_variable_get('@delegate') == subscriber
+            ::ActiveSupport::Notifications.unsubscribe listener
+          end
+        end
+      end
+    end
+
+    def rack_cache_hashlike?(app)
+      app.config.action_dispatch.rack_cache && app.config.action_dispatch.rack_cache.respond_to?(:[]=)
+    end
+
+    def disable_rack_cache_verbose_output(app)
+      app.config.action_dispatch.rack_cache[:verbose] = false if rack_cache_hashlike?(app)
+    end
+  end
+end

data/lib/restash_rails/rails_ext/action_dispatch/middleware/debug_exceptions.rb

@@ -0,0 +1,24 @@
+require 'action_dispatch/middleware/debug_exceptions'
+
+module ActionDispatch
+  class DebugExceptions
+    alias_method :default_log_error, :log_error
+    def log_error(env, wrapper)
+      exception = wrapper.exception
+      if exception.is_a?(ActionController::RoutingError)
+        message = {
+            request_method: env['REQUEST_METHOD'],
+            request_path: env['REQUEST_PATH'],
+            response_code: wrapper.status_code,
+            log_tag: :action_controller,
+            exception: { class: exception.class.name, message: exception.message }
+        }
+        ::RestashRails.logger.warn(message)
+      else
+        default_log_error env, wrapper
+      end
+    rescue
+      default_log_error env, wrapper
+    end
+  end
+end

data/lib/restash_rails/rails_ext/action_pack/action_controller/metal/instrumentation.rb

@@ -0,0 +1,26 @@
+module ActionController
+  module Instrumentation
+    def process_action(*args)
+      raw_payload = {
+          controller:  self.class.name,
+          action:  self.action_name,
+          params:  request.filtered_parameters,
+          format:  request.format.try(:ref),
+          method:  request.method,
+          path:  (request.fullpath rescue 'unknown'),
+          request_id:  (env['action_dispatch.request_id'] rescue 'not_defined')
+      }
+      ActiveSupport::Notifications.instrument('start_processing.action_controller', raw_payload.dup)
+
+      ActiveSupport::Notifications.instrument('process_action.action_controller', raw_payload) do |payload|
+        begin
+          result = super
+          payload[:status] = response.status
+          result
+        ensure
+          append_info_to_payload(payload)
+        end
+       end
+    end
+  end
+end

data/lib/restash_rails/rails_ext/active_support/cache/store.rb

@@ -0,0 +1,11 @@
+module ActiveSupport
+  module Cache
+    class Store
+      alias default_instrument instrument
+      def instrument(operation, key, options = nil)
+        self.class.instrument = true
+        default_instrument(operation, key, options, &Proc.new)
+      end
+    end
+  end
+end

data/lib/restash_rails/rails_ext/core_ext/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def deep_symbolize_keys
+    inject({}) { |result, (key, value)|
+      value = value.deep_symbolize_keys if value.is_a?(Hash)
+      result[(key.to_sym rescue key) || key] = value
+      result
+    }
+  end unless Hash.method_defined?(:deep_symbolize_keys)
+end

data/lib/restash_rails/rails_ext/rack/logger.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+require 'rails/rack/logger'
+
+module Rails
+  module Rack
+    # Overwrites defaults of Rails::Rack::Logger that cause
+    # unnecessary logging.
+    # This effectively removes the log lines from the log
+    # that say:
+    # Started GET / for 192.168.2.1...
+    class Logger
+      # Overwrites Rails 3.2 code that logs new requests
+      def call_app(*args)
+        env = args.last
+        @app.call(env)
+      ensure
+        ActiveSupport::LogSubscriber.flush_all!
+      end
+
+      # Overwrites Rails 3.0/3.1 code that logs new requests
+      def before_dispatch(_env)
+      end
+    end
+  end
+end

data/lib/restash_rails/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+
+module RestashRails
+  class Railtie < ::Rails::Railtie
+    config.restash_rails = ::ActiveSupport::OrderedOptions.new
+    config.restash_rails.enabled = false
+    initializer :restash, before: :initialize_logger do |app|
+      app.config.restash_rails = app.config.restash_rails.deep_symbolize_keys
+      app.config.logger = RestashRails.setup(app.config.restash_rails)
+    end
+  end
+end

data/lib/restash_rails/resque/failure/restash_logger.rb

@@ -0,0 +1,24 @@
+module Resque
+  module Failure
+    class RestashLogger < Resque::Failure::Base
+      def save
+        begin
+          message = {
+              exception: {
+                  class: exception.class,
+                  message: exception.message,
+                  backtrace: exception.backtrace
+              },
+              worker: worker.to_s,
+              queue: queue,
+              extra_data: payload,
+              log_tag: :resque_failure
+          }
+          ::Rails.logger.error(message)
+        rescue => e
+          puts "Failed to send rescue_failure log: #{e.message}\n#{e.backtrace}"
+        end
+      end
+    end
+  end
+end

data/lib/restash_rails/resque/logging.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Logging
+    def self.log(severity, message)
+      RestashRails.logger.send(severity, { resque_message: message, log_tag: :resque })
+    end
+  end
+end

data/lib/restash_rails/resque/plugins/restash_logger.rb

@@ -0,0 +1,38 @@
+module Resque
+  module Plugins
+    module RestashLogger
+      # Executed on the Resque worker
+      def before_perform_logstash_logger(*args)
+        @resque_job_uuid = SecureRandom.uuid
+        log 'Executing', args
+      end
+
+      def after_perform_logstash_logger(*args)
+        log 'Finished', args
+      end
+
+      def on_failure_logstash_logger(*args)
+        log 'Failed', args, :error
+      end
+
+      # Executed on the enqueueing instance
+      def after_enqueue_logstash_logger(*args)
+        log 'Enqueued', args
+      end
+
+      def after_schedule_send_monitor_data(*args)
+        log 'Scheduled', args
+      end
+
+      def log(status, args, severity = :info)
+        log_arguments = { status: status, extra_data: args, class: self.name, log_tag: :resque_hooks }
+        if args.is_a?(Array) && args[0].is_a?(Exception)
+          exception = args.shift
+          log_arguments[:exception] = { class: exception.class, message: exception.message, backtrace: exception.backtrace }
+        end
+        log_arguments[:resque_job_uuid] = @resque_job_uuid if @resque_job_uuid.present?
+        Rails.logger.send(severity, log_arguments)
+      end
+    end
+  end
+end

data/lib/restash_rails/version.rb

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

data/lib/restash_rails.rb

@@ -0,0 +1,53 @@
+require 'restash_rails/rails_ext/action_dispatch/middleware/debug_exceptions'
+require 'rack/utils'
+require 'restash_rails/version'
+require 'restash_rails/logger'
+require 'restash_rails/logs_unsubscriber'
+require 'restash_rails/log_subscriber/log_subscriber'
+require 'restash_rails/formatters/default'
+require 'restash_rails/railtie' if defined?(Rails::Railtie)
+require 'restash_rails/rails_ext/rack/logger'
+require 'restash_rails/rails_ext/core_ext/hash'
+
+module RestashRails
+  mattr_accessor :logger
+  extend RestashRails::LogSubscriber
+  extend RestashRails::LogsUnsubscriber
+
+  class << self
+    def setup(configs = {})
+      return unless configs.present? && configs.is_a?(Hash)
+      configs = configs.with_indifferent_access
+      return unless is_true?(configs[:enabled])
+      subscribe_logs(configs)
+      disable_additional_logs unless configs[:additional_log] == true
+      add_exception_statuses(configs[:exception_statuses] || [])
+      @@logger = RestashRails::Logger.new(configs)
+      @@logger
+    end
+
+    private
+
+    # exception_statuses has to be an array of hashes.
+    # Each hash has to contain status and types.
+    # Types is an array of Exception classes
+    # Example:
+    #     error_401 = {:status => 401, :types => [Exceptions::AccessDenied, Exceptions::MyException]}
+    #     error_422 = {:status => 422, :types => [Exceptions::InvalidParams]}
+    #     exception_statuses = [error_401, error_422]
+
+    def add_exception_statuses(exception_statuses = [])
+      return unless exception_statuses.is_a?(Array) || exception_statuses.size > 0
+      exception_statuses.each do |error|
+        next unless error.is_a?(Hash)
+        error = error.with_indifferent_access
+        next unless error[:status].present? || (error[:types].present? && error[:types].is_a?(Array))
+        status_symbol = ::Rack::Utils::HTTP_STATUS_CODES[error[:status].to_i].parameterize.underscore.to_sym
+        existing_exceptions = ::ActionDispatch::ExceptionWrapper.rescue_responses.keys
+        (error[:types].map(&:to_s) - existing_exceptions).each do |exceptions_class|
+          ::ActionDispatch::ExceptionWrapper.rescue_responses.merge!({ exceptions_class => status_symbol })
+        end
+      end
+    end
+  end
+end

data/restash_rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restash_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'restash_rails'
+  spec.version       = RestashRails::VERSION
+  spec.authors       = ['dmitri86git']
+  spec.email         = ['dmitri@yotpo.com']
+
+  spec.summary       = 'This gem sends your Rails application logs to logstash.'
+  spec.description   = 'Add configurations to application.config.restash_rails and  have fun.'
+  spec.homepage      = 'https://github.com/YotpoLtd/restash-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{ |f|  f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'rails'
+  spec.add_dependency 'tcp_timeout'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: restash_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dmitri86git
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rails
+  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: tcp_timeout
+  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'
+description: Add configurations to application.config.restash_rails and  have fun.
+email:
+- dmitri@yotpo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/restash_rails.rb
+- lib/restash_rails/formatters/default.rb
+- lib/restash_rails/log_subscriber/log_subscriber.rb
+- lib/restash_rails/log_subscriber/subscribers/action_mailer.rb
+- lib/restash_rails/log_subscriber/subscribers/action_view.rb
+- lib/restash_rails/log_subscriber/subscribers/active_record.rb
+- lib/restash_rails/log_subscriber/subscribers/active_support.rb
+- lib/restash_rails/log_subscriber/subscribers/cache.rb
+- lib/restash_rails/logger.rb
+- lib/restash_rails/logs_unsubscriber.rb
+- lib/restash_rails/rails_ext/action_dispatch/middleware/debug_exceptions.rb
+- lib/restash_rails/rails_ext/action_pack/action_controller/metal/instrumentation.rb
+- lib/restash_rails/rails_ext/active_support/cache/store.rb
+- lib/restash_rails/rails_ext/core_ext/hash.rb
+- lib/restash_rails/rails_ext/rack/logger.rb
+- lib/restash_rails/railtie.rb
+- lib/restash_rails/resque/failure/restash_logger.rb
+- lib/restash_rails/resque/logging.rb
+- lib/restash_rails/resque/plugins/restash_logger.rb
+- lib/restash_rails/version.rb
+- restash_rails.gemspec
+homepage: https://github.com/YotpoLtd/restash-rails
+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.12
+signing_key: 
+specification_version: 4
+summary: This gem sends your Rails application logs to logstash.
+test_files: []