query_track 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11eafb45e2ddc8bb353f21db9208a07f66cca5ebc089985ca4521a5560f7fcfb
-  data.tar.gz: fb7b68d7a32a8c28b8554009e18b39f681b922ead72052c842e7d14dfd937359
+  metadata.gz: 3721d96e0c635e1633e6da2f049188b125b96310c5af307abfa432755986f2da
+  data.tar.gz: 8096cc6850c1b5e4fa8bf54b4714616fb6f8433ac7ebcec95f166fddf6e5313c
 SHA512:
-  metadata.gz: c63eb4682ce2bf6fc7f174a7bb6b6983bec52e6ed5c174a309dbe73aa9cda1b251f079b455edb0e7f56a0e853c9850ee3841667c73649fb000373ca73daf0139
-  data.tar.gz: 60a112cc30412a12293ed6f52923b101e951488719227802d1794a43b39fae7c2de6bc56550a8d3eca32bc6a3ecd4d4fee75ad696297103fe53dc1aa6371ea3b
+  metadata.gz: e454a83da93cdbbd55c183c2a4d68927e6016e8c6b48638f872348d22c1974b4368323d4b5aa1d4fe25b867ccb7d223cb0f542d88fc2abbc2b4249f32452f820
+  data.tar.gz: a330eddd0467e492f6b39c6232ed1132f43a3d5e01e2bca3746dddeddac4da911946f811e51b6bbf8fb18b0eefa157e3a755fc3ba521bb3f51f00e475c99d3cb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_track (0.0.8)
+    query_track (0.0.9)
       activesupport
       dry-configurable
       slack_hook
@@ -9,44 +9,44 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
     byebug (11.0.1)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    dry-configurable (0.8.3)
+    dry-configurable (0.9.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
     dry-core (0.4.9)
       concurrent-ruby (~> 1.0)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    minitest (5.13.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
     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)
+    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)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -59,7 +59,7 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    zeitwerk (2.1.9)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,20 +8,12 @@ Tool for finding time-consuming database queries for ActiveRecord-based Rails A
 
 ## 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
@@ -72,7 +64,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 +75,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.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/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/settings.rb

@@ -6,6 +6,7 @@ module QueryTrack
 
     setting :notifications do
       setting :slack, ''
+      setting :custom_handler
     end
 
     setting :logs, false

data/lib/query_track/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_track
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Kirill Shevchenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-17 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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