sql_tracer 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554687b0e5ff1f0aeabbffa232513722309d2b5c
-  data.tar.gz: 4e1b7e5d40d3e4462bdb70087620b5501feff05b
+  metadata.gz: 982974c81f2a39e7c1cb812423788ed733434750
+  data.tar.gz: 14a302d2095e86805fb12e6f164f553293c89ed5
 SHA512:
-  metadata.gz: a3363dd4e9e43ee0369036b2b4938b82eba73a18fffb88104375008c110c63a16a797eb5fda2b8d37d05ab1d13bd002bcb669bcf071a33c1780ad19b3a2efe21
-  data.tar.gz: d961a3be4e1842306e17eb9c48dc1e706bde60a3f339586da03a5feb9fc9374f6b3e8591634ff28dd04c87209973d207306faab702a3c94aa57308f193c58f86
+  metadata.gz: b72ef9736956a00c8561dc64246079bcf79805ef32a24ccd4f4e0efc7baa3244d8293ad69fd24c312ca74885deb83705a00a5f81fd655db9d71b3a4791b6b72d
+  data.tar.gz: bfa565ccb801c5fa052277ec22f8ddfd2eb3c42fa74542a1a1ffe9620178b030508d4a6d2595743e7350a78e059bb59105ab7ebfbf14a1aaa95dcea9fb60703a

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

@@ -0,0 +1,5 @@
+/*
+    ...ommitted code...
+    *= require_self
+    *= require_tree .
+*/

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

@@ -0,0 +1,191 @@
+body {
+    margin: 0;
+    font-family: 'Roboto';
+    font-size: 14px;
+    background: #ffffff;
+}
+
+h3 {
+    color: #fff;
+    font-size: 24px;
+    text-align: center;
+    margin-top: 30px;
+    padding-bottom: 30px;
+    border-bottom: 1px solid #eee;
+    margin-bottom: 30px;
+    font-weight: 300;
+}
+
+/*.container {*/
+/*max-width: 970px;*/
+/*}*/
+
+div[class*='col-'] {
+    padding: 0 30px;
+}
+
+.wrap {
+    box-shadow: 0px 2px 2px 0px rgba(0, 0, 0, 0.14), 0px 3px 1px -2px rgba(0, 0, 0, 0.2), 0px 1px 5px 0px rgba(0, 0, 0, 0.12);
+    border-radius: 4px;
+}
+
+a:focus,
+a:hover,
+a:active {
+    outline: 0;
+    text-decoration: none;
+}
+
+.container {
+    width: 90%;
+}
+.panel {
+    border-width: 0 0 1px 0;
+    border-style: solid;
+    border-color: #fff;
+    background: none;
+    box-shadow: none;
+}
+
+.panel:last-child {
+    border-bottom: none;
+}
+
+.panel-group > .panel:first-child .panel-heading {
+    border-radius: 4px 4px 0 0;
+}
+
+.panel-group .panel {
+    border-radius: 0;
+}
+
+.panel-group .panel + .panel {
+    margin-top: 0;
+}
+
+.panel-heading {
+    background-color: #18504a;
+    border-radius: 0;
+    border: none;
+    color: #fff;
+    padding: 0;
+}
+
+.panel-title a {
+    display: block;
+    color: #fff;
+    padding: 15px;
+    position: relative;
+    font-size: 16px;
+    font-weight: 400;
+}
+
+.panel-body {
+    background: rgba(153,153,153,0.29);
+}
+
+.panel:last-child .panel-body {
+    border-radius: 0 0 4px 4px;
+}
+
+.panel:last-child .panel-heading {
+    border-radius: 0 0 4px 4px;
+    -webkit-transition: border-radius 0.3s linear 0.2s;
+    transition: border-radius 0.3s linear 0.2s;
+}
+
+.panel:last-child .panel-heading.active {
+    border-radius: 0;
+    -webkit-transition: border-radius linear 0s;
+    transition: border-radius linear 0s;
+}
+
+/* #bs-collapse icon scale option */
+
+.panel-heading a:before {
+    content: '\e146';
+    position: absolute;
+    font-family: 'Material Icons';
+    right: 5px;
+    top: 10px;
+    font-size: 24px;
+    -webkit-transition: all 0.5s;
+    transition: all 0.5s;
+    -webkit-transform: scale(1);
+    transform: scale(1);
+}
+
+.panel-heading.active a:before {
+    content: ' ';
+    -webkit-transition: all 0.5s;
+    transition: all 0.5s;
+    -webkit-transform: scale(0);
+    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;
+    position: absolute;
+    font-family: 'Material Icons';
+    right: 5px;
+    top: 10px;
+    -webkit-transform: rotate(180deg);
+    transform: rotate(180deg);
+    -webkit-transition: all 0.5s;
+    transition: all 0.5s;
+}
+
+.panel-heading.active a:before {
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+    -webkit-transition: all 0.5s;
+    transition: all 0.5s;
+}
+
+.sql_template {
+    padding-left: 20px;
+    background-color: #009688;
+    line-break: auto;
+    word-break: break-all;
+}
+
+.stack_info {
+    word-break: break-all;
+    /*padding-left: 40px;*/
+}
+
+.stack_info div {
+    padding-left: 50px;
+    /*padding-left: 40px;*/
+}
+
+#url_template,
+#sqls_template,
+#sql_template,
+#stack_info {
+    display: none;
+}

