sapience 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11cce05eedf1219a30f6da98358d1047be347bb5
-  data.tar.gz: 439781b493d904279964f6b6dc74caea43058082
+  metadata.gz: 67aad6878ced498fd8bb3f53f38316eb1d0c311a
+  data.tar.gz: 8530772e63086bd9e30d1bcba0a743e3f2df83ec
 SHA512:
-  metadata.gz: 702c8f1c1af9e49c5a2f0b3f352c4f2d0835836952e420e3e827a105b586723041605ff76ef29b1ffb1eea351a466faeabc79fa29be639e890b31b3a3581a1aa
-  data.tar.gz: 750f844879a9d7b5d886bc5e3fdc2a7e7aa8cf8b33487e3b090494d0b71c7b3d55b86ab2b36435abe5dbad838b8bd85a4adc028389b6b0b04afc71a78556cfb6
+  metadata.gz: 3ea440554539370aa76691e74c66d8e1edc4ebdab2b6539250206302892ca8d699508f0255d35c2e2b455dfa03d4af189c7f10da718be3da32bb27ed94653b93
+  data.tar.gz: a091be856a79a94b3a62a5b4c0e90456f89f68f9afab0e41c386a5663849cd98ca16e526a62d904c7394d69cd5c65c19d1d7bc21319f76c4a674fe9b22cf4d8a

data/.gitignore

