chillout 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed69970f8a13178646f300c5a13213e7642fe3df
-  data.tar.gz: d51d4ea537f831f0c499738bce7b2ceb2cc293f2
+  metadata.gz: 8423a0fd777360d79146e8270eeb5536f6132e4f
+  data.tar.gz: 1a2b4337e6ab9d2b62a13a111788f33b192d23a1
 SHA512:
-  metadata.gz: 848763fd9423900ff683bc4a88ec906dda4fc01233ba64c420f5c45a4aa93690e5ed40704801d0d4b549b9d381f67672fd18025c03994dc822cd86161a09ac4a
-  data.tar.gz: 9a12a1bcdb467d51aa95c939b18b129a44e783ca6a3779c75d46d837a42a8b497253911b83bf8df43b482d5198a41f2f451daf1bc5286f853852129eb1f198f3
+  metadata.gz: 952cbad057b400710e7af9ed61e3f012476f673a3f5d6b4733b09f30d50a950517d42d1c24154a4c8cce1746a19cc63f623e23bdd2b7a54a5a5a594ce12a4d4f
+  data.tar.gz: edde4d6c71087cc05108310b764aedc3bed7e10b390f87f49506b7a9698955b2c0ebad3c642d2d120de7f596dc46b2439a90a5344bf780b4c11b76937d3daab1

data/.travis.yml

@@ -26,18 +26,18 @@ matrix:
   - rvm: 2.4.1
     env: SAMPLE_APP=rails_4_1_16
   - rvm: 2.4.1
-    env: SAMPLE_APP=rails_4_2_0
+    env: SAMPLE_APP=rails_4_2_0 SIDEKIQ_SUPPORTED=true
   - rvm: 2.1.10
-    env: SAMPLE_APP=rails_4_2_8
+    env: SAMPLE_APP=rails_4_2_8 SIDEKIQ_SUPPORTED=true
   - rvm: 2.1.10
-    env: SAMPLE_APP=rails_5_0_3
+    env: SAMPLE_APP=rails_5_0_3 SIDEKIQ_SUPPORTED=true
   - 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
+    env: SAMPLE_APP=rails_4_2_8 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
   - rvm: 2.4.1
-    env: SAMPLE_APP=rails_5_0_3 STRATEGY=active_job
+    env: SAMPLE_APP=rails_5_0_3 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
   - rvm: 2.4.1
     env: SAMPLE_APP=rails_5_1_1 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
 notifications:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # chillout gem changes
 
+0.8.3
+-----
+
+- Introduced ActionController performance tracking.
+- Added ability to disabled automatic ActiveRecord creations tracking by passing `creations_tracking: false` via config.
+- Added ability to disabled automatic ActionController performance tracking by passing `requests_tracking: false` via config.
+
 0.8.2
 -----
 

data/lib/chillout/client.rb

@@ -3,7 +3,6 @@ require 'chillout/server_side/server_side'
 require 'chillout/server_side/http_client'
 require 'chillout/server_side/dispatcher'
 require 'chillout/config'
-require 'chillout/event_data_builder'
 require 'chillout/prefixed_logger'
 require 'chillout/worker'
 require 'chillout/check_result'
@@ -27,14 +26,14 @@ module Chillout
       @logger = PrefixedLogger.new("Chillout", @config.logger)
 
       @http_client = HttpClient.new(@config, logger).freeze
-      @event_data_builder = EventDataBuilder.new(@config).freeze
-      @server_side = ServerSide.new(@event_data_builder, @http_client).freeze
+      @server_side = ServerSide.new(@config, @http_client).freeze
       @dispatcher = Dispatcher.new(@server_side).freeze
       case @config.strategy
       when :thread
         @queue = Queue.new
         @worker_mutex = Mutex.new
         @worker_thread = nil
+        @max_queue = config.max_queue
       when :active_job
         require 'chillout/job'
         Chillout::Job.dispatcher = @dispatcher
@@ -49,15 +48,19 @@ module Chillout
       end
     end
 
-    def enqueue(creations)
+    def enqueue(metrics)
       case @config.strategy
       when :thread
         start_worker
-        @logger.debug "Creations were enqueued."
-        @queue << creations
+        if @queue.size < @max_queue
+          @queue << metrics
+          @logger.debug "Metrics were enqueued."
+        else
+          @logger.error "Metrics buffer overflow. Skipping enqueue."
+        end
       when :active_job
