sql_tracer 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acf837bfa2f4bb0a5e196c34258a2de751378ee3
-  data.tar.gz: e754d000c10381bc922c8a9078f1a945245ecbbb
+  metadata.gz: 98ce5725d8ff7895f2d497d33d9d56368e6074bb
+  data.tar.gz: 1cc0510f0278227e89a946e1f6bb760c4935bc91
 SHA512:
-  metadata.gz: 44d53258badb4e51bf26b1fe5a19e1bd434a40647cd50a7f021ef8d91ddae750a251d5609d9fef2ff796a7cefed55b97e3df446257a1913fb68148e85035574e
-  data.tar.gz: fa0b7b0a39a3d0ed1ad5b41e01fe76711e6aeba770581463a1ec6a20026e4ba927ca70042649340d965b5b0f18c4f96ba6cbc2356ede7783eed2f5724c5ee76a
+  metadata.gz: a13325d7bcbe611d574b58459ee606e6ea8e34b541975cfaa80706e2d51f787c3f0ac116f315f716b7759022e31f1d7a8000ecbeb829b83dc4f58c8f2fa9ef64
+  data.tar.gz: a944447d1bb4e19965ce4ae1359aea5e02ae7c6e1c012b155bd3fa5160b7985e9f755447bebf5da7aee0138b60c77d19bc7959f50b06d3b3453c61ad7667cdac

data/app/assets/stylesheets/sql_tracer/style.css

@@ -16,10 +16,6 @@ h3 {
     font-weight: 300;
 }
 
-/*.container {*/
-/*max-width: 970px;*/
-/*}*/
-
 div[class*='col-'] {
     padding: 0 30px;
 }
@@ -72,6 +68,14 @@ a:active {
     padding: 0;
 }
 
