chillout 0.6.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 197e690562925f6ce9309e2545460a42280ca5d9
+  data.tar.gz: d130742ff61be6f59e38a2f389bc424f66feeeac
+SHA512:
+  metadata.gz: 1929db6e6dcc8816f58cd33760443bda3b3c201f10f207808ceb26cc4307919e67c73d7cb3d1852e05eae6f41366563f1fdaf3f3b0db568c3fc6e409e9b3630a
+  data.tar.gz: ca1ba2c6c1e335394f303e506636a8d2bfb0126e81b366145eec930780746ad464fe3fbc67491197267e79b0d61952cafeb7ece3bbfd3c1dd94562d5949b8d5a

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 .rbx
+database.db
+log/
+tmp/

data/.travis.yml

@@ -1,11 +1,47 @@
+before_script: bundle exec rake bundle
+script: bundle exec rake test
 language: ruby
 rvm:
-  - 2.0.0-p0
-  - 1.9.3
-  - 1.9.2
-  - 1.8.7
-  - ree
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+- 2.4.1
+- 2.3.4
+- 2.2.7
+- 2.1.10
+env:
+- SAMPLE_APP=rails_4_0_0
+- SAMPLE_APP=rails_4_0_13
+- SAMPLE_APP=rails_4_1_0
+- SAMPLE_APP=rails_4_1_16
+- SAMPLE_APP=rails_4_2_0
+- SAMPLE_APP=rails_4_2_8
+- SAMPLE_APP=rails_5_0_3
+- SAMPLE_APP=rails_5_1_1 SIDEKIQ_SUPPORTED=true
+matrix:
+  exclude:
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_0_0
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_0_13
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_1_0
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_1_16
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_2_0
+  - rvm: 2.1.10
+    env: SAMPLE_APP=rails_4_2_8
+  - rvm: 2.1.10
+    env: SAMPLE_APP=rails_5_0_3
+  - rvm: 2.1.10
+    env: SAMPLE_APP=rails_5_1_1 SIDEKIQ_SUPPORTED=true
+  include:
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_2_8 STRATEGY=active_job
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_5_0_3 STRATEGY=active_job
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_5_1_1 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
+notifications:
+  slack:
+    secure: 6IAlvKplFv94Vaf0LES197FFIgt5cs1fUFA9820mmeoTGLDQcN+4Hpv+2/NRRqrfb2k+V+uFKmsuY8azHBoKHLIzH6d1T0NS82j54Ti+tm0iFZaKLHVp8TxuIge0/e0Niamod5mMziLTg6KcM+zNBYcoxS3th1mQNWQ2mtD9JZ8=
+services:
+  - redis-server

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# chillout gem changes
+
+0.8.0
+-----
+
+- Introduce `active_job` strategy for sending metrics to chillout servers
+- Add `sidekiq` integration. Metrics collected when processing sidekiq jobs are sent to the server
+- Support for Mongoid removed.
+
+0.7.0 (never released)
+----------------------
+
+- Support for custom metrics
+- Support for Mongoid

data/Gemfile

@@ -1,4 +1,12 @@
 source 'https://rubygems.org'
 
+gem "bbq-spawn", git: 'https://github.com/drugpl/bbq-spawn.git'
+
 # Specify your gem's dependencies in chillout.gemspec
 gemspec
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2')
+  gem "rack", "1.6"
+  gem "activejob", "= 4.2.8"
+  gem "sidekiq", "~> 4.2"
+end

data/README.md