-        @logger.debug "Creations were enqueued."
-        Chillout::Job.perform_later(YAML.dump(creations))
+        Chillout::Job.perform_later(YAML.dump(metrics))
+        @logger.debug "Metrics were enqueued."
       end
     end
 
@@ -70,7 +73,7 @@ module Chillout
       @worker_mutex.synchronize do
         return if worker_running?
         @worker_thread = Thread.new do
-          worker = Worker.new(@dispatcher, @queue, @logger)
+          worker = Worker.new(@max_queue, @dispatcher, @queue, @logger)
           worker.run
         end
       end

data/lib/chillout/config.rb

@@ -17,15 +17,18 @@ module Chillout
     attr_accessor :platform
     attr_accessor :hostname
     attr_accessor :port
-    attr_accessor :api_key
+    attr_reader   :api_key
     attr_writer   :authentication_user
     attr_writer   :authentication_password
     attr_accessor :logger
     attr_accessor :ssl
     attr_reader   :strategy
+    attr_accessor :max_queue
+    attr_accessor :creations_tracking
+    attr_accessor :requests_tracking
 
-    def initialize(api_key = nil)
-      @api_key = api_key
+    def initialize(api_key = '')
+      self.api_key = api_key
       @hostname = DEFAULT_HOSTNAME
       @port = DEFAULT_PORT
       @notifier_name = DEFAULT_NOTIFIER_NAME
@@ -34,6 +37,9 @@ module Chillout
       @logger = Logger.new(STDOUT)
       @ssl = true
       @strategy = :thread
+      @max_queue = 5_000
+      @creations_tracking = true
+      @requests_tracking = true
 
       @authentication_user = nil
       @authentication_password = nil
@@ -45,6 +51,18 @@ module Chillout
       end
     end
 
+    def api_key=(value)
+      if String === value
+        @api_key = value
+      else
+        raise ArgumentError.new("Invalid config passed")
+      end
+    end
+
+    def secret=(value)
+      self.api_key = value
+    end
+
     def strategy=(name)
       name = name.to_sym
       precondition = {

data/lib/chillout/creations_container.rb

@@ -18,6 +18,10 @@ module Chillout
       name.to_sym
     end
 
+    def each(&proc)
+      @container.each(&proc)
+    end
+
     def resource_keys
       @container.keys
     end
@@ -27,5 +31,27 @@ module Chillout
         increment!(key, other_container[key])
       end
     end
+
+    def ==(other)
+      self.class == other.class &&
+      @container == other.instance_variable_get(:@container)
+    end
+
+    def empty?
+      @container.empty?
+    end
+
+    def as_measurements(timestamp = Time.now)
+      iso_timestamp = timestamp.iso8601
+      @container.each.map do |model_name, value|
+        {
+          series: model_name.to_s,
+          tags: {},
+          timestamp: iso_timestamp,
+          values: { creations: value },
+        }
+      end
+    end
+
   end
 end

data/lib/chillout/job.rb

@@ -5,8 +5,8 @@ class Chillout::Job < ActiveJob::Base
     attr_accessor :dispatcher
   end
 
-  def perform(serialized_metrics)
-    metrics = YAML.load(serialized_metrics)
-    self.class.dispatcher.send_creations(metrics)
+  def perform(serialized_metric)
+    measurement = YAML.load(serialized_metric)
+    self.class.dispatcher.send_measurements([measurement])
   end
 end

data/lib/chillout/railtie.rb

@@ -34,17 +34,34 @@ module Chillout
       listeners_injector.logger = @rails_logger
 
       @rails_logger.info "[Chillout] Railtie initializing"
-      client = Client.new(@chillout_config[:secret], options)
-      listeners_injector.inject!
+      config = build_config(options)
+      client = Client.new(config)
+      if config.creations_tracking
+        listeners_injector.inject!
+        @rails_logger.info "[Chillout] Creation monitor enabled"
+      end
       @rails_app.middleware.use Middleware::CreationsMonitor, client
-      @rails_logger.info "[Chillout] Creation monitor enabled"
+
       sidekiq = Integrations::Sidekiq.new
       sidekiq.enable(client) if sidekiq.available?
+
+      if config.requests_tracking
+        @rails_logger.info "[Chillout] Requests monitor enabled"
+        Subscribers::ActionControllerNotifications.new.enable(client)
+      end
       client.start
     end
 
+    private
+
     def options
-      {logger: @rails_logger}.merge(@chillout_config).except(:secret)
+      {logger: @rails_logger}.merge(@chillout_config)
+    end
+
+    def build_config(options)
+      config = Config.new
+      config.update(options)
+      config
     end
 
   end

data/lib/chillout/server_side/dispatcher.rb

@@ -7,8 +7,8 @@ module Chillout
       @server_side = server_side
     end
 
-    def send_creations(creations)
-      @server_side.send_creations(creations)
+    def send_measurements(measurements)
+      @server_side.send_measurements(measurements)
     rescue HttpClient::NotSent
       raise SendCreationsFailed.new
     end

data/lib/chillout/server_side/server_side.rb

@@ -1,17 +1,22 @@
 require 'time'
-require 'chillout/event_data_builder'
 
 module Chillout
   class ServerSide
 
-    def initialize(event_data_builder, http_client)
+    def initialize(config, http_client)
       @http_client = http_client
-      @event_data_builder = event_data_builder
+      @config = config
     end
 
-    def send_creations(creations_container)
-      event_data = @event_data_builder.build_from_creations_container(creations_container, timestamp)
-      send_metric(event_data)
+    def send_measurements(measurements)
+      send_metric(
+        :measurements => measurements.map(&:as_measurements).flatten,
+        :notifier => {
+          name:    @config.notifier_name,
+          version: @config.version,
+          url:     @config.notifier_url,
+        }
+      )
     end
 
     def send_metric(data)
@@ -28,9 +33,5 @@ module Chillout
       })
     end
 
