sqlogger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fada0c387b433c3fb508705aeb367ce751e94a1
+  data.tar.gz: cbe9067586ae812c40021f17d9b3e19aa6ac6bcf
+SHA512:
+  metadata.gz: 0fca7bbbcfb231c69d9b982518b482be14a15efef924ca92ad423eda6ace636bb9d19d52dc54712d5a7efd1f2061df6e9209ca20adc3d75e9549e417c7c799d0
+  data.tar.gz: d72f581068251375945aa2f3fafdd0aef0ad7bb265a0f1c15100898fc42864602430911c8b0cf69551a63386a2b68ac8db29df3c6a50f32290cdccaf1d90b831

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 metalels
+
+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,33 @@
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](MIT-LICENSE)
+[![Build Status](https://travis-ci.org/metalels/sqlogger.svg?branch=master)](https://travis-ci.org/metalels/sqlogger)
+[![Code Climate](https://codeclimate.com/github/metalels/sqlogger/badges/gpa.svg)](https://codeclimate.com/github/metalels/sqlogger)
+[![Test Coverage](https://codeclimate.com/github/metalels/sqlogger/badges/coverage.svg)](https://codeclimate.com/github/metalels/sqlogger/coverage)
+[![Issue Count](https://codeclimate.com/github/metalels/sqlogger/badges/issue_count.svg)](https://codeclimate.com/github/metalels/sqlogger)
+
+# Sqlogger
+Collect 'ActiveRecord sql query' to monitoring system(s).
+
+<img src="sqlogger_elasticsearch.png" width="580" alt="send sql-log to elasticsearch">
+
+## Dependency
+Currently only supports Rails 5.1.0beta1 or more.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sqlogger', group: :development
+```
+
+And then execute in Rails Project root directory:
+```bash
+$ bundle
+$ rake sqlogger:install
+```
+
+## Usage
+edit sqlogger setting file in *config/initializers/sqlogger.rb*.
+
+## Contributing
+git-flow.
+

data/Rakefile

@@ -0,0 +1,28 @@
+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    = 'Sqlogger'
+  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 << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/sqlogger/base.rb

@@ -0,0 +1,32 @@
+module Sqlogger
+  module Base
+    def self.logger(opts={})
+      return unless opts[:sql]
+      opts[:name] ||= ""
+      opts[:sql] = format_sql opts[:sql]
+      opts[:binds] = format_sql opts[:binds].strip
+      sql_command = opts[:sql].split.first
+
+      ignore_payloads = Rails.application.config.sqlogger.ignore_payload_names
+      ignore_commands = Rails.application.config.sqlogger.ignore_sql_commands
+      post_targets = Rails.application.config.sqlogger.post_targets
+
+      return if ignore_payloads.include? opts[:name]
+      return if ignore_commands.include? sql_command
+      if post_targets.include?("elasticsearch") || post_targets.include?(:elasticsearch)
+        Thread.start do
+          Sqlogger::Elite::Elasticsearch.post opts
+        end
+      end
+      if post_targets.include?("echo") || post_targets.include?(:echo)
+        Thread.start do
+          Sqlogger::Elite::Echo::post opts
+        end
+      end
+    end
+
+    def self.format_sql(sql="")
+      sql.gsub(/(\s+|\n)/, " ")
+    end
+  end
+end

data/lib/sqlogger/elite/echo.rb

@@ -0,0 +1,32 @@
+module Sqlogger
+  module Elite
+    module Echo
+      require "open3"
+
+      def self.post(opts={})
+        return unless opts[:sql]
+        echo_file = Rails.application.config.sqlogger.echo.file
+        debug = Rails.application.config.sqlogger.echo.debug
+
+        info = opts.map do |k,v|
+          "#{k.to_s.upcase}: #{v}#{"ms" if k == :dulation}"
+        end
+        info.unshift "Time: #{Time.now}"
+        info.unshift "PID: #{Process.pid()}"
+        info.push "" << "-" * 10
+        echo_result = Open3.capture3 "echo \"#{info.join("\n")}\" >> #{echo_file}"
+        if debug
+          if echo_result.last.exitstatus == 0
+            Rails.logger.info "Echo ok."
+          else
+            Rails.logger.error "Echo fail."
+          end
+        end
+      rescue => ex
+        if debug
+          Rails.logger.error ex.message
+        end
+      end
+    end
+  end
+end

data/lib/sqlogger/elite/elasticsearch.rb

@@ -0,0 +1,90 @@
+module Sqlogger
+  module Elite
+    module Elasticsearch
+      require 'net/http'
+      require 'uri'
+
+      def self.post_data_base
+        {
+          "@timestamp" => DateTime.now.to_s,
+          "pid" => Process.pid()
+        }
+      end
+
+      def self.check_name
+        Rails.application.config.sqlogger.elasticsearch.check_name
+      end
+
+      def self.base_url
+        Rails.application.config.sqlogger.elasticsearch.url
+      end
+
+      def self.url
+        index_name = Rails.application.config.sqlogger.elasticsearch.index_name
+        "#{base_url}#{"/" unless base_url.end_with?('/')}#{index_name}/#{check_name}/"
+      end
+
+      def self.post(opts={})
+        return unless opts[:sql]
+        sql_action = opts[:sql].split.first
+        hostname = `hostname`.strip
+        hostname = "CANTGET" if hostname.empty?
+        key = "#{hostname}.queries.#{sql_action}"
+        post_data = self.post_data_base
+        send_keys = Rails.application.config.sqlogger.elasticsearch.post_keys
+        dulation = opts[:dulation] || 0.00
+
+        send_keys.push "check_name"
+        send_keys.push "key"
+        send_keys.push "@timestamp"
+        crit_dul = Rails.application.config.sqlogger.elasticsearch.critical_dulation
+        warn_dul = Rails.application.config.sqlogger.elasticsearch.warning_dulation
+        http_ssl_none_verify = Rails.application.config.sqlogger.elasticsearch.ssl_verify_none
+        post_timeout = Rails.application.config.sqlogger.elasticsearch.post_timeout
+        http_open_timeout = Rails.application.config.sqlogger.elasticsearch.open_timeout
+        http_read_timeout = Rails.application.config.sqlogger.elasticsearch.read_timeout
+        debug = Rails.application.config.sqlogger.elasticsearch.debug
+
+        post_data['server'] = hostname
+        post_data['check_name'] = check_name
+        post_data['status'] = dulation > crit_dul ? 2 : dulation > warn_dul ? 1 : 0
+        post_data['key'] = key
+        post_data['sql'] = opts[:sql]
+        post_data['binds'] = opts[:binds]
+        post_data['dulation'] = dulation
+        post_data['payload'] = opts[:name]
+
+        post_data.reject! do |k, _|
+          !send_keys.include? k
+        end
+
+        Timeout.timeout(post_timeout) do
+          random_hash = Digest::MD5.hexdigest("#{key}#{Time.now.to_i}#{rand(999)}")
+          uri = URI.parse "#{url}#{random_hash}"
+          http = Net::HTTP.new uri.host, uri.port
+          http.use_ssl = true if base_url =~ /\Ahttps/
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http_ssl_none_verify
+          http.open_timeout = http_open_timeout
+          http.read_timeout = http_read_timeout
+
+          request = Net::HTTP::Post.new(
+            uri.path,
+            "content-type" => "application/json; charset=utf-8"
+          )
+          request.body = JSON.dump post_data
+          response = http.request request
+          if debug
+            Rails.logger.info "Elasticsearch posted #{response.code}."
+          end
+          if response.code.to_i/10 != 20
+            Rails.logger.error "Elasticsearch posting with failure #{response.code}."
+          end
+        end
+      rescue => ex
+        if debug
+          Rails.logger.error ex.message
+        end
+      end
+    end
+  end
+end

data/lib/sqlogger/elite.rb

@@ -0,0 +1,2 @@
+require "sqlogger/elite/elasticsearch"
+require "sqlogger/elite/echo"

data/lib/sqlogger/monkey/active_record/replace_log_subscriber.rb

@@ -0,0 +1,33 @@
+module Sqlogger
+  module Monkey
+    module ActiveRecord
+      module ReplaceLogSubscriber
+        def self.included(base)
+          base.class_eval do
+            alias_method :sql_without_sqlogger, :sql
+            alias_method :sql, :sql_with_sqlogger
+          end
+        end
+
+        def sql_with_sqlogger(event)
+          sql_without_sqlogger(event);
+
+          payload = event.payload
+          binds   = nil
+          unless (payload[:binds] || []).empty? && payload[:type_casted_binds].present?
+            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
+          Sqlogger::Base::logger(
+            sql: payload[:sql],
+            binds: binds,
+            dulation: event.duration.round(1),
+            name: "#{"CACHE " if payload[:cached]}#{payload[:name]}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sqlogger/railtie.rb

@@ -0,0 +1,40 @@
+require 'rails'
+
+module Sqlogger
+  class Railtie < Rails::Railtie
+    initializer "sqlogger_railtie.configure_rails_initialization" do
+      ActiveSupport.on_load :active_record do
+        require 'sqlogger/monkey/active_record/replace_log_subscriber'
+        ActiveRecord::LogSubscriber.send :include, Sqlogger::Monkey::ActiveRecord::ReplaceLogSubscriber
+      end
+    end
+
+    config.sqlogger = ActiveSupport::OrderedOptions.new
+    config.sqlogger.elasticsearch = ActiveSupport::OrderedOptions.new
+    config.sqlogger.echo = ActiveSupport::OrderedOptions.new
+
+    #define default values
+    config.sqlogger.ignore_payload_names = %w(SCHEMA EXPLAIN)
+    config.sqlogger.ignore_sql_commands = []
+    config.sqlogger.post_targets = []
+
+    config.sqlogger.elasticsearch.check_name = "metrics-query"
+    config.sqlogger.elasticsearch.url = "http://localhost:9200/"
+    config.sqlogger.elasticsearch.index_name = "sqlogger-metrics"
+    config.sqlogger.elasticsearch.post_keys = %w(server status pid sql binds dulation payload)
+    config.sqlogger.elasticsearch.critical_dulation = 10.0
+    config.sqlogger.elasticsearch.warning_dulation = 5.0
+    config.sqlogger.elasticsearch.ssl_verify_none = false
+    config.sqlogger.elasticsearch.post_timeout = 1.0
+    config.sqlogger.elasticsearch.open_timeout = 1.0
+    config.sqlogger.elasticsearch.read_timeout = 1.0
+    config.sqlogger.elasticsearch.debug = false
+
+    config.sqlogger.echo.file = "log/sqlogger.log"
+    config.sqlogger.echo.debug = false
+
+    rake_tasks do
+      load "tasks/sqlogger_tasks.rake"
+    end
+  end
+end

data/lib/sqlogger/version.rb

@@ -0,0 +1,3 @@
+module Sqlogger
+  VERSION = '0.1.0'
+end

data/lib/sqlogger.rb

@@ -0,0 +1,4 @@
+require "sqlogger/version"
+require "sqlogger/base"
+require "sqlogger/elite"
+require "sqlogger/railtie" if defined?(Rails)

data/lib/tasks/sqlogger_tasks.rake

@@ -0,0 +1,49 @@
+# desc "Explaining what the task does"
+
+task :sqlogger => "sqlogger:install"
+namespace :sqlogger do
+  desc "install sqlogger to a rails project."
+  task :install do
+    conf_path = Rails.root.join("config").join("initializers").join("sqlogger.rb")
+    if File.exist? conf_path
+      puts "Sqlogger has already installed."
+      puts "For more details, see your config/initializers/sqlogger.rb file."
+    else
+      conf_default_body = <<-EOS
+## ignore_payload_names
+##   set to not logging selected payloads.
+#Rails.application.config.sqlogger.ignore_payload_names = %w(SCHEMA EXPLAIN)
+
+## ignore_sql_commands
+##   set to not logging selected payloads.
+#Rails.application.config.sqlogger.ignore_sql_commands = %w()
+
+## post_targets: set to logging target. e.g. %w(elasticsearch echo)
+##   (current only support echo and elasticsearch)
+#Rails.application.config.sqlogger.post_targets = %w()
+
+## elasticsearch options
+##   only uses set to logging to elasticsearch on post_targets.
+#Rails.application.config.sqlogger.elasticsearch.url = "http://localhost:9200/"
+#Rails.application.config.sqlogger.elasticsearch.index_name = "sqlogger-metrics"
+#Rails.application.config.sqlogger.elasticsearch.check_name = "metrics-query"
+#Rails.application.config.sqlogger.elasticsearch.post_keys = %w(server status pid sql binds dulation payload)
+#Rails.application.config.sqlogger.elasticsearch.critical_dulation = 10.0
+#Rails.application.config.sqlogger.elasticsearch.warning_dulation = 5.0
+#Rails.application.config.sqlogger.elasticsearch.ssl_verify_none = false
+#Rails.application.config.sqlogger.elasticsearch.post_timeout = 1.0
+#Rails.application.config.sqlogger.elasticsearch.open_timeout = 1.0
+#Rails.application.config.sqlogger.elasticsearch.read_timeout = 1.0
+#Rails.application.config.sqlogger.elasticsearch.debug = false
+
+## echo options (sysmem echo to file)
+##   only uses set to logging to echo on post_targets.
+#Rails.application.config.sqlogger.echo.file = "log/sqlogger.log"
+#Rails.application.config.sqlogger.echo.debug = false
+      EOS
+      File.write(conf_path, conf_default_body)
+      puts "Sqlogger has been successfully installed."
+      puts "For more details, see your config/initializers/sqlogger.rb file."
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sqlogger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- metalels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta.pre.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta.pre.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: mocha
+  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: 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'
+description: Collect 'ActiveRecord sql query' to monitoring system(s).
+email:
+- metalels86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sqlogger.rb
+- lib/sqlogger/base.rb
+- lib/sqlogger/elite.rb
+- lib/sqlogger/elite/echo.rb
+- lib/sqlogger/elite/elasticsearch.rb
+- lib/sqlogger/monkey/active_record/replace_log_subscriber.rb
+- lib/sqlogger/railtie.rb
+- lib/sqlogger/version.rb
+- lib/tasks/sqlogger_tasks.rake
+homepage: https://github.com/metalels/rails-sqlogger
+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.8
+signing_key: 
+specification_version: 4
+summary: Collect 'ActiveRecord sql query' to monitoring system(s).
+test_files: []