@@ -11,3 +11,5 @@ log/
 
 **/examples.txt
 **/*.gem
+
+/vendor/

data/.travis.yml

@@ -1,16 +1,24 @@
 sudo: required
 dist: trusty
 language: ruby
+cache:
+  bundler: true
+  directories:
+    - $HOME/docker
+
 services:
   - docker
 
 before_script:
   - mkdir -p coverage/rails coverage/grape coverage/sapience
+  - bundle exec rake reevoocop
+
+env:
+  - TEST_SUITE=rspec INSTALL=false
+  - TEST_SUITE=rails INSTALL=false
+  - TEST_SUITE=grape INSTALL=false
 
-script:
-  - docker-compose run rspec
-  - docker-compose run rails
-  - docker-compose run grape
+script: "docker-compose run $TEST_SUITE"
 
 after_success:
   - chown -R $(whoami) coverage

data/Rakefile

@@ -12,4 +12,4 @@ begin
 rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
-task default: [:reevoocop, :spec]
+task default: [:spec]

data/dev-entrypoint.sh

@@ -7,4 +7,9 @@ set -e
 
 # 5: Check or install the app dependencies via Bundler:
 bundle check || bundle install --jobs 8 --retry 5
+
+if [ -f config/database.yml ]; then
+  bundle exec rake db:create db:migrate db:test:prepare
+fi;
+
 exec "$@"

data/docker-compose.yml

@@ -10,7 +10,11 @@ services:
       RABBITMQ_DEFAULT_USER: sapience
       RABBITMQ_DEFAULT_PASS: tests
 
-
+  postgres:
+    image: postgres:latest
+    environment:
+      POSTGRES_USER: sapience
+      POSTGRES_PASSWORD: tests
 
   base:
     image: ruby:2.3
@@ -26,6 +30,7 @@ services:
     # Enable sending signals (CTRL+C, CTRL+P + CTRL+Q) into the container:
     tty: true
     volumes:
+      # - vendor/bundle:/usr/local/bundle
       # Mount our app code directory (".") into our app containers at the
       # "/usr/src/app" folder:
       - .:/usr/src/app
@@ -55,8 +60,12 @@ services:
     command: bundle exec rspec
     depends_on:
       - rabbitmq
+      - postgres
     environment:
       APP_NAME: rails_app
+      POSTGRES_HOST: postgres
+      POSTGRES_USER: sapience
+      POSTGRES_PASSWORD: tests
       AMQP: amqp://sapience:tests@rabbitmq:5672
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 

data/lib/sapience/appender/datadog.rb

@@ -33,7 +33,6 @@ module Sapience
         @tags = options.delete(:tags)
         @uri  = URI.parse(url)
         fail('Statsd only supports udp. Example: "udp://localhost:8125"') if @uri.scheme != "udp"
-
         super(options, &block)
       end
 
@@ -47,58 +46,50 @@ module Sapience
         return false unless metric
 
         if log.duration
-          timing(metric, log.duration)
+          timing(metric, log.duration, tags: log.tags)
         else
           amount = (log.metric_amount || 1).round
-          if amount < 0
-            decrement(metric, amount.abs)
-          else
-            increment(metric, amount)
-          end
+          count(metric, amount, tags: log.tags)
         end
         true
       end
 
-      def timing(metric, duration = 0)
+      def timing(metric, duration = 0, options = {})
         if block_given?
           start = Time.now
           yield
-          provider.timing(metric, ((Time.now - start) * 1000).floor)
+          provider.timing(metric, ((Time.now - start) * 1000).floor, options)
         else
-          provider.timing(metric, duration)
+          provider.timing(metric, duration, options)
         end
       end
 
-      def increment(metric, amount = 1)
-        provider.batch do
-          amount.times { provider.increment(metric) }
-        end
+      def increment(metric, options = {})
+        provider.increment(metric, options)
       end
 
-      def decrement(metric, amount = 1)
-        provider.batch do
-          amount.times { provider.decrement(metric) }
-        end
+      def decrement(metric, options = {})
+        provider.decrement(metric, options)
       end
 
-      def histogram(metric, amount)
-        provider.histogram(metric, amount)
+      def histogram(metric, amount, options = {})
+        provider.histogram(metric, amount, options)
       end
 
-      def gauge(metric, amount, hash = {})
-        provider.gauge(metric, amount, hash)
+      def gauge(metric, amount, options = {})
+        provider.gauge(metric, amount, options)
       end
 
-      def count(metric, amount, hash = {})
-        provider.count(metric, amount, hash)
+      def count(metric, amount, options = {})
+        provider.count(metric, amount, options)
       end
 
-      def time(metric, &block)
-        provider.time(metric, &block)
+      def time(metric, options = {}, &block)
+        provider.time(metric, options, &block)
       end
 
-      def batch
-        yield provider
+      def batch(&block)
+        provider.batch(&block)
       end
 
       def event(title, text, options = {})
@@ -106,7 +97,7 @@ module Sapience
       end
 
       def namespace
-        ns = Sapience.namify(Sapience.app_name)
+        ns = Sapience.namify(app_name)
         ns << ".#{Sapience.namify(Sapience.environment)}" if Sapience.environment
         ns
       end

data/lib/sapience/configuration.rb

@@ -21,8 +21,8 @@ module Sapience
 
     # Initial default Level for all new instances of Sapience::Logger
     def initialize(options = {}) # rubocop:disable AbcSize
-      fail ArgumentError, "options need to be a hash" unless options.is_a?(Hash)
-      @options             = DEFAULT.merge(options.deep_symbolize_keyz!)
+      fail ArgumentError, "options need to be a hash #{options.inspect}" unless options.is_a?(Hash)
+      @options             = DEFAULT.merge(options.dup.deep_symbolize_keyz!)
       @options[:log_executor] &&= @options[:log_executor].to_sym
       validate_log_executor!(@options[:log_executor])
       self.default_level   = @options[:log_level].to_sym

data/lib/sapience/extensions/action_controller/notifications.rb

@@ -0,0 +1,54 @@
+module Sapience
+  module Extensions
+    module ActionController
+      class Notifications < ::Sapience::Extensions::Notifications
+        # Options:
+        #
+        # *<tt>:metric_name</tt> - the metric name, defaults to "rails.request"
+        # *<tt>:tags</tt> - additional tags
+        def initialize(options = {})
+          @metric_name = options[:metric_name] || "rails.request"
+          super
+          Sapience::Extensions::Notifications.subscribe("process_action.action_controller") do |event|
+            record event
+          end
+        end
+
+        private
+
+        def record(event) # rubocop:disable AbcSize
+          return unless record?
+
+          payload = event.payload
+          method  = payload[:method].downcase
+          status  = payload[:status]
+          action  = payload[:action]
+          ctrl    = payload[:controller].sub(/Controller$/, "").underscore
+          format  = payload[:format]
+
+          tags    = self.tags + %W(
+            method:#{method}
+            status:#{status}
+            action:#{action}
+            controller:#{ctrl}
+            format:#{format}
+          )
+
+          metrics.batch do
+            metrics.increment metric_name, tags: tags
+            metrics.timing("#{metric_name}.time", event.duration, tags: tags)
+            if payload[:db_runtime]
+              metrics.timing("#{metric_name}.time.db", payload[:db_runtime].round(10), tags: tags)
+            end
+
+
+
+            if payload[:view_runtime]
+              metrics.timing("#{metric_name}.time.view", payload[:view_runtime].round(2), tags: tags)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sapience/extensions/active_job/notifications.rb

@@ -0,0 +1,35 @@
+module Sapience
+  module Extensions
+    module ActiveJob
+      class Notifications < ::Sapience::Extensions::Notifications
+
+        # Options:
+        #
+        # *<tt>:metric_name</tt> - the metric name, defaults to "activejob.perform"
+        # *<tt>:tags</tt>        - additional tags
+        def initialize(opts = {})
+          super
+          @metric_name = opts[:metric_name] || "activejob.perform"
+
+          Sapience::Extensions::Notifications.subscribe "perform.active_job" do |event|
+            record event
+          end
+        end
+
+        private
+
+        def record(event) # rubocop:disable AbcSize
+          return unless record?
+
+          job  = event.payload[:job]
+          name = job.class.name.sub(/Job$/, "").underscore
+          tags = self.tags + %W(name:#{name} queue:#{job.queue_name})
+          metrics.batch do
+            metrics.increment metric_name, tags: tags
+            metrics.timing "#{metric_name}.time", event.duration, tags: tags
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sapience/extensions/active_record/notifications.rb

@@ -0,0 +1,45 @@
+module Sapience
+  module Extensions
+    module ActiveRecord
+      class Notifications < ::Sapience::Extensions::Notifications
+        # Options:
+        #
+        # *<tt>:metric_name</tt>      - the metric name, defaults to "activerecord.query"
+        # *<tt>:include_schema</tt>   - record schema queries, off by default
+        # *<tt>:include_generic</tt>  - record general (nameless) queries, off by default
+        # *<tt>:tags</tt>             - additional tags
+        def initialize(opts = {})
+          super
+          @metric_name     = opts[:metric_name] || "activerecord.sql"
+          @include_schema  = opts[:include_schema] == true
+          @include_generic = opts[:include_generic] == true
+          @include_raw     = opts[:include_raw] == true
+
+          Sapience::Extensions::Notifications.subscribe "sql.active_record" do |event|
+            record event
+          end
+        end
+
+        private
+
+        def record(event) # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity
+          return unless record?
+
+          payload = event.payload
+          name    = payload[:name]
+          return if (name.nil? || name == "SQL") && !@include_generic
+          return if name == "SCHEMA" && !@include_schema
+
+          name = name.downcase.split(/\W/).join(".") if name
+          tags = self.tags.dup
+          tags.push "query:#{name}" if name
+
+          metrics.batch do
+            metrics.increment metric_name, tags: tags
+            metrics.timing "#{metric_name}.time", event.duration, tags: tags
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sapience/extensions/grape/middleware/logging.rb

@@ -39,7 +39,7 @@ module Sapience
             {
               method: request.request_method,
               request_path: request.path,
-              format: "json",
+              format: env["api.endpoint"].instance_variable_get(:@app).instance_variable_get(:@app).options[:format],
               status: response.try(:status) || 404,
               class_name: env["api.endpoint"].options[:for].to_s,
               action: "index",

data/lib/sapience/extensions/grape/notifications.rb

@@ -0,0 +1,46 @@
+module Sapience
+  module Extensions
+    module Grape
+      class Notifications < ::Sapience::Extensions::Notifications
+        # Options:
+        #
+        # *<tt>:metric_name</tt> - the metric name, defaults to "grape.request"
+        # *<tt>:tags</tt> - additional tags
+        def initialize(opts = {})
+          super
+          @metric_name = opts[:metric_name] || "grape.request"
+
+          Sapience::Extensions::Notifications.subscribe "endpoint_run.grape" do |event|
+            record event
+          end
+        end
+
+        private
+
+        def record(event) # rubocop:disable AbcSize
+          return unless record?
+
+          payload  = event.payload
+          endpoint = payload[:endpoint]
+          route    = endpoint.route
+          version  = route.version
+          method   = route.request_method.downcase
+          format   = payload[:endpoint].instance_variable_get(:@app).instance_variable_get(:@app).options[:format]
+          path = route.pattern.path.dup
+
+          path.sub!(/\(\.#{format}\)$/, "")
+          path.sub!(":version/", "") if version
+          path.gsub!(/:(\w+)/) { |m| m[1..-1].upcase }
+          path.gsub!(/[^\w\/\-]+/, "_")
+
+          tags = self.tags + %W(method:#{method} format:#{format} path:#{path} status:#{endpoint.status})
+          tags.push "version:#{version}" if version
+          metrics.batch do
+            metrics.increment metric_name, tags: tags
+            metrics.timing "#{metric_name}.time", event.duration, tags: tags
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sapience/extensions/notifications.rb

@@ -0,0 +1,32 @@
+require "active_support"
+require "active_support/notifications"
+
+module Sapience
+  module Extensions
+    class Notifications
+      attr_reader :tags, :metric_name
+
+      def self.use(options = {})
+        new(options)
+      end
+
+      def self.subscribe(pattern, &block)
+        ::ActiveSupport::Notifications.subscribe(pattern) do |*args|
+          block.call ::ActiveSupport::Notifications::Event.new(*args)
+        end
+      end
+
+      def initialize(options = {})
+        @tags = options[:tags] || []
+      end
+
+      def record?
+        !metrics.nil?
+      end
+
+      def metrics
+        Sapience.metrics
+      end
+    end
+  end
+end

data/lib/sapience/grape.rb

@@ -1,6 +1,7 @@
 require "sapience"
 require "sapience/extensions/grape/timings"
 require "sapience/extensions/grape/middleware/logging"
+require "sapience/extensions/grape/notifications"
 
 module Grape
   class API
@@ -12,5 +13,6 @@ module Sapience
   class Grape
     Sapience.configure
     ::Grape::API.send(:include, Sapience::Loggable)
+    Sapience::Extensions::Grape::Notifications.use
   end
 end

data/lib/sapience/rails/engine.rb

@@ -1,9 +1,14 @@
 require "sapience"
 require "sapience/extensions/action_controller/live" if defined?(ActionController::Live)
 require "sapience/extensions/action_controller/log_subscriber"
+require "sapience/extensions/action_controller/notifications"
 require "sapience/extensions/action_dispatch/debug_exceptions"
 require "sapience/extensions/action_view/streaming_template_renderer"
-require "sapience/extensions/active_record/log_subscriber" if defined?(ActiveRecord)
+if defined?(ActiveRecord)
+  require "sapience/extensions/active_record/log_subscriber"
+  require "sapience/extensions/active_record/notifications"
+end
+require "sapience/extensions/active_job/notifications" if defined?(ActiveJob)
 require "sapience/extensions/rails/rack/logger"
 require "sapience/extensions/rails/rack/logger_info_as_debug"
 require "sapience/extensions/action_view/log_subscriber"
@@ -67,9 +72,15 @@ module Sapience
         Bugsnag.configure { |config| config.logger = Sapience[Bugsnag] } if defined?(Bugsnag)
         Sapience::Extensions::ActionController::LogSubscriber.attach_to :action_controller
         # Sapience::Extensions::ActiveSupport::MailerLogSubscriber.attach_to :action_mailer
-        Sapience::Extensions::ActiveRecord::LogSubscriber.attach_to :active_record if defined?(ActiveRecord)
+        if defined?(ActiveRecord)
+          Sapience::Extensions::ActiveRecord::LogSubscriber.attach_to :active_record
+          Sapience::Extensions::ActiveRecord::Notifications.use
+        end
+
         Sapience::Extensions::ActionView::LogSubscriber.attach_to :action_view
         # Sapience::Extensions::ActiveJob::LogSubscriber.attach_to :active_job
+        Sapience::Extensions::ActionController::Notifications.use
+        Sapience::Extensions::ActiveJob::Notifications.use if defined?(ActiveJob)
       end
     end
   end

data/lib/sapience/sapience.rb

@@ -33,12 +33,9 @@ module Sapience
   RAILS_ENV    = "RAILS_ENV".freeze
   SAPIENCE_ENV = "SAPIENCE_ENV".freeze
 
-  # TODO: Maybe when configuring with a block we should create a new config?
-  # See the TODO note on .config for more information
   def self.configure(force: false)
     yield config if block_given?
     return config if configured? && force == false
-    reload_config!
     reset_appenders!
     add_appenders(*config.appenders)
     @@configured = true
@@ -50,13 +47,6 @@ module Sapience
     @@config_hash ||= ConfigLoader.load_from_file
   end
 
-  def self.reload_config!
-    @@config_hash = ConfigLoader.load_from_file
-  end
-
-  # TODO: Should we really always read from file?
-  # What if someone wants to configure sapience with a block
-  # without reading the default.yml?
   def self.config
     @@config ||= begin
       options   = config_hash[environment]
@@ -220,7 +210,7 @@ module Sapience
   #   logger.debug("Login time", user: 'Joe', duration: 100, ip_address: '127.0.0.1')
   def self.add_appender(appender, options = {}, _deprecated_level = nil, &_block)
     fail ArgumentError, "options should be a hash" unless options.is_a?(Hash)
-    options.deep_symbolize_keyz!
+    options = options.dup.deep_symbolize_keyz!
     appender_class = constantize_symbol(appender)
     validate_appender!(appender_class)
 
@@ -286,7 +276,7 @@ module Sapience
   end
 
   def self.metrics
-    @@metrics ||= Sapience.add_appender(:datadog)
+    @@metrics ||= nil
   end
 
   def self.logger=(logger)

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/sapience.rb

@@ -4,6 +4,7 @@ require "sapience/core_ext/hash"
 require "sapience/core_ext/symbol"
 require "sapience/core_ext/thread"
 require "sapience/sapience"
+require "sapience/extensions/notifications"
 
 # @formatter:off
 

data/test_apps/grape/Gemfile

@@ -11,11 +11,12 @@ gem "puma", "~> 3.0"
 gem "sapience", path: "../.."
 gem "sentry-raven"
 gem "dogstatsd-ruby"
+gem "activesupport"
 
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem "byebug", platform: :mri
-  # gem "pry-nav"
+  # gem "pry-nav", platform: :mri
   gem "pry-byebug", platform: :mri
   gem "rspec"
   gem "racksh"

data/test_apps/grape/gemfiles/grape_0.16.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.2)
+    sapience (1.0.3)
       concurrent-ruby (~> 1.0)
 
 GEM

data/test_apps/grape/gemfiles/grape_0.17.0.gemfile

@@ -7,6 +7,7 @@ gem "puma", "~> 3.0"
 gem "sapience", :path => "../../.."
 gem "sentry-raven"
 gem "dogstatsd-ruby"
+gem "activesupport"
 
 group :development, :test do
   gem "byebug", :platform => :mri

data/test_apps/grape/gemfiles/grape_0.17.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.2)
+    sapience (1.0.3)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -118,6 +118,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   appraisal
   byebug
   dogstatsd-ruby

data/test_apps/grape/lib/ping/api.rb

@@ -1,6 +1,7 @@
 require "grape"
 require "grape/api"
 require "sapience/grape"
+require "active_support/notifications"
 
 module Ping
   class API < ::Grape::API

data/test_apps/grape/spec/lib/ping/api_spec.rb

@@ -16,11 +16,25 @@ describe Ping::API do
       expect(last_response.body).to match(/PONG/)
     end
 
+    describe "ActiveSupport::Notifications" do
+      let(:metrics) { Sapience.metrics }
+      let(:tags) { %w(method:get format:json path:/api/ping status:200) }
+      before do
+        Sapience.configure { |c| c.app_name = "grape" }
+        Sapience.add_appender(:datadog)
+      end
+      specify do
+        expect(metrics).to receive(:increment).with("grape.request", tags: tags)
+        expect(metrics).to receive(:timing).with("grape.request.time", kind_of(Float), tags: tags)
+        get "/api/ping"
+      end
+    end
+
     it "logs something" do
       expect(logger).to receive(:info).with(
         method:       "GET",
         request_path: "/api/ping",
-        format:       "json",
+        format:       :json,
         status:       200,
         class_name:   "Ping::API",
         action:       "index",
@@ -44,7 +58,7 @@ describe Ping::API do
         expect(logger).to receive(:info).with(
           method:       "GET",
           request_path: "/api/404",
-          format:       "json",
+          format:       :json,
           status:       404,
           class_name:   "Ping::API",
           action:       "index",

data/test_apps/grape/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "sapience/grape"
 require "rspec/its"
 require "ping"
+require "pry"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

data/test_apps/rails/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem "rails", "~> 5.0.0"
 # Use sqlite3 as the database for Active Record
-gem "sqlite3"
+gem "pg"
 # Use Puma as the app server
 gem "puma", "~> 3.0"
 # Use Redis adapter to run Action Cable in production

data/test_apps/rails/app/jobs/test_job.rb

@@ -0,0 +1,12 @@
+require "application_job"
+require_relative "../../../../spec/support/file_helper"
+
+class TestJob < ApplicationJob
+  VERIFICATION_FILE = Rails.root.join("tmp/test_job.verified")
+  queue_as :test_queue
+  include FileHelper
+
+  def perform
+    create_file(VERIFICATION_FILE)
+  end
+end

data/test_apps/rails/app/models/post.rb

@@ -1,3 +1,3 @@
 class Post < ApplicationRecord
-  belongs_to :author, class_name: User
+  belongs_to :author, class_name: User, inverse_of: :posts
 end

data/test_apps/rails/app/models/user.rb

@@ -1,2 +1,3 @@
 class User < ApplicationRecord
+  has_many :posts, inverse_of: :author
 end

data/test_apps/rails/app/workers/test_worker.rb

@@ -3,7 +3,7 @@ require_relative "../../../../spec/support/file_helper"
 class TestWorker
   QUEUE_NAME  = :sneakers_queue
   ROUTING_KEY  = :sneakers_routing_key
-  VERIFICATION_FILE = "tmp/sneakers.verified".freeze
+  VERIFICATION_FILE = Rails.root.join("tmp/test_worker.verified")
 
   include Sneakers::Worker
   include FileHelper

data/test_apps/rails/config/database.yml

@@ -5,21 +5,20 @@
 #   gem 'sqlite3'
 #
 default: &default
-  adapter: sqlite3
+  adapter: postgresql
+  host: <%= ENV.fetch('POSTGRES_HOST') { "localhost" } %>
+  username: <%= ENV.fetch('POSTGRES_USER') { `whoami` } %>
+  password: <%= ENV.fetch('POSTGRES_PASSWORD') { nil } %>
   pool: 5
   timeout: 5000
 
 development:
   <<: *default
-  database: db/development.sqlite3
+  database: rails_app_dev
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
   <<: *default
-  database: db/test.sqlite3
-
-production:
-  <<: *default
-  database: db/production.sqlite3
+  database: rails_app_test

data/test_apps/rails/config/initializers/sneakers.rb

@@ -1,15 +1,14 @@
 require "serverengine"
 require "sneakers"
-
-p ENV.fetch("AMQP") { "amqp://guest:guest@localhost:5672" }
+require "sapience"
 
 Sneakers.configure(
-  amqp:               ENV.fetch("AMQP") { "amqp://guest:guest@localhost:5672" },
-  exchange_type:      :direct,
-  log:                Sapience[Sneakers], # Log file
-  exchange:           "sapience", # AMQP exchange
-  durable:            false, # Is queue durable?
-  ack:                true, # Must we acknowledge?
-  metrics:            Sapience.metrics,
+  amqp:          ENV.fetch("AMQP") { "amqp://guest:guest@localhost:5672" },
+  exchange_type: :direct,
+  log:           Sapience[Sneakers], # Log file
+  exchange:      "sapience", # AMQP exchange
+  durable:       false, # Is queue durable?
+  ack:           true, # Must we acknowledge?
+  metrics:       Sapience.metrics,
+  heartbeat:     nil,
 )
-Sapience.logger.level = Logger::DEBUG

data/test_apps/rails/db/migrate/20160902141445_create_posts.rb

@@ -3,7 +3,13 @@ class CreatePosts < ActiveRecord::Migration[5.0]
     create_table :posts do |t|
       t.string :title
       t.string :body
-      t.belongs_to :author, foreign_key: true
+      t.belongs_to :author, foreign_key: {
+        to_table: :users,
+        column: :author_id,
+        name: :posts_author_fk,
+        on_delete: :cascade,
+        on_update: :restrict,
+      }
 
       t.timestamps
     end

data/test_apps/rails/db/schema.rb

@@ -12,13 +12,16 @@
 
 ActiveRecord::Schema.define(version: 20160902141445) do
 
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
   create_table "posts", force: :cascade do |t|
     t.string   "title"
     t.string   "body"
     t.integer  "author_id"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.index ["author_id"], name: "index_posts_on_author_id"
+    t.index ["author_id"], name: "index_posts_on_author_id", using: :btree
   end
 
   create_table "users", force: :cascade do |t|
@@ -26,8 +29,9 @@ ActiveRecord::Schema.define(version: 20160902141445) do
     t.string   "email"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.index ["email"], name: "users_email_key", unique: true
-    t.index ["username"], name: "users_username_key", unique: true
+    t.index ["email"], name: "users_email_key", unique: true, using: :btree
+    t.index ["username"], name: "users_username_key", unique: true, using: :btree
   end
 
+  add_foreign_key "posts", "users", column: "author_id", name: "posts_author_fk", on_update: :restrict, on_delete: :cascade
 end

data/test_apps/rails/lib/external_sneaker.rb

@@ -1,11 +1,11 @@
 require "timeout"
 
 class ExternalSneaker
-  attr_accessor :worker_pid, :start_command
+  attr_accessor :worker_pid, :start_command, :workers
 
-  def initialize(start_command)
+  def initialize(start_command, *workers)
     fail ArgumentError, "start_command was expected" if start_command.nil?
-
+    self.workers = workers.map(&:to_s).join(",")
     self.start_command = start_command
   end
 
@@ -23,7 +23,7 @@ class ExternalSneaker
   private
 
   def start_child
-    exec({ "RAILS_ENV" => Rails.env, "WORKERS" => "TestWorker" }, start_command)
+    exec({ "RAILS_ENV" => Rails.env, "WORKERS" => workers }, start_command)
   end
 
   def stop_child # rubocop:disable AbcSize

data/test_apps/rails/lib/tasks/sneakers.rake

@@ -0,0 +1,21 @@
+require "sneakers/runner"
+
+task :environment
+
+namespace :sneakers do
+  desc "Start processing jobs with all workers"
+  task work: :environment do
+    silence_warnings do
+      Rails.application.eager_load! unless Rails.application.config.eager_load
+    end
+
+    workers = ApplicationJob.subclasses.map do |klass|
+      klass.const_set("Wrapper", Class.new(ActiveJob::QueueAdapters::SneakersAdapter::JobWrapper) do
+        from_queue klass.queue_name
+      end)
+    end
+
+
+    Sneakers::Runner.new(workers).run
+  end
+end

data/test_apps/rails/spec/controllers/posts_controller_spec.rb

@@ -1,6 +1,6 @@
 require "rails_helper"
 
-RSpec.describe PostsController, type: :controller do
+describe PostsController, type: :controller do
   specify do
     expect(subject.logger).to be_a(Sapience::Logger)
   end

data/test_apps/rails/spec/fixtures/sapience.yml

@@ -7,6 +7,7 @@ default:
         formatter: default
 
 test:
+  app_name: rails_app
   log_level: fatal
   appenders:
     - stream:

data/test_apps/rails/spec/jobs/test_job_spec.rb

@@ -0,0 +1,36 @@
+require "rails_helper"
+require "serverengine"
+require "sneakers"
+require "sneakers/runner"
+require "external_sneaker"
+
+describe TestJob do
+  include FileHelper
+  include ActiveJob::TestHelper
+  let(:metrics) { Sapience.add_appender(:datadog) }
+  let(:tags) do
+    %w(name:test queue:test_queue)
+  end
+  let(:message) do
+    {
+      title: "Cool",
+      body: "Hot",
+    }
+  end
+  let(:logger) { Sapience[described_class] }
+
+  after do
+    delete_file("config/sapience.yml")
+    delete_file(described_class::VERIFICATION_FILE)
+  end
+
+  # TODO: Possible make this less flaky or run it with retry (rspec-retry)
+  it "runs properly" do
+    expect(metrics).to receive(:increment).with("activejob.perform", tags: tags)
+    expect(metrics).to receive(:timing).with("activejob.perform.time", kind_of(Float), tags: tags)
+
+    perform_enqueued_jobs do
+      TestJob.perform_later
+    end
+  end
+end

data/test_apps/rails/spec/models/post_spec.rb

@@ -1,5 +1,14 @@
 require "rails_helper"
 
 RSpec.describe Post, type: :model do
-  pending "add some examples to (or delete) #{__FILE__}"
+  let!(:metrics) { Sapience.add_appender(:datadog, app_name: "active_record") }
+  let(:tags) { %w(query:post.load) }
+
+  before(:each) {  create :post }
+
+  it "records som sql metrics" do
+    expect(metrics).to receive(:increment).with("activerecord.sql", tags: tags)
+    expect(metrics).to receive(:timing).with("activerecord.sql.time", kind_of(Float), tags: tags)
+    Post.first
+  end
 end

data/test_apps/rails/spec/rails_helper.rb

@@ -27,11 +27,14 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.filter_rails_from_backtrace!
   config.before(:each) do
-    Sapience.reset!
     FileUtils.cp(
       Rails.root.join("spec/fixtures/sapience.yml"),
       Rails.root.join("config/sapience.yml"),
     )
+    Sapience.reset!
+    Sapience.configure do |c|
+      c.app_name = "rails_app"
+    end
   end
 
   config.after(:each) do

data/test_apps/rails/spec/requests/posts_spec.rb

@@ -2,10 +2,43 @@ require "rails_helper"
 
 describe "Posts", type: :request do
   describe "GET /posts" do
-    it "works! (now write some real specs)" do
-      create :post
-      get posts_path
-      expect(response).to have_http_status(200)
+    describe "ActiveSupport::Notification" do
+      context "when metrics is configured" do
+        before do
+          # ActiveRecord::Base.logger = Logger.new(STDOUT)
+          Rails.logger.level = :debug
+          Sapience.add_appender(:datadog)
+          FactoryGirl.create_list(:post, 10)
+          allow_any_instance_of(Sapience::Extensions::ActiveRecord::Notifications)
+            .to receive(:record).and_return(true)
+        end
+
+        it "records a batch of metrics" do
+          expect(Sapience.metrics).to receive(:increment) do |metric_name, options|
+            expect(metric_name).to eq("rails.request")
+            expect(options[:tags]).to match_array(%w(method:get status:200 action:index controller:posts format:html))
+          end
+          expect(Sapience.metrics).to receive(:timing) do |metric_name, duration, options|
+            expect(metric_name).to eq("rails.request.time")
+            expect(duration).to be_a(Float).and be > 0
+            expect(options[:tags]).to match_array(%w(method:get status:200 action:index controller:posts format:html))
+          end
+
+          expect(Sapience.metrics).to receive(:timing) do |metric_name, duration, options|
+            expect(metric_name).to eq("rails.request.time.db")
+            expect(duration).to be_a(Float).and be > 0
+            expect(options[:tags]).to match_array(%w(method:get status:200 action:index controller:posts format:html))
+          end
+
+          expect(Sapience.metrics).to receive(:timing) do |metric_name, duration, options|
+            expect(metric_name).to eq("rails.request.time.view")
+            expect(duration).to be_a(Float).and be > 0
+            expect(options[:tags]).to match_array(%w(method:get status:200 action:index controller:posts format:html))
+          end
+
+          get posts_path
+        end
+      end
     end
   end
 end

data/test_apps/rails/spec/workers/test_worker_spec.rb

@@ -4,7 +4,7 @@ require "sneakers"
 require "sneakers/runner"
 require "external_sneaker"
 
-describe TestWorker, "This is manual labor as we can't verify that sneakers is running", :skip do
+describe TestWorker do
   include FileHelper
   let(:message) do
     {
@@ -12,12 +12,10 @@ describe TestWorker, "This is manual labor as we can't verify that sneakers is r
       body: "Hot",
     }
   end
-  let(:logger) { Sapience[described_class] }
 
   before do
-    @sneakers_worker = ExternalSneaker.new("rake sneakers:run")
+    @sneakers_worker = ExternalSneaker.new("rake sneakers:run", described_class)
     @sneakers_worker.start
-
     Sneakers.publish(
       message.to_json,
       to_queue: described_class::QUEUE_NAME,
@@ -30,7 +28,14 @@ describe TestWorker, "This is manual labor as we can't verify that sneakers is r
     delete_file(described_class::VERIFICATION_FILE)
   end
 
+  # TODO: Possible make this less flaky or run it with retry (rspec-retry)
   it "runs properly" do
-    wait(30.seconds).for { File.exist?(described_class::VERIFICATION_FILE) }.to eq(true)
+    count = 0
+    until File.exist?(described_class::VERIFICATION_FILE)
+      sleep 0.1
+      count += 1
+      expect(true).to be(false) if count > 240
+    end
+    expect(true).to be(true)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -289,14 +289,19 @@ files:
 - lib/sapience/extensions/action_cable/tagged_logger_proxy.rb
 - lib/sapience/extensions/action_controller/live.rb
 - lib/sapience/extensions/action_controller/log_subscriber.rb
+- lib/sapience/extensions/action_controller/notifications.rb
 - lib/sapience/extensions/action_dispatch/debug_exceptions.rb
 - lib/sapience/extensions/action_view/log_subscriber.rb
 - lib/sapience/extensions/action_view/streaming_template_renderer.rb
 - lib/sapience/extensions/active_job/logging.rb
+- lib/sapience/extensions/active_job/notifications.rb
 - lib/sapience/extensions/active_model_serializers/logging.rb
 - lib/sapience/extensions/active_record/log_subscriber.rb
+- lib/sapience/extensions/active_record/notifications.rb
 - lib/sapience/extensions/grape/middleware/logging.rb
+- lib/sapience/extensions/grape/notifications.rb
 - lib/sapience/extensions/grape/timings.rb
+- lib/sapience/extensions/notifications.rb
 - lib/sapience/extensions/rails/rack/logger.rb
 - lib/sapience/extensions/rails/rack/logger_info_as_debug.rb
 - lib/sapience/formatters/base.rb
@@ -353,6 +358,7 @@ files:
 - test_apps/rails/app/helpers/application_helper.rb
 - test_apps/rails/app/helpers/posts_helper.rb
 - test_apps/rails/app/jobs/application_job.rb
+- test_apps/rails/app/jobs/test_job.rb
 - test_apps/rails/app/mailers/application_mailer.rb
 - test_apps/rails/app/models/application_record.rb
 - test_apps/rails/app/models/concerns/.keep
@@ -404,6 +410,7 @@ files:
 - test_apps/rails/lib/assets/.keep
 - test_apps/rails/lib/external_sneaker.rb
 - test_apps/rails/lib/tasks/.keep
+- test_apps/rails/lib/tasks/sneakers.rake
 - test_apps/rails/public/404.html
 - test_apps/rails/public/422.html
 - test_apps/rails/public/500.html
@@ -417,6 +424,7 @@ files:
 - test_apps/rails/spec/fixtures/sapience.yml
 - test_apps/rails/spec/helpers/posts_helper_spec.rb
 - test_apps/rails/spec/integration/sapience_spec.rb
+- test_apps/rails/spec/jobs/test_job_spec.rb
 - test_apps/rails/spec/models/post_spec.rb
 - test_apps/rails/spec/models/user_spec.rb
 - test_apps/rails/spec/rails_helper.rb