data/app/controllers/sql_tracer/sql_tracer_controller.rb

@@ -0,0 +1,15 @@
+module SqlTracer
+  class SqlTracerController < ActionController::Base
+    skip_filter :build_navigations
+    skip_after_filter :persist_reqeust_logger
+
+    def index
+    end
+
+    def get_latest_stack_info
+      ret = SqlTracer::SqlStack.to_json
+      SqlTracer::SqlStack.clear
+      render :json => ret
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+<!doctype html>
+<html lang="zh">
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Sql Tracer</title>
+  <link href='https://fonts.googleapis.com/css?family=Roboto:300,400,500,700' rel='stylesheet' type='text/css'>
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+  <link rel="stylesheet" type="text/css" href="http://www.jq22.com/jquery/bootstrap-3.3.4.css">
+  <%= stylesheet_link_tag 'sql_tracer/application' %>
+</head>
+<body>
+
+<section class="jq22-container">
+  <div class="container">
+
+    <div class="row-fluid">
+      <div class="span12">
+        <div class="hero-unit">
+          <h1>
+            Sql Tracer
+          </h1>
+          <p>
+            It helps you figure out what sqls are executed and trace method call stack, you can take a look at
+            <a class="btn btn-primary btn-xs" target="_blank" href="https://git.dev.fwmrm.net/qzhang/sql_tracer"> READ
+              ME</a>
+            to acquire more information.
+          </p>
+          <p>
+            If you have any questions or improvement, please open a issue.
+            <a class="btn btn-primary btn-xs" target="_blank" href="https://git.dev.fwmrm.net/qzhang/sql_tracer/issues/new">
+              New Issue
+            </a>
+          </p>
+        </div>
+      </div>
+    </div>
+    <!-- end of #bs-collapse  -->
+  </div>
+
+
+  <div id="url_template" class="url_template">
+    <div class="panel-heading">
+      <h4 class="panel-title">
+        <a data-toggle="collapse" data-parent="#" href="#one">
+        </a>
+      </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">
+      </a>
+    </h4>
+  </div>
+  <div id="stack_info" class="panel-collapse collapse stack_info" style="display: none">
+    <div class="panel-body ruby">
+    </div>
+  </div>
+
+  <div id="sqls_template" style="display: none"></div>
+  <!-- end of container -->
+</section>
+
+<script src="http://www.jq22.com/jquery/jquery-1.10.2.js"></script>
+<script src="http://www.jq22.com/jquery/bootstrap-3.3.4.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() {
+    refresh();
+  });
+
+  function refresh() {
+    $.ajax({
+      url: "/sql_tracer/get_latest_stack_info",
+      success: function(result, status) {
+        if (result) {
+          $.each(result, function(index, requestInfo) {
+            appendRequestInfo(requestInfo);
+          });
+        }
+      },
+      complete: function() {
+        setTimeout("refresh()", 3000)
+      }
+    });
+  }
+
+  function appendRequestInfo(requestInfo) {
+    var url = requestInfo.url;
+    var sqls = requestInfo.sqls || [];
+    var $url_template = $("#url_template").clone();
+    $url_template.attr("id", "");
+    $url_template.find("a").attr("href", "#");
+    $url_template.find("a").html(url);
+    $url_template.css("display", "block");
+
+    var $sqls_template = $("#sqls_template").clone();
+    $sqls_template.attr("id", "");
+
+    if (sqls && sqls.length > 0) {
+      $.each(sqls, function(index, sql_info) {
+        var $stack_info = $("#stack_info").clone();
+        $stack_info.attr("id", "");
+        $stack_info.find("div").html(sql_info.stack.join("<br\/>"));
+
+        var $sql_template = $("#sql_template").clone();
+        $sql_template.attr("id", "");
+        $sql_template.find("a").attr("href", "#");
+        $sql_template.find("a").html(sql_info.sql);
+        $sql_template.find("a").click(function() {
+          if ($stack_info.is(":visible")) {
+            $sql_template.removeClass('active');
+          } else {
+            $sql_template.addClass('active');
+          }
+          $stack_info.slideToggle();
+        });
+        $sqls_template.append($sql_template);
+        $sqls_template.append($stack_info);
+      });
+    } else {
+      $sqls_template.html('No effective sqls are detected.')
+    }
+
+    $url_template.find("a").click(function() {
+      if ($sqls_template.is(":visible")) {
+        $url_template.find(".panel-heading:first").removeClass('active');
+      } else {
+        $url_template.find(".panel-heading:first").addClass('active');
+      }
+      $sqls_template.slideToggle();
+    });
+    $url_template.append($sqls_template);
+    $(".container").append($url_template);
+  }
+
+</script>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  get '/sql_tracer/index' => 'sql_tracer/sql_tracer#index'
+  get '/sql_tracer/get_latest_stack_info' => 'sql_tracer/sql_tracer#get_latest_stack_info'
+end

