query_track 0.0.8 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11eafb45e2ddc8bb353f21db9208a07f66cca5ebc089985ca4521a5560f7fcfb
-  data.tar.gz: fb7b68d7a32a8c28b8554009e18b39f681b922ead72052c842e7d14dfd937359
+  metadata.gz: 01a6865f61ee0960a492d72de93188ecdf6e82fc053a3fd18d2c7ece60732eb7
+  data.tar.gz: ab85a1ae63609d4bcea01d2ea80b92d9c8c5d8f84fac06106ba9d0adc1c5679b
 SHA512:
-  metadata.gz: c63eb4682ce2bf6fc7f174a7bb6b6983bec52e6ed5c174a309dbe73aa9cda1b251f079b455edb0e7f56a0e853c9850ee3841667c73649fb000373ca73daf0139
-  data.tar.gz: 60a112cc30412a12293ed6f52923b101e951488719227802d1794a43b39fae7c2de6bc56550a8d3eca32bc6a3ecd4d4fee75ad696297103fe53dc1aa6371ea3b
+  metadata.gz: d8c187430dd1cf118ad844ee6f997e691ee6bd265a5157dd59601e68ff7ac6a7bc48ae563500d678caece8fba0e13cd055d1db48810232e719190afcae9dcc93
+  data.tar.gz: 6652e86015b8bb6de17a7b35afc28f3df14f992906670bfe4055ada592902f54841fe6e464d58e575c117e2a4c1987957d06069daeadbb4bb7864e3ef010af7e

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.0.10 2020-08-07
+
+Added custom app directory ([evanboho](https://github.com/kirillshevch/query_track/pull/60))
+
+# v0.0.9 2019-12-21
+
+Added custom handles ([kirillshevch](https://github.com/kirillshevch/query_track/pull/29))
+
 # v0.0.8 2019-08-17
 
 Added enabled/disable config ([kirillshevch](https://github.com/kirillshevch/query_track/pull/13))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_track (0.0.8)
+    query_track (0.0.11)
       activesupport
       dry-configurable
       slack_hook
@@ -9,63 +9,67 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    byebug (11.0.1)
-    concurrent-ruby (1.1.5)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.1)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.3)
-    dry-configurable (0.8.3)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-    dry-core (0.4.9)
+      dry-core (~> 0.6)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    i18n (1.6.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
+    minitest (5.15.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.87.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     slack_hook (0.1.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.1.9)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler
   byebug
   query_track!
   rake

data/README.md

@@ -1,27 +1,18 @@
 # QueryTrack
 
 [![Gem Version](https://badge.fury.io/rb/query_track.svg)](https://badge.fury.io/rb/query_track)
-[![CircleCI](https://circleci.com/gh/kirillshevch/query_track.svg?style=svg)](https://circleci.com/gh/kirillshevch/query_track)
 [![Maintainability](https://api.codeclimate.com/v1/badges/15b0a6c0a1838b216db8/maintainability)](https://codeclimate.com/github/kirillshevch/query_track/maintainability)
 
 Tool for finding time-consuming database queries for ActiveRecord-based Rails Apps. Provides Slack notifications with backtrace, raw SQL, time duration, etc.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile` and then execute `bundle install`:
 
 ```ruby
 gem 'query_track'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install query_track
-
 ## Usage
 
 ### SQL Duration Limit
@@ -49,7 +40,7 @@ end
 
 ### Filters
 
-To avoid noisy warnings from used gems, and places where fat queries are justified, you can filters SQL by backtrace. 
+To avoid noisy warnings from used gems, and places where fat queries are justified, you can filters SQL by backtrace.
 For example, you have installed `activeadmin` and want to skip everything from `app/admin`:
 
 ```ruby
@@ -58,10 +49,22 @@ QueryTrack::Settings.configure do |config|
   config.filters = ['app/admin']
 end
 ```
+### App Directory
+
+QueryTrack finds the trace by filtering the caller by the app directory.
+By default, the app directory is set to 'app', the default for Rails apps.
+For apps that have a non-stanard app directory, this can be set with the `app_dir` config field:
+
+```ruby
+QueryTrack::Settings.configure do |config|
+  config.duration = 0.5
+  config.app_dir = 'backend'
+end
+```
 
 ### Enable/Disable toggle
 
-Enable/disable with ENV variables to turn it on/off without code push. By default *QueryTrack* is enabled. 
+Enable/disable with ENV variables to turn it on/off without code push. By default *QueryTrack* is enabled.
 
 ```ruby
 QueryTrack::Settings.configure do |config|
@@ -72,7 +75,7 @@ end
 
 ### Slack Notifications
 
-To receive notifications about slow queries into Slack, you need to install [incoming-webhooks](https://reflow-files.slack.com/apps/A0F7XDUAZ-incoming-webhooks) and put link into config file:
+To receive notifications about slow queries into Slack, you need to install [incoming-webhooks](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) and put link into config file:
 
 ```ruby
 QueryTrack::Settings.configure do |config|
@@ -83,6 +86,27 @@ end
 
 # <img src='https://github.com/kirillshevch/query_track/blob/master/examples/slack.jpg' alt='Incoming Hook Example' />
 
+## Custom Notifications (Handlers)
+
+You can write your own handler for slow queries. Send data to any source(for e.g. to logs storage) or make notification for another source(Email, Messengers, etc.)
+
+```ruby
+QueryTrack::Settings.configure do |config|
+  config.duration = 0.5
+  config.notifications.custom_handler = -> (sql, duration, trace) {
+    # data processing...
+  }
+end
+```
+
+## Production Usage Notes
+
+When [QueryTrack](https://github.com/kirillshevch/query_track/blob/master/lib/query_track/notifications/slack.rb#L21) send slack hooks, request is executed in separate thread. So there should be no synchronous delays.
+
+Subscription to SQL events and checking duration time actually take insignificant time in milliseconds.
+
+If your project is horizontally scaled, you can install `query_track` for one of the node to avoid performance degrade for whole application.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/query_track.

data/lib/query_track/event_processor.rb

@@ -16,6 +16,7 @@ module QueryTrack
       if duration_seconds > QueryTrack::Settings.config.duration
         QueryTrack::Notifications::Slack.new(event.payload[:sql], duration_seconds).call
         QueryTrack::Notifications::Log.new(event.payload[:sql], duration_seconds).call
+        QueryTrack::Notifications::Custom.new(event.payload[:sql], duration_seconds).call
       end
     end
 

data/lib/query_track/notifications/custom.rb

@@ -0,0 +1,20 @@
+module QueryTrack
+  module Notifications
+    class Custom
+      attr_reader :code, :duration
+
+      def initialize(code, duration)
+        @code = code.strip
+        @duration = duration
+      end
+
+      def call
+        return unless QueryTrack::Settings.config.notifications.custom_handler
+
+        trace = QueryTrack::Trace.new(caller).call
+
+        QueryTrack::Settings.config.notifications.custom_handler.call(code, duration, trace)
+      end
+    end
+  end
+end

data/lib/query_track/notifications/log.rb

@@ -1,7 +1,7 @@
 module QueryTrack
   module Notifications
     class Log
-      attr_reader :code, :duration, :webhook_url
+      attr_reader :code, :duration
 
       def initialize(code, duration)
         @code = code.strip

data/lib/query_track/settings.rb

@@ -6,6 +6,7 @@ module QueryTrack
 
     setting :notifications do
       setting :slack, ''
+      setting :custom_handler
     end
 
     setting :logs, false
@@ -13,5 +14,7 @@ module QueryTrack
     setting :filters, []
 
     setting :enabled, true
+
+    setting :app_dir, 'app'
   end
 end

data/lib/query_track/trace.rb

@@ -7,7 +7,7 @@ module QueryTrack
     end
 
     def call
-      full_trace.select { |v| v =~ %r{app/} }[0]
+      full_trace.select { |v| v =~ %r{#{QueryTrack::Settings.config.app_dir}/} }[0]
     end
   end
 end

data/lib/query_track/version.rb

@@ -1,3 +1,3 @@
 module QueryTrack
-  VERSION = '0.0.8'
+  VERSION = '0.0.11'
 end

data/lib/query_track.rb

@@ -5,6 +5,7 @@ require 'query_track/version'
 require 'query_track/settings'
 require 'query_track/trace'
 require 'query_track/filters'
+require 'query_track/notifications/custom'
 require 'query_track/notifications/slack'
 require 'query_track/notifications/log'
 require 'query_track/event_processor'

data/query_track.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'slack_hook'
   spec.add_dependency 'dry-configurable'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_track
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.11
 platform: ruby
 authors:
 - Kirill Shevchenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-17 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -146,6 +146,7 @@ files:
 - lib/query_track.rb
 - lib/query_track/event_processor.rb
 - lib/query_track/filters.rb
+- lib/query_track/notifications/custom.rb
 - lib/query_track/notifications/log.rb
 - lib/query_track/notifications/slack.rb
 - lib/query_track/settings.rb
@@ -157,7 +158,7 @@ homepage: https://github.com/kirillshevch/query_track
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Finding time-consuming database queries for ActiveRecord-based Rails Apps
 test_files: []

data/.circleci/config.yml

@@ -1,25 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.5-node 
-
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - query-track-bundle-v2-{{ checksum "query_track.gemspec" }}
-
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install
-
-      - save_cache:
-          key: query-track-bundle-v2-{{ checksum "query_track.gemspec" }}
-          paths:
-            - vendor/bundle
-
-      - run:
-          name: Run Rspec
-          command: bundle exec rspec