-    private
-      def timestamp
-        Time.now.iso8601
-      end
   end
-end
+end

data/lib/chillout/subscribers/action_controller_notifications.rb

@@ -0,0 +1,49 @@
+module Chillout
+  module Subscribers
+    class ActionControllerNotifications
+
+      class RequestMetric
+        def initialize(event)
+          @end      = event.end
+          @duration = event.duration
+          @payload  = event.payload.except(:headers)
+        end
+
+        def as_measurements()
+          format = (payload[:format] || "all").to_s
+          format = "all" if format == "*/*"
+
+          [{
+             series: "request",
+             tags: {
+               controller: payload[:controller],
+               action:     payload[:action],
+               format:     format,
+               method:     payload[:method],
+               status:     payload[:status],
+             },
+             timestamp: self.end.iso8601,
+             values: {
+               finished: 1,
+               duration: duration,
+               db:    payload[:db_runtime]   || 0,
+               view:  payload[:view_runtime] || 0,
+             },
+           }]
+        end
+
+        attr_reader :end, :duration, :payload
+      end
+
+      def enable(client)
+        name = "process_action.action_controller"
+        ActiveSupport::Notifications.subscribe(name) do |*args|
+          event  = ActiveSupport::Notifications::Event.new(*args)
+          metric = RequestMetric.new(event)
+          client.enqueue(metric)
+        end
+      end
+
+    end
+  end
+end

data/lib/chillout/version.rb

@@ -1,3 +1,3 @@
 module Chillout
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/lib/chillout/worker.rb

@@ -2,7 +2,8 @@ module Chillout
   class Worker
     attr_reader :dispatcher, :queue, :logger
 
-    def initialize(dispatcher, queue, logger, container_class=CreationsContainer)
+    def initialize(max_queue, dispatcher, queue, logger, container_class=CreationsContainer)
+      @max_queue = max_queue
       @dispatcher = dispatcher
       @queue = queue
       @logger = logger
@@ -13,7 +14,7 @@ module Chillout
       logger.debug "Waiting for at least one container."
       all_containers = [queue.pop]
       logger.debug "Received at least one container."
-      loop do
+      (@max_queue-1).times do
         begin
           all_containers << queue.pop(true)
         rescue ThreadError
@@ -25,19 +26,20 @@ module Chillout
     end
 
     def merge_containers(containers_to_merge)
+      mergable, unmergable = containers_to_merge.partition{|cont| @container_class === cont }
       creations_container = @container_class.new
-      for container in containers_to_merge
+      mergable.each do |container|
         creations_container.merge(container)
       end
-      creations_container
+      unmergable.unshift(creations_container) unless creations_container.empty?
+      unmergable
     end
 
-    def send_creations(creations_container)
+    def send_measurements(measurements)
       logger.debug "Trying to send creations"