@@ -4,9 +4,11 @@
 [![Code Climate](https://codeclimate.com/github/chilloutio/chillout.png)](https://codeclimate.com/github/chilloutio/chillout)
 [![Gem Version](https://badge.fury.io/rb/chillout.png)](http://badge.fury.io/rb/chillout)
 
+Chillout gem tracks your ActiveRecord models statistics. You can see the metrics for your application in a grafana dashboard. Please visit [get.chillout.io](http://get.chillout.io/) for more details.
+
 ## Installation
 
-Add this line to your Rails application's Gemfile:
+Add this line to your Rails application's `Gemfile`:
 
     gem 'chillout'
 
@@ -14,14 +16,48 @@ And then execute:
 
     $ bundle
 
-And run Rails generator:
+And add following line to `config/environments/production.rb` with your own `SECRET_KEY`:
+
+    config.chillout = { secret: 'SECRET_KEY' }
+
+And that's all!
+
+## Usage
+
+chillout gem is automatically tracking your model creations. Remember you have to be in `production` environment - otherwise chillout gem will NOT track your metrics.
+
+### Custom metrics
+
+You can use `Chillout::Metric.track('custom_name')` to track a custom, phony metric. It's quite useful when you want to track a certain business process, like:
+
+```
+# in 'new':
+Chillout::Metric.track('RegistrationStarted')
+
+# in 'create':
+Chillout::Metric.track('RegistrationCompleted')
+```
+
+We encourage you to ship your own class (Adapter) which encapsulates this global constant and it's closer to your application's domain.
+
+## Different strategy
+
+By default chillout uses a background thread to send metrics in a non-blocking way. However, if you prefer it can use `active_job` and the adapter you configured for it ie. sidekiq, resque, delayed_job, etc.
+
+```ruby
+config.chillout = {secret: 'secret', strategy: :active_job}
+```
+
+This feature is available since Rails 4.2
 
-    $ rails g chillout:install EMAIL EMAIL2...
+## Compatibility
 
-And that's all! You can find whole configuration in config/environments/production.rb under ```chillout``` key.
+Chillout gem is tested using Travis CI. You can [check it](https://travis-ci.org/chilloutio/chillout) to get insight about which versions of Rails and Rubies are actually supported. We provide listeners for ActiveRecord.
 
-Check if everything is ok:
+## Development
 
-    $ RAILS_ENV=production rake chillout:check
+Running complete test suite:
 
-You'll see "Chillout API available" if everything is ok. Otherwise you'll be informed about problem with authorization (maybe you've put wrong secret?) or not known problems, like invalid values in configuration.
+    bundle install
+    bundle exec rake bundle
+    bundle exec rake test

data/Rakefile

@@ -1,10 +1,25 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-task :default => :test
 
-desc 'Run chillout unit tests.'
+SAMPLE_APPS = Dir.glob(File.join(File.dirname(__FILE__), 'test/support/rails_*'))
+
+desc 'Install test dependencies.'
+task :bundle do
+  sample_apps = if sample_app = ENV['SAMPLE_APP']
+    [ File.join(File.dirname(__FILE__), "test/support/#{sample_app}") ]
+  else
+    SAMPLE_APPS
+  end
+  sample_apps.each do |path|
+    Bundler.clean_system "bundle install --quiet --gemfile #{File.join(path, 'Gemfile')}"
+  end
+end
+
+desc 'Run chillout tests.'
 Rake::TestTask.new(:test) do |t|
   t.libs    = %w(lib test)
   t.pattern = 'test/**/*_test.rb'
 end
+
+task :default => :test

data/chillout.gemspec

@@ -6,11 +6,17 @@ require 'chillout/version'
 Gem::Specification.new do |gem|
   gem.name          = "chillout"
   gem.version       = Chillout::VERSION
-  gem.authors       = ["Michał Łomnicki", "Jan Filipowski", "Paweł Pacana"]
-  gem.email         = ["michal.lomnicki@gmail.com", "jachuf@gmail.com", "pawel.pacana@gmail.com", "dev@arkency.com"]
-  gem.description   = "Chillout.io Ruby client"
+  gem.authors       = ["Michał Łomnicki", "Jan Filipowski", "Paweł Pacana", "Robert Pankowecki"]
+  gem.email         = [
+    "michal.lomnicki@gmail.com",
+    "jachuf@gmail.com",
+    "pawel.pacana@gmail.com",
+    "dev@arkency.com",
+    "robert.pankowecki@gmail.com"
+  ]
+  gem.description   = "Chillout gem tracks your ActiveRecord models statistics."
   gem.summary       = "Chillout.io Ruby client"
-  gem.homepage      = "http://chillout.io/"
+  gem.homepage      = "http://get.chillout.io/"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,10 +25,15 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'multi_json', '~> 1.4'
 
-  gem.add_development_dependency "minitest", "~>3.2.0"
-  gem.add_development_dependency "rake",  "~> 0.9.2"
-  gem.add_development_dependency "mocha", "0.12.8"
-  gem.add_development_dependency "contest", "~> 0.1.3"
-  gem.add_development_dependency "rack-test", "~> 0.6.2"
-  gem.add_development_dependency "webmock", "~> 1.8.11"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest",     "~> 5.1"
+  gem.add_development_dependency "mocha",        "~> 0.14"
+  gem.add_development_dependency "rack-test",    "~> 0.6"
+  gem.add_development_dependency "rack",         ">= 1.6"
+  gem.add_development_dependency "webmock",      "~> 2.3"
+  gem.add_development_dependency "bbq-spawn",    "= 0.0.3"
+  gem.add_development_dependency "childprocess", "= 0.3.6"
+  gem.add_development_dependency "minitest-stub-const", "~> 0.6"
+  gem.add_development_dependency "activejob", ">= 4.2"
+  gem.add_development_dependency "sidekiq"
 end

data/lib/chillout/client.rb

@@ -30,14 +30,35 @@ module Chillout
       @event_data_builder = EventDataBuilder.new(@config).freeze
       @server_side = ServerSide.new(@event_data_builder, @http_client).freeze
       @dispatcher = Dispatcher.new(@server_side).freeze
-      @queue = Queue.new
-      @worker_mutex = Mutex.new
+      case @config.strategy
+      when :thread
+        @queue = Queue.new
+        @worker_mutex = Mutex.new
+        @worker_thread = nil
+      when :active_job
+        require 'chillout/job'
+        Chillout::Job.dispatcher = @dispatcher
+      end
+    end
+
+    def start
+      case @config.strategy
+      when :thread
+        start_worker
+      when :active_job
+      end
     end
 
     def enqueue(creations)
-      start_worker
-      @logger.info "Creations were enqueued."
-      @queue << creations
+      case @config.strategy
+      when :thread
+        start_worker
+        @logger.debug "Creations were enqueued."
+        @queue << creations
+      when :active_job
+        @logger.debug "Creations were enqueued."
+        Chillout::Job.perform_later(YAML.dump(creations))
+      end
     end
 
     def worker_running?

data/lib/chillout/config.rb

@@ -22,6 +22,7 @@ module Chillout
     attr_writer   :authentication_password
     attr_accessor :logger
     attr_accessor :ssl
+    attr_reader   :strategy
 
     def initialize(api_key = nil)
       @api_key = api_key
@@ -32,6 +33,10 @@ module Chillout
       @version = VERSION
       @logger = Logger.new(STDOUT)
       @ssl = true
+      @strategy = :thread
+
+      @authentication_user = nil
+      @authentication_password = nil
     end
 
     def update(options)
@@ -40,6 +45,16 @@ module Chillout
       end
     end
 
+    def strategy=(name)
+      name = name.to_sym
+      precondition = {
+        active_job: -> { defined?(ActiveJob) or raise ArgumentError, "ActiveJob is not enabled" },
+        thread: -> {},
+      }.fetch(name, -> { raise ArgumentError, "unknown strategy" })
+      precondition.call
+      @strategy = name
+    end
+
     def authentication_user
       @authentication_user || api_key
     end

data/lib/chillout/creation_listener.rb

@@ -1,16 +1,21 @@
 require 'chillout/creations_container'
 
 module Chillout
-  module CreationListener
+  module ActiveRecordCreationListener
     def inherited(subclass)
       super
-      class_name = subclass.name
-      subclass.after_commit :on => :create do
-        Rails.logger.info "[Chillout] Model created: #{class_name}"
+      listen(subclass)
+    end
+
+    private
+    def listen(monitored_class)
+      class_name = monitored_class.name
+      monitored_class.after_commit :on => :create do
+        Rails.logger.debug "[Chillout] Model created: #{class_name}"
         Thread.current[:creations] ||= CreationsContainer.new
         creations = Thread.current[:creations]
         creations.increment!(class_name)
       end
     end
   end
-end
+end

data/lib/chillout/custom_metric.rb

@@ -0,0 +1,27 @@
+require 'chillout/creations_container'
+
+module Chillout
+  class CustomMetric
+    def initialize(creations_container = nil)
+      @creations_container = creations_container
+    end
+
+    def track(name)
+      creations_container.increment!(name)
+    end
+   
+    private
+    def creations_container
+      if container_not_initialized?
+        Thread.current[:creations] ||= CreationsContainer.new
+        @creations_container = Thread.current[:creations]
+      else
+        @creations_container
+      end
+    end
+
+    def container_not_initialized?
+      @creations_container.nil?
+    end
+  end
+end

data/lib/chillout/integrations/sidekiq.rb

@@ -0,0 +1,22 @@
+module Chillout
+  module Integrations
+
+    class Sidekiq
+      def available?
+        defined?(::Sidekiq) && ::Sidekiq.server?
+      end
+
+      def enable(client, a_module = ::Sidekiq)
+        require 'chillout/middleware/sidekiq'
+        @module = a_module
+        @module.server_middleware.add Middleware::SidekiqCreationsMonitor,
+          client: client
+      end
+
+      def disable
+        @module.server_middleware.clear
+      end
+    end
+
+  end
+end

data/lib/chillout/job.rb

@@ -0,0 +1,12 @@
+class Chillout::Job < ActiveJob::Base
+  queue_as :chillout
+
+  class << self
+    attr_accessor :dispatcher
+  end
+
+  def perform(serialized_metrics)
+    metrics = YAML.load(serialized_metrics)
+    self.class.dispatcher.send_creations(metrics)
+  end
+end

data/lib/chillout/listener_injector.rb

@@ -0,0 +1,23 @@
+module Chillout
+  class ListenerInjector
+    attr_accessor :logger
+
+    LISTENERS = [:active_record]
+
+    def inject!
+      LISTENERS.each do |listener|
+        listener_injection = send("#{listener}_injector") 
+        logger.info "[Chillout] Injected #{listener} listener" if listener_injection == true
+      end            
+    end
+
+    def active_record_injector
+      if defined?(ActiveRecord)
+        ActiveRecord::Base.extend(ActiveRecordCreationListener)
+        return true
+      end
+
+      return false
+    end
+  end
+end

data/lib/chillout/middleware/creations_monitor.rb

@@ -15,7 +15,7 @@ module Chillout
         return status, headers, body
       ensure
         if Thread.current[:creations]
-          @client.logger.info "Non-empty creations container found"
+          @client.logger.debug "Non-empty creations container found"
           @client.enqueue(Thread.current[:creations])
           Thread.current[:creations] = nil
         end

data/lib/chillout/middleware/sidekiq.rb

@@ -0,0 +1,21 @@
+module Chillout
+  module Middleware
+
+    class SidekiqCreationsMonitor
+      def initialize(options)
+        @client = options.fetch(:client)
+      end
+
+      def call(_worker, _job, _queue)
+        yield
+      ensure
+        if Chillout.creations
+          creations = Chillout.creations
+          Chillout.creations = nil
+          @client.enqueue(creations)
+        end
+      end
+    end
+
+  end
+end

data/lib/chillout/railtie.rb

@@ -1,12 +1,15 @@
 require 'chillout/creation_listener'
+require 'chillout/listener_injector'
 
 module Chillout
   class Railtie < Rails::Railtie
     config.chillout = ActiveSupport::OrderedOptions.new
     initializer "chillout.creations_listener_initialization" do |rails_app|
       chillout_config = rails_app.config.chillout
-      if !chillout_config.empty?
+      if chillout_config.present?
         RailsInitializer.new(rails_app, chillout_config, Rails.logger).start
+      else
+        Rails.logger.debug "[Chillout] Not enabled for #{Rails.env}"
       end
     end
 
@@ -27,26 +30,21 @@ module Chillout
       @rails_logger = rails_logger
     end
 
-    def start
+    def start(listeners_injector = ListenerInjector.new)
+      listeners_injector.logger = @rails_logger
+
       @rails_logger.info "[Chillout] Railtie initializing"
       client = Client.new(@chillout_config[:secret], options)
-      ActiveRecord::Base.extend(CreationListener)
-      @rails_logger.info "[Chillout] Creation listener attached"
+      listeners_injector.inject!
       @rails_app.middleware.use Middleware::CreationsMonitor, client
       @rails_logger.info "[Chillout] Creation monitor enabled"
-      client.start_worker
+      sidekiq = Integrations::Sidekiq.new
+      sidekiq.enable(client) if sidekiq.available?
+      client.start
     end
 
     def options
-      Hash[options_list].merge(:logger => @rails_logger)
-    end
-
-    def options_list
-      existing_option_keys.map{|key| [key, @chillout_config[key]]}
-    end
-
-    def existing_option_keys
-      [:port, :hostname, :ssl].select{|key| @chillout_config.has_key?(key)}
+      {logger: @rails_logger}.merge(@chillout_config).except(:secret)
     end
 
   end

data/lib/chillout/server_side/dispatcher.rb

@@ -22,7 +22,7 @@ module Chillout
 
     def send_startup_message
       @server_side.send_startup_message
-    rescue HttpClient::NotReceived => e
+    rescue HttpClient::NotReceived
     end
   end
 end

data/lib/chillout/server_side/plain_http_client.rb

@@ -22,12 +22,32 @@ module Chillout
       end
     end
 
+    attr_reader :host, :port, :ssl
+
+    def initialize
+      @host = if ENV['CHILLOUT_CLIENT_HOST']
+        ENV['CHILLOUT_CLIENT_HOST']
+      else
+        "api.chillout.io"
+      end
+      @port = if ENV['CHILLOUT_CLIENT_PORT']
+        ENV['CHILLOUT_CLIENT_PORT'].to_i
+      else
+        443
+      end
+      @ssl = if ENV['CHILLOUT_CLIENT_SSL']
+        ENV['CHILLOUT_CLIENT_SSL'] == 'true'
+      else
+        true
+      end
+    end
+
     MEDIA_TYPE = "application/vnd.chillout.v1+json"
 
     def post(path, data)
       begin
-        http = Net::HTTP.new("api.chillout.io", 443)
-        http.use_ssl = true
+        http = Net::HTTP.new(host, port)
+        http.use_ssl = ssl
         request_spec = Net::HTTP::Post.new(path)
         request_spec.body = MultiJson.dump(data)
         request_spec.content_type = MEDIA_TYPE

data/lib/chillout/version.rb

@@ -1,3 +1,3 @@
 module Chillout
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/chillout/worker.rb

@@ -10,9 +10,9 @@ module Chillout
     end
 
     def get_all_containers_to_process
-      logger.info "Waiting for at least one container."
+      logger.debug "Waiting for at least one container."
       all_containers = [queue.pop]
-      logger.info "Received at least one container."
+      logger.debug "Received at least one container."
       loop do
         begin
           all_containers << queue.pop(true)
@@ -20,7 +20,7 @@ module Chillout
           break
         end
       end
-      logger.info "Received containers to process: #{all_containers.count}"
+      logger.debug "Received containers to process: #{all_containers.count}"
       all_containers
     end
 
@@ -33,7 +33,7 @@ module Chillout
     end
 
     def send_creations(creations_container)
-      logger.info "Trying to send creations"
+      logger.debug "Trying to send creations"
       dispatcher.send_creations(creations_container)
       logger.info "Metrics sent"
     rescue Dispatcher::SendCreationsFailed
@@ -43,7 +43,7 @@ module Chillout
 
     def send_startup_message
       dispatcher.send_startup_message
-      logger.info "Sending startup message"
+      logger.debug "Sending startup message"
     end
 
     def run

data/lib/chillout.rb

@@ -1,12 +1,23 @@
 require "chillout/version"
 require "chillout/config"
 require "chillout/middleware/creations_monitor"
+require "chillout/integrations/sidekiq"
 require "chillout/server_side/dispatcher"
 require "chillout/server_side/server_side"
 require "chillout/server_side/http_client"
+require "chillout/custom_metric"
 require "chillout/client"
 
 module Chillout
+  Metric = CustomMetric.new
+
+  def self.creations
+    Thread.current[:creations]
+  end
+
+  def self.creations=(val)
+    Thread.current[:creations] = val
+  end
 end
 
 require 'chillout/railtie' if defined?(Rails)

data/test/acceptance/client_sends_metrics_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class ClientSendsMetricsTest < AcceptanceTestCase
+
+  def test_client_sends_metrics
+    test_app      = TestApp.new
+    test_endpoint = TestEndpoint.new
+    test_user     = TestUser.new
+
+    test_endpoint.listen
+    test_app.boot
+    if ENV['STRATEGY'] != 'active_job'
+      assert test_endpoint.has_received_information_about_startup
+    end
+    test_user.create_entity('Myrmecophagidae')
+    assert test_endpoint.has_one_creation_for_entity_resource
+  ensure
+    test_app.shutdown if test_app
+  end
+
+end