data/lib/sql_tracer/engine.rb

@@ -0,0 +1,4 @@
+module SqlTracer
+  class Engine < Rails::Engine
+  end
+end

data/lib/sql_tracer/formatter.rb

@@ -0,0 +1,80 @@
+require 'anbt-sql-formatter/formatter'
+
+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
+    end
+
+    def self.end_print
+      puts FOOTER_PROMPT
+    end
+
+    def self.print_tips
+      puts 'SqlTracer is watching and will capture backtrace when sql is executed.'
+      puts FORMATTER_CONFIG_TIP
+    end
+
+    def self.print_sql(sql)
+      puts 'SQL:'
+      return sql if sql.blank?
+      formatted_sql = '  ' << (Helper.format_sql_enabled? ? colorize(sql_formatter.format(sql.squeeze(' ')), 32) : sql)
+      puts formatted_sql
+    end
+
+    def self.print_backtrace(backtrace)
+      puts Helper.should_skip_lib? ? 'Backtrace: note that paths in ruby libs have been hidden' : 'Backtrace:'
+      backtrace.each do |line|
+        line = format_line(line) if Helper.format_stack_enabled?
+        (puts '  ' << line) if line.present?
+      end
+    end
+
+    def self.print_all(sql, backtrace)
+      Formatter.start_print
+      Formatter.print_sql(sql)
+      Formatter.print_backtrace(backtrace)
+      Formatter.end_print
+    end
+
+    def self.remove_lib_path(backtrace)
+      backtrace.map do |path|
+        next if Helper.should_skip_lib? && path.include?('/.rvm/gems/')
+        path
+      end.compact
+    end
+
+    def self.sql_formatter
+      return @formatter if @formatter
+      rule = AnbtSql::Rule.new
+      rule.keyword = AnbtSql::Rule::KEYWORD_UPPER_CASE
+      rule.function_names += %w(count sum)
+      rule.indent_string = '  '
+      @formatter = AnbtSql::Formatter.new(rule)
+    end
+
+    def self.format_line(line)
+      parts = line.match(/^(?<file>.+):(?<line>\d+):in `(?<code>.*)'$/)
+      if parts
+        "#{colorize(parts[:file], 32)}:#{colorize(parts[:line], 36)}:#{colorize(parts[:code], 31)}"
+      else
+        "#{colorize(line, 32)}"
+      end
+    end
+
+    def self.colorize(text, color_code)
+      "\e[#{color_code}m#{text}\e[0m"
+    end
+
+  end
+end

data/lib/sql_tracer/helper.rb

@@ -0,0 +1,29 @@
+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)
+      end
+
+      def format_stack_enabled?
+        @format_stack_enabled ||= (UIConfig.get(:SQL_TRACER_FORMAT_STACK_ENABLED) || false)
+      end
+
+      def should_skip_lib?
+        @should_skip_lib ||= (UIConfig.get(:SQL_TRACER_SKIP_LIB) || true)
+      end
+
+      def should_skip_by_keywords?(sql)
+        @keywords ||= (UIConfig.get(:SQL_TRACER_SQL_FILTER) || [])
+        return false if @keywords.blank?
+        @keywords.any? { |keyword| sql.include?(keyword) }
+      end
+
+      def disable_console_output?
+        @console_output_disabled ||= (UIConfig.get(:SQL_TRACER_CONSOLE_OUTPUT_DISABLED) || false)
+      end
+    end
+  end
+end

data/lib/sql_tracer/request_logger.rb

@@ -0,0 +1,13 @@
+module SqlTracer
+  module RequestLogger
+    extend ActiveSupport::Concern
+    included do
+      after_filter :persist_reqeust_logger
+
+      def persist_reqeust_logger
+        SqlTracer::SqlStack.url = "#{request.method} #{request.path}"
+        SqlTracer::SqlStack.push
+      end
+    end
+  end
+end

data/lib/sql_tracer/sql_logger.rb

@@ -0,0 +1,27 @@
+require 'anbt-sql-formatter/formatter'
+
+module SqlTracer
+  module SqlLogger
+    extend ActiveSupport::Concern
+    included do
+      alias_method :execute_without_sql_tracer, :execute
+
+      def execute(*args)
+        begin
+          sql = args.first
+
+          if sql =~ /^\s*(insert|update|delete)\s/i && !Helper.should_skip_by_keywords?(sql)
+            backtrace = Thread.current.backtrace
+            backtrace = Formatter.remove_lib_path(backtrace) if Helper.should_skip_lib?
+            Formatter.print_all(sql, backtrace) unless Helper.disable_console_output?
+            SqlTracer::SqlStack.sql_stack << { :sql => sql, :stack => backtrace }
+          end
+        rescue => e
+          Rails.logger.error "Failed to log sql in SqlTracer. Error: #{e.message}"
+          Rails.logger.error e.backtrace.join("\n")
+        end
+        execute_without_sql_tracer(*args)
+      end
+    end
+  end
+end

data/lib/sql_tracer/sql_stack.rb

@@ -0,0 +1,28 @@
+require 'fileutils'
+
+module SqlTracer
+  class SqlStack
+    @url = ''
+    @sql_stack = []
+    @sql_stacks = []
+
+    class << self
+      attr_accessor :url, :sql_stack, :sql_stacks
+
+      def clear
+        @sql_stacks = []
+      end
+
+      def push
+        @sql_stacks << { :url => "[#{Time.now.strftime('%H:%M:%S')}] #{@url}", :sqls => @sql_stack }
+        @sql_stack = []
+        @url = ''
+      end
+
+      def to_json
+        @sql_stacks.to_json
+      end
+
+    end
+  end
+end

data/lib/sql_tracer/version.rb

@@ -0,0 +1,3 @@
+module SqlTracer
+  VERSION = '0.0.7'
+end

data/lib/sql_tracer.rb

@@ -0,0 +1,26 @@
+require 'sql_tracer/engine'
+
+module SqlTracer
+  autoload :SqlLogger, 'sql_tracer/sql_logger'
+  autoload :Helper, 'sql_tracer/helper'
+  autoload :Formatter, 'sql_tracer/formatter'
+  autoload :RequestLogger, 'sql_tracer/request_logger'
+  autoload :SqlStack, 'sql_tracer/sql_stack'
+end
+
+# why does not work when wrapped in block ActiveSupport.on_load(:active_record) do
+begin
+  require 'active_record/connection_adapters/mysql2_adapter'
+  ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, SqlTracer::SqlLogger)
+  SqlTracer::Formatter.print_tips
+
+  ActiveSupport.on_load(:action_controller) do
+    ActionController::Base.send(:include, SqlTracer::RequestLogger)
+  end
+rescue LoadError, NameError => e
+  Rails.logger.error('Failed to injuect SqlTracer to ActiveRecord due to :' + e.message)
+end
+
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - xiaoye
@@ -30,7 +30,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- app/assets/stylesheets/sql_tracer/application.css
+- app/assets/stylesheets/sql_tracer/style.css
+- app/controllers/sql_tracer/sql_tracer_controller.rb
+- app/views/sql_tracer/sql_tracer/index.html.erb
+- config/routes.rb
+- lib/sql_tracer.rb
+- lib/sql_tracer/engine.rb
+- lib/sql_tracer/formatter.rb
+- lib/sql_tracer/helper.rb
+- lib/sql_tracer/request_logger.rb
+- lib/sql_tracer/sql_logger.rb
+- lib/sql_tracer/sql_stack.rb
+- lib/sql_tracer/version.rb
 homepage: https://git.dev.fwmrm.net/qzhang/sql_tracer
 licenses: []
 metadata: {}