-      dispatcher.send_creations(creations_container)
+      dispatcher.send_measurements(measurements)
       logger.info "Metrics sent"
     rescue Dispatcher::SendCreationsFailed
-      queue << creations_container
       logger.error "Sending metrics failed"
     end
 
@@ -51,10 +53,11 @@ module Chillout
       send_startup_message
       loop do
         containers_to_merge = get_all_containers_to_process
-        creations_container = merge_containers(containers_to_merge)
-        send_creations(creations_container)
+        measurements = merge_containers(containers_to_merge)
+        send_measurements(measurements)
         sleep 5
       end
     end
+
   end
-end
+end

data/lib/chillout.rb

@@ -2,6 +2,7 @@ require "chillout/version"
 require "chillout/config"
 require "chillout/middleware/creations_monitor"
 require "chillout/integrations/sidekiq"
+require "chillout/subscribers/action_controller_notifications"
 require "chillout/server_side/dispatcher"
 require "chillout/server_side/server_side"
 require "chillout/server_side/http_client"

data/test/acceptance/client_sends_controller_performance_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class ClientSendsControllerPerformanceTest < AcceptanceTestCase
+
+  def test_client_sends_controller_metrics
+    test_app      = TestApp.new
+    test_endpoint = TestEndpoint.new(port: 8082)
+    test_user     = TestUser.new
+
+    test_endpoint.listen
+    test_app.boot(chillout_port: 8082)
+    if ENV['STRATEGY'] != 'active_job'
+      assert test_endpoint.has_received_information_about_startup
+    end
+    test_user.create_entity('Myrmecophagidae')
+    assert request = test_endpoint.has_one_controller_metric
+
+    assert_equal "request", request["series"]
+    assert_equal "EntitiesController", request["tags"]["controller"]
+    assert_equal "create", request["tags"]["action"]
+    assert_equal "all", request["tags"]["format"]
+    assert_equal "POST", request["tags"]["method"]
+    assert_equal 302, request["tags"]["status"]
+
+    assert_equal 1, request["values"]["finished"]
+    assert_operator 0, :<, request["values"]["duration"]
+    assert_operator 0, :<, request["values"]["db"]
+    assert_equal 0, request["values"]["view"]
+  ensure
+    test_app.shutdown if test_app
+  end
+
+end

data/test/acceptance/client_sends_metrics_test.rb

@@ -4,16 +4,18 @@ class ClientSendsMetricsTest < AcceptanceTestCase
 
   def test_client_sends_metrics
     test_app      = TestApp.new
-    test_endpoint = TestEndpoint.new
+    test_endpoint = TestEndpoint.new(port: 8080)
     test_user     = TestUser.new
 
     test_endpoint.listen
-    test_app.boot
+    test_app.boot(chillout_port: 8080)
     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
+    assert creation = test_endpoint.has_one_creation_for_entity_resource
+    assert_equal "Entity", creation["series"]
+    assert_equal 1, creation["values"]["creations"]
   ensure
     test_app.shutdown if test_app
   end

data/test/client_test.rb

@@ -37,4 +37,17 @@ class ClientTest < ChilloutTestCase
     end
   end
 
-end
+  def test_enqueues_up_to_5K_metrics
+    client = Chillout::Client.new("xyz")
+    client.queue.expects(:size).returns(4999)
+    client.queue.expects(:<<).returns(nil)
+    client.enqueue(Object.new)
+  end
+
+  def test_does_not_enqueue_more_than_5K_metrics
+    client = Chillout::Client.new("xyz")
+    client.queue.expects(:size).returns(5000)
+    client.queue.expects(:<<).never
+    client.enqueue(Object.new)
+  end
+end

data/test/config_test.rb

@@ -11,6 +11,20 @@ class ConfigTest < ChilloutTestCase
     assert_equal "xyz123", @config.api_key
   end
 
+  def test_cannot_assing_wrong_api_key
+    assert_raises(ArgumentError) do
+      @config.api_key = Object.new
+    end
+    assert_raises(ArgumentError) do
+      Chillout::Config.new(Object.new)
+    end
+  end
+
+  def test_secret_setter
+    @config.secret = "SsEeCret"
+    assert_equal "SsEeCret", @config.api_key
+  end
+
   def test_update_with_options_hash
     @config.update(:platform => 'rack')
     assert_equal 'rack', @config.platform

data/test/creations_container_test.rb

