sql_trace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28b2a6f7fa62baecb65365d1daabebbd4d3d604d
+  data.tar.gz: ee441e97cfd90675adbc0ae4eedaa2d4b773528b
+SHA512:
+  metadata.gz: 811dba3302d997b8cba7a0b61f24d52b535bcdb778a5be5f51eeccf07e756d7cbb0be62cb8e20bf8597f20ee5cd49da66e131759af8fc29b9167c08700b2e9b1
+  data.tar.gz: 90c265b578628b01c272862c2e4b93ef97a23f1230f50fbdb3de106f17c5f64672a7b8c45fff665230c3d2e62178c36b91f88ec4ae970670c03f2e0573c755af

data/README.md

@@ -0,0 +1,55 @@
+# sql_trace
+
+Ever wondered where do those SQL calls come from in your Rails app?
+
+**sql_trace** allows to trace code that makes ActiveRecord SQL queries that
+appear in development server's log. It also allows to filter them in order
+to trace heavy ones or ones with matching SQL.
+
+This makes it very useful during app-db optimizations.
+
+## Installation
+
+Add to `Gemfile`:
+
+```ruby
+gem 'sql_trace', group: :development
+```
+
+Then run:
+
+    bundle install
+
+## Usage
+
+Start development server like this:
+
+    SQL_TRACE=1 rails server
+
+This way you'll get 5-line traces for all SQL queries. You can customize
+that using options described below.
+
+## Options
+
+You can write options when invoking Rails server or store them in *.env*
+file and use `dotenv` or `foreman` gems to load them.
+
+Following options are available:
+
+##### SQL_TRACE=N
+
+Changes the stack size to N (must be at least 2, defaults to 5).
+
+##### SQL_TRACE_COLOR=cyan
+
+Uses [colorize](https://github.com/fazibear/colorize) gem to make traces
+look distinct within server log. The gem must be installed separately.
+
+##### SQL_TRACE_MIN_DURATION=250
+
+Only prints traces for queries that take at least specified duration.
+Duration is in **ms**.
+
+##### SQL_TRACE_MATCH='FROM "users"'
+
+Only prints traces for queries whose SQL match given string or /regex/

data/lib/sql_trace.rb

@@ -0,0 +1,2 @@
+require 'sql_trace/logger'
+require 'sql_trace/railtie'

data/lib/sql_trace/logger.rb

@@ -0,0 +1,46 @@
+module SqlTrace
+  class Logger
+    class << self
+      def start
+        if (sql_trace = ENV['SQL_TRACE'].to_i) > 0
+          stack_size = sql_trace > 1 ? sql_trace : 5
+          stack_root = Rails.root.to_s
+          min_duration = ENV['SQL_TRACE_MIN_DURATION'].to_i
+
+          match = if (raw_match = ENV['SQL_TRACE_MATCH']).present?
+            raw_match.match(/^\/.*\/$/) ? Regexp.compile(raw_match[1..-2]) : Regexp.quote(raw_match)
+          end
+
+          if color = ENV['SQL_TRACE_COLOR']
+            require 'colorize'
+          end
+
+          ActiveSupport::Notifications.subscribe("sql.active_record") do |n, s, e, i, payload|
+            name = payload[:name]
+            sql = payload[:sql]
+            duration = ActiveSupport::Notifications::Event.new(n, s, e, i, payload).duration
+
+            unless name.in?(%w{CACHE SCHEMA}) ||
+                (min_duration > 0 && duration < min_duration) ||
+                (match && !sql.match(match))
+              stack = caller.select do |line|
+                line.start_with?(stack_root)
+              end[0..stack_size - 1].map do |line|
+                line.sub("#{stack_root}/", '')
+              end
+
+              if stack.present?
+                stack.each do |line|
+                  line = "  #{line}"
+                  line = line.send(color) if color
+
+                  puts line
+                end && puts
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sql_trace/railtie.rb

@@ -0,0 +1,9 @@
+module SqlTrace
+  class Railtie < Rails::Railtie
+    railtie_name :sql_trace
+
+    initializer 'sql_trace.logger' do
+      SqlTrace::Logger.start
+    end
+  end
+end

data/lib/sql_trace/version.rb

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

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: sql_trace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Słuszniak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: 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: activesupport
+  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: Trace ActiveRecord calls in development console
+email: karol@cloudless.pl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/sql_trace.rb
+- lib/sql_trace/logger.rb
+- lib/sql_trace/railtie.rb
+- lib/sql_trace/version.rb
+homepage: http://github.com/karolsluszniak/sql-trace
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Trace ActiveRecord calls in development console
+test_files: []