+.panel-heading:hover {
+    background-color: #185751;
+}
+
+.sql_template:hover {
+    background-color: #008e80;
+}
+
 .panel-title a {
     display: block;
     color: #fff;
@@ -124,29 +128,6 @@ a:active {
     transform: scale(0);
 }
 
-/*.panel-heading a:after {*/
-/*content: ' ';*/
-/*font-size: 24px;*/
-/*position: absolute;*/
-/*font-family: 'Material Icons';*/
-/*right: 5px;*/
-/*top: 10px;*/
-/*-webkit-transform: scale(0);*/
-/*transform: scale(0);*/
-/*-webkit-transition: all 0.5s;*/
-/*transition: all 0.5s;*/
-/*}*/
-
-/*.panel-heading.active a:after {*/
-/*content: '\e909';*/
-/*-webkit-transform: scale(1);*/
-/*transform: scale(1);*/
-/*-webkit-transition: all 0.5s;*/
-/*transition: all 0.5s;*/
-/*}*/
-
-/* #accordion rotate icon option */
-
 .panel-heading a:before {
     content: '\e316';
     font-size: 24px;

data/app/views/sql_tracer/sql_tracer/index.html.erb

@@ -55,7 +55,6 @@
       </h4>
     </div>
   </div>
-
   <div id="sql_template" class="panel-heading sql_template">
     <h4 class="panel-title">
       <a data-toggle="collapse" data-parent="#" href="#one-2" class="sql">

data/lib/sql_tracer.rb

@@ -1,11 +1,12 @@
 require 'sql_tracer/engine'
 
 module SqlTracer
+  autoload :RequestLogger, 'sql_tracer/request_logger'
   autoload :SqlLogger, 'sql_tracer/sql_logger'
+  autoload :SqlStack, 'sql_tracer/sql_stack'
   autoload :Helper, 'sql_tracer/helper'
   autoload :Formatter, 'sql_tracer/formatter'
-  autoload :RequestLogger, 'sql_tracer/request_logger'
-  autoload :SqlStack, 'sql_tracer/sql_stack'
+  autoload :Config, 'sql_tracer/config'
 end
 
 # why does not work when wrapped in block ActiveSupport.on_load(:active_record) do

data/lib/sql_tracer/config.rb

@@ -0,0 +1,19 @@
+module SqlTracer
+  module Config
+
+    def self.get(name)
+      @config ||= load_config
+      @config ? @config[name.to_s] : nil
+    end
+
+    private
+
+    def self.load_config
+      default_config_file = File.join(Rails.root, 'config', 'sql_tracer.yml')
+      ui_config_file = File.join(Rails.root, 'config', 'ui_config.yml')
+
+      config_file = [default_config_file, ui_config_file].find { |file| File.exist?(file) }
+      YAML.load_file(config_file) if config_file
+    end
+  end
+end

data/lib/sql_tracer/formatter.rb

@@ -4,13 +4,6 @@ module SqlTracer
   class Formatter
     HEADER_PROMPT= '='*10 << '>'
     FOOTER_PROMPT= '<' << '='*10
-    FORMATTER_CONFIG_TIP =
-      <<-TIP
-You can add config to ui_config.yml to acquire advanced features
-  SQL_TRACER_FORMAT_SQL_ENABLED: true      # show formatted and colored sql, default false
-  SQL_TRACER_FORMAT_STACK_ENABLED: true    # show colored stack, default fasle
-  SQL_TRACER_SKIP_LIB: false               # show all paths including the files in ruby gems, default true
-    TIP
 
     def self.start_print
       puts HEADER_PROMPT
@@ -22,7 +15,7 @@ You can add config to ui_config.yml to acquire advanced features
 
     def self.print_tips
       puts 'SqlTracer is watching and will capture backtrace when sql is executed.'
-      # puts FORMATTER_CONFIG_TIP
+      puts 'open http://127.0.0.1:3000/sql_tracer/index for detailed information'
     end
 
     def self.print_sql(sql)
@@ -47,9 +40,9 @@ You can add config to ui_config.yml to acquire advanced features
       Formatter.end_print
     end
 
-    def self.remove_lib_path(backtrace)
+    def self.remove_filtered_path(backtrace)
       backtrace.map do |path|
-        next if Helper.should_skip_lib? && path.include?('/.rvm/gems/')
+        next if Helper.shoule_skip_path_by_keywords?(path)
         path
       end.compact
     end

data/lib/sql_tracer/helper.rb

@@ -2,33 +2,60 @@ require 'anbt-sql-formatter/formatter'
 
 module SqlTracer
   class Helper
+
     class << self
       def format_sql_enabled?
-        @format_sql_enabled ||= (UIConfig.get(:SQL_TRACER_FORMAT_SQL_ENABLED) || false)
+        @format_sql_enabled ||= (config.get(:SQL_TRACER_FORMAT_SQL_ENABLED) || false)
       end
 
       def format_stack_enabled?
-        @format_stack_enabled ||= (UIConfig.get(:SQL_TRACER_FORMAT_STACK_ENABLED) || false)
+        @format_stack_enabled ||= (config.get(:SQL_TRACER_FORMAT_STACK_ENABLED) || false)
+      end
+
+      def output_select_sql_enabled?
+        @output_select_sql_enabled ||= (config.get(:SQL_TRACER_OUTPUT_SELECT_SQL_ENABLED) || false)
       end
 
       def should_skip_lib?
-        @should_skip_lib ||= (UIConfig.get(:SQL_TRACER_SKIP_LIB) == false ? false : true)
+        @should_skip_lib ||= (config.get(:SQL_TRACER_SKIP_LIB_PATH) == false ? false : true)
       end
 
       def should_skip_sql_by_keywords?(sql)
-        @sql_keywords ||= (UIConfig.get(:SQL_TRACER_SQL_FILTER) || [])
-        return false if @sql_keywords.blank?
+        @sql_keywords ||= (config.get(:SQL_TRACER_SQL_FILTER) || [])
         @sql_keywords.any? { |keyword| sql.include?(keyword) }
       end
 
       def should_skip_url_by_keywords?(url)
-        @url_keywords ||= (UIConfig.get(:SQL_TRACER_URL_FILTER) || [])
-        return false if @url_keywords.blank?
+        @url_keywords ||= (config.get(:SQL_TRACER_URL_FILTER) || [])
         @url_keywords.any? { |keyword| url.include?(keyword) }
       end
 
+      def shoule_skip_path_by_keywords?(path)
+        @path_keywords ||= build_path_filter
+        @path_keywords.any? { |keyword| path.include?(keyword) }
+      end
+
       def disable_console_output?
-        @console_output_disabled ||= (UIConfig.get(:SQL_TRACER_CONSOLE_OUTPUT_DISABLED) || false)
+        @console_output_disabled ||= (config.get(:SQL_TRACER_CONSOLE_OUTPUT_DISABLED) || false)
+      end
+
+      def should_output_sql?(sql)
+        reg = 'insert|update|delete'
+        reg << '|select' if Helper.output_select_sql_enabled?
+        return sql =~ /^\s*(#{reg})\s/i && !Helper.should_skip_sql_by_keywords?(sql)
+      end
+
+
+      private
+
+      def build_path_filter
+        path_filter = (config.get(:SQL_TRACER_PATH_FILTER) || [])
+        path_filter << '/.rvm/gems/' if Helper.should_skip_lib?
+        path_filter.uniq
+      end
+
+      def config
+        SqlTracer::Config
       end
     end
   end

data/lib/sql_tracer/request_logger.rb

@@ -5,11 +5,15 @@ module SqlTracer
       after_filter :persist_reqeust_logger
 
       def persist_reqeust_logger
-        if SqlTracer::Helper.should_skip_url_by_keywords?(request.path)
-          SqlTracer::SqlStack.abandon_request
-        else
-          SqlTracer::SqlStack.url = "#{request.method} #{request.path}"
-          SqlTracer::SqlStack.push
+        begin
+          if SqlTracer::Helper.should_skip_url_by_keywords?(request.path)
+            SqlTracer::SqlStack.abandon_request
+          else
+            SqlTracer::SqlStack.push("#{request.method} #{request.path}")
+          end
+        rescue => e
+          Rails.logger.error "Failed to log sql in SqlTracer. Error: #{e.message}"
+          Rails.logger.error e.backtrace.join("\n")
         end
       end
     end

data/lib/sql_tracer/sql_logger.rb

@@ -10,9 +10,9 @@ module SqlTracer
         begin
           sql = args.first
 
-          if sql =~ /^\s*(insert|update|delete)\s/i && !Helper.should_skip_sql_by_keywords?(sql)
+          if Helper.should_output_sql?(sql)
             backtrace = Thread.current.backtrace
-            backtrace = Formatter.remove_lib_path(backtrace) if Helper.should_skip_lib?
+            backtrace = Formatter.remove_filtered_path(backtrace)
             Formatter.print_all(sql, backtrace) unless Helper.disable_console_output?
             SqlTracer::SqlStack.sql_stack << { :sql => sql, :stack => backtrace }
           end

data/lib/sql_tracer/sql_stack.rb

@@ -1,22 +1,18 @@
-require 'fileutils'
-
 module SqlTracer
   class SqlStack
-    @url = ''
-    @sql_stack = []
-    @sql_stacks = []
+    @sql_stack = [] # used to store current request information
+    @sql_stacks = [] # used to store all requests before taken by SqlTracerController#get_latest_stack_info
 
     class << self
-      attr_accessor :url, :sql_stack, :sql_stacks
+      attr_accessor :sql_stack, :sql_stacks
 
       def clear
         @sql_stacks = []
       end
 
-      def push
-        @sql_stacks << { :url => "[#{Time.now.strftime('%H:%M:%S')}] #{@url}", :sqls => @sql_stack }
+      def push(url)
+        @sql_stacks << { :url => "[#{Time.now.strftime('%H:%M:%S')}] #{url}", :sqls => @sql_stack }
         @sql_stack = []
-        @url = ''
       end
 
       def to_json
@@ -25,7 +21,6 @@ module SqlTracer
 
       def abandon_request
         @sql_stack = []
-        @url = ''
       end
     end
   end

data/lib/sql_tracer/version.rb

@@ -1,3 +1,3 @@
 module SqlTracer
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - qzhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anbt-sql-formatter
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sql_tracer/config.rb
 - lib/sql_tracer/engine.rb
 - lib/sql_tracer/formatter.rb
 - lib/sql_tracer/helper.rb