@@ -23,5 +23,52 @@ module Chillout
       assert_equal 3, @creations_container[:User]
       assert_equal 1, @creations_container[:Entity]
     end
+
+    def test_equality
+      assert_equal CreationsContainer.new, CreationsContainer.new
+      assert_equal(
+        CreationsContainer.new.tap{|one| one.increment!("User") },
+        CreationsContainer.new.tap{|one| one.increment!("User") },
+      )
+      assert_equal(
+        CreationsContainer.new.tap{|one| one.increment!("User", 2) },
+        CreationsContainer.new.tap{|one| one.increment!("User", 2) },
+      )
+      refute_equal(
+        CreationsContainer.new.tap{|one| one.increment!("User", 3) },
+        CreationsContainer.new.tap{|one| one.increment!("User", 2) },
+      )
+      refute_equal(
+        CreationsContainer.new.tap{|one| one.increment!("User", 3) },
+        CreationsContainer.new.tap{|one| one.increment!("Post", 3) },
+      )
+      refute_equal(
+        Object.new,
+        CreationsContainer.new.tap{|one| one.increment!("Post", 3) },
+      )
+      refute_equal(
+        CreationsContainer.new.tap{|one| one.increment!("User", 3) },
+        Object.new,
+      )
+    end
+
+    def test_build_measurements_from_creations_container
+      creations_container = CreationsContainer.new
+      5.times { creations_container.increment!("User") }
+      3.times { creations_container.increment!("Cart") }
+      timestamp = Time.utc(2017, 6, 26, 15, 57, 10)
+
+      assert_equal [{
+          series: "User",
+          tags: {},
+          timestamp: "2017-06-26T15:57:10Z",
+          values: { creations: 5 },
+        },{
+          series: "Cart",
+          tags: {},
+          timestamp: "2017-06-26T15:57:10Z",
+          values: { creations: 3 },
+        }], creations_container.as_measurements(timestamp)
+    end
   end
-end
+end

data/test/dispatcher_test.rb

@@ -3,20 +3,20 @@ require 'test_helper'
 class DispatcherTest < ChilloutTestCase
   def test_send_creations
     server_side = mock("ServerSide")
-    server_side.expects(:send_creations).with(:creations)
+    server_side.expects(:send_measurements).with(:creations)
 
     dispatcher = Chillout::Dispatcher.new(server_side)
-    dispatcher.send_creations(:creations)
+    dispatcher.send_measurements(:creations)
   end
 
   def test_send_creations_raise_exception_if_server_side_failed_to_send_request
     server_side = stub()
-    server_side.stubs(:send_creations).raises(Chillout::HttpClient::NotSent.new(:http_error))
+    server_side.stubs(:send_measurements).raises(Chillout::HttpClient::NotSent.new(:http_error))
 
     dispatcher = Chillout::Dispatcher.new(server_side)
 
     assert_raises Chillout::Dispatcher::SendCreationsFailed do
-      dispatcher.send_creations(:creations)
+      dispatcher.send_measurements(:creations)
     end
   end
 

data/test/integration/creations_monitor_rack_test.rb

@@ -30,9 +30,9 @@ module Chillout
     def test_creations_values
       get "/"
       Thread.pass
-      sleep 2
-      assert_equal 2, request_body["content"]["creations"]["User"]
-      assert_equal 3, request_body["content"]["creations"]["Cart"]
+      sleep 3
+      assert_equal 2, request_body["measurements"].find{|m| m["series"] == "User" }.fetch("values").fetch("creations")
+      assert_equal 3, request_body["measurements"].find{|m| m["series"] == "Cart" }.fetch("values").fetch("creations")
     end
 
     private

data/test/server_side_test.rb

@@ -8,16 +8,4 @@ class ServerSideTest < ChilloutTestCase
     @http_client = mock("HttpClient")
     @server_side = Chillout::ServerSide.new(@event_data_builder, @http_client)
   end
-
-  def test_send_creations_use_event_data_builder
-    @event_data_builder.expects(:build_from_creations_container).with(:creations_container, anything).returns(:event_data_from_builder)
-    @http_client.stubs(:post)
-    @server_side.send_creations(:creations_container)
-  end
-
-  def test_send_creations_use_http_client
-    @event_data_builder.stubs(:build_from_creations_container).returns(:event_data_from_builder)
-    @http_client.expects(:post).with('/metrics', :event_data_from_builder)
-    @server_side.send_creations(:creations_container)
-  end
 end