query_track 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c122b692e3d0759318d5b4dc02d57a4d9b97435916c1fb4bfe19db40033bb22
+  data.tar.gz: 72cd1a23053496a135b6a1414e92409a1ad581bad29fb06c2c4429cec4baf3d2
+SHA512:
+  metadata.gz: a98d3ea20b02490fa1b0da6bc1b41db364c7889f6e79191570af221ac2e4ff9fcf20228de2dc9f5e8e4d11cd96881271962c7a8feaadc522f1fcdc8b0ecad381
+  data.tar.gz: 463aa697653af58b1a0272699f1cdfd71f1d12543fe38dbd7129f7a0ccaa85406af301f792d1568ae95351333ecbe0dc5ecd289739cc0f6badfd18964389f8f1

data/.circleci/config.yml

@@ -0,0 +1,25 @@
+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 

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.5
+
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.0.1 2019-07-20
+
+Initial release with event processing, slack notifications and duration limit. ([kirillshevch](https://github.com/kirillshevch/query_track/pull/1))

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in query_track.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    query_track (0.0.1)
+      activesupport
+      dry-configurable
+      slack_hook
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dry-configurable (0.8.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-core (0.4.8)
+      concurrent-ruby (~> 1.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  query_track!
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kirill Shevchenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# 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)
+
+Tool for finding time-consuming database queries for ActiveRecord-based Rails Apps. Provides Slack notifications for with backtrace, raw SQL, time duration, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'query_track'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_track
+
+## Usage
+
+Specify SQL duration query limit:
+
+```ruby
+QueryTrack::Settings.configure do |config|
+  config.duration = 0.5
+end
+```
+
+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:
+
+```ruby
+QueryTrack::Settings.configure do |config|
+  config.duration = 0.5
+  config.notifications.slack = 'https://hooks.slack.com/services/T0000000/B0000000/C0000000'
+end
+```
+
+# <img src='https://github.com/kirillshevch/query_track/blob/master/slack.jpg' alt='Incoming Hook Example' />
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/query_track.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'query_track'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/query_track/event_processor.rb

@@ -0,0 +1,17 @@
+module QueryTrack
+  class EventProcessor
+    attr_reader :event
+
+    def initialize(event)
+      @event = event
+    end
+
+    def call
+      return unless QueryTrack::Settings.config.duration
+
+      if event.duration > QueryTrack::Settings.config.duration
+        QueryTrack::Notifications::Slack.new(event.payload[:sql], event.duration).call
+      end
+    end
+  end
+end

data/lib/query_track/notifications/slack.rb

@@ -0,0 +1,58 @@
+module QueryTrack
+  module Notifications
+    class Slack
+      attr_reader :code, :duration, :webhook_url
+
+      def initialize(code, duration)
+        @code = code.strip
+        @duration = duration
+        @webhook_url = QueryTrack::Settings.config.notifications.slack
+      end
+
+      def call
+        slack_hook = SlackHook::Incoming.new(webhook_url)
+
+        trace = caller.select { |v| v =~ %r{app/} }[0]
+
+        payload = { blocks: blocks(trace) }
+
+        slack_hook.post(payload)
+      end
+
+      private
+
+      def blocks(trace)
+        [
+          {
+            "type": 'divider'
+          },
+          {
+            "type": 'section',
+            "text": {
+              "type": 'mrkdwn',
+              "text": "```#{code}```"
+            }
+          },
+          {
+            "type": 'context',
+            "elements": [
+              {
+                "type": 'mrkdwn',
+                "text": "Duration: *#{duration}s* "
+              }
+            ]
+          },
+          {
+            "type": 'context',
+            "elements": [
+              {
+                "type": 'mrkdwn',
+                "text": "#{trace}"
+              }
+            ]
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/query_track/settings.rb

@@ -0,0 +1,11 @@
+module QueryTrack
+  class Settings
+    extend ::Dry::Configurable
+
+    setting :duration
+
+    setting :notifications do
+      setting :slack, ''
+    end
+  end
+end

data/lib/query_track/version.rb

@@ -0,0 +1,3 @@
+module QueryTrack
+  VERSION = '0.0.1'
+end

data/lib/query_track.rb

@@ -0,0 +1,13 @@
+require 'dry-configurable'
+require 'active_support/notifications'
+require 'slack_hook'
+require 'query_track/version'
+require 'query_track/settings'
+require 'query_track/notifications/slack'
+require 'query_track/event_processor'
+require 'subscriber'
+
+module QueryTrack
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/subscriber.rb

@@ -0,0 +1,5 @@
+ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+
+  QueryTrack::EventProcessor.new(event).call
+end

data/query_track.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_track/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'query_track'
+  spec.version       = QueryTrack::VERSION
+  spec.authors       = ['Kirill Shevchenko']
+  spec.email         = ['hello@kirillshevch.com']
+
+  spec.summary       = 'Finding time-consuming database queries for ActiveRecord-based Rails Apps'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/kirillshevch/query_track'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'slack_hook'
+  spec.add_dependency 'dry-configurable'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: query_track
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kirill Shevchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-20 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: slack_hook
+  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'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: byebug
+  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'
+description: Finding time-consuming database queries for ActiveRecord-based Rails Apps
+email:
+- hello@kirillshevch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/query_track.rb
+- lib/query_track/event_processor.rb
+- lib/query_track/notifications/slack.rb
+- lib/query_track/settings.rb
+- lib/query_track/version.rb
+- lib/subscriber.rb
+- query_track.gemspec
+- slack.jpg
+homepage: https://github.com/kirillshevch/query_track
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Finding time-consuming database queries for ActiveRecord-based Rails Apps
+test_files: []