alacrity-rails 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d34463ea5561472561eeff41e257a21fbac9d6f5
-  data.tar.gz: 83290c1e8b6258f4d70bcb35ad91531ac73ca7f5
+  metadata.gz: f51d25d010ac8d45e6a5d3c10486287807cce367
+  data.tar.gz: 72b159b9b69289d1e61cf5965f7813400de69362
 SHA512:
-  metadata.gz: d0e8039ba1aee3b5a52075c8c92170bbc48b6b607b59879c7f848e73e6a1ac7296c020760054367ed7a5c8e94a8b15efdd8a17fa237e4cc6b43aeeed525115ba
-  data.tar.gz: a775fe03c032002f80288a4f28076ced5a9d3f46b2e4848b3f2b7de0f1f496251d470a7d1f4613b19e1ff9f068ac0bdfaf034510f683ca7a5da27e5f0ca59419
+  metadata.gz: 0bb2e12e4df0574273ba587a605691b14feb9a0ee9bb75e73b83e768f9431fdf6ea4a05c044af308ffd58cebc3ab2214dcd3fc95974f0476d0a5203a23671fce
+  data.tar.gz: 6c416373659de9361c69724c4d6490830bda2ce839009299ef4de54b0929143d6888396e6d60a3d8e55fc32de7569ecf77f534e585fd421bf4afcf9e63c2891c

data/lib/alacrity-rails.rb

@@ -7,6 +7,7 @@ module AlacrityRails
   autoload :Config,           'alacrity-rails/config'
   autoload :Client,           'alacrity-rails/client'
   autoload :Diagnostic,       'alacrity-rails/diagnostic'
+  autoload :Instrumentor,     'alacrity-rails/instrumentor'
   autoload :Middleware,       'alacrity-rails/middleware'
   autoload :ServerConfig,     'alacrity-rails/server_config'
   autoload :VERSION,          'alacrity-rails/version'
@@ -26,6 +27,7 @@ module AlacrityRails
     autoload :Base,               'alacrity-rails/transaction/base'
     autoload :BulkWebTransaction, 'alacrity-rails/transaction/bulk_web_transaction'
     autoload :ConnectionTest,     'alacrity-rails/transaction/connection_test'
+    autoload :Custom,             'alacrity-rails/transaction/custom'
     autoload :ServerStartup,      'alacrity-rails/transaction/server_startup'
     autoload :WebTransaction,     'alacrity-rails/transaction/web_transaction'
   end

data/lib/alacrity-rails/client.rb

@@ -2,39 +2,41 @@ require 'net/http'
 
 module AlacrityRails
   class Client
+    Thread.current[:alacrity_transactions] = []
 
-    def self.open_transaction(env)
-      new_transaction!(env)
+    def self.open_transaction(transaction)
+      Thread.current[:alacrity_transactions].push(transaction) if config_enabled?
     end
 
-    def self.store_request(data)
-      transaction&.store_request(data)
+    def self.store_metadata(data)
+      transactions.each do |transaction|
+        transaction.store_metadata(data)
+      end
     end
 
     def self.store_timeline_event(data)
-      transaction&.store_timeline_event(data)
+      transactions.each do |transaction|
+        transaction.store_timeline_event(data)
+      end
     end
 
     def self.close_transaction!(response)
-      if transaction
-        transaction.status = response.first
-        transaction.finalize!
+      if transaction = transactions.pop
+        transaction.finalize(response)
         transmit(transaction)
       end
-    ensure
-      cleanup
     end
 
     def self.log_server_startup
       transmit(AlacrityRails::Transaction::ServerStartup.new)
     end
 
-    def self.transaction
-      Thread.current[:alacrity_transaction]
+    def self.transactions
+      Thread.current[:alacrity_transactions] ||= []
     end
 
-    def self.cleanup
-      Thread.current[:alacrity_transaction] = nil
+    def self.reset
+      Thread.current[:alacrity_transactions] = []
     end
 
     def self.transmit(transactable)
@@ -45,10 +47,9 @@ module AlacrityRails
       end
     end
 
-    private
-
-    def self.new_transaction!(env)
-      Thread.current[:alacrity_transaction] = Transaction::WebTransaction.new(env)
+    def self.config_enabled?
+      @config_enabled = Config.enabled? if @config_enabled == nil
+      @config_enabled
     end
 
   end

data/lib/alacrity-rails/instrumentor.rb

@@ -0,0 +1,21 @@
+module AlacrityRails
+  class Instrumentor
+    def self.instrument(name_or_options)
+      options = name_or_options.is_a?(String) ?
+        { type: AlacrityRails::Transaction::Custom, data: { name: name_or_options } } :
+        name_or_options
+
+      Client.reset if options[:reset]
+
+      transaction = options[:type].new(options[:data])
+      Client.open_transaction(transaction)
+
+      yield.tap do |response|
+        Client.close_transaction!(response)
+      end
+    rescue StandardError => e
+      Client.transactions.delete(transaction)
+      raise e
+    end
+  end
+end

data/lib/alacrity-rails/middleware.rb

@@ -1,10 +1,13 @@
 module AlacrityRails
   class Middleware < Struct.new(:app)
     def call(env)
-      Client.open_transaction(env)
-      response = app.call(env)
-      Client.close_transaction!(response)
-      response
+      AlacrityRails::Instrumentor.instrument(
+        type: AlacrityRails::Transaction::WebTransaction,
+        data: { url: env['REQUEST_URI'], method: env['REQUEST_METHOD'] },
+        reset: true
+      ) do
+        app.call(env)
+      end
     end
   end
 end

data/lib/alacrity-rails/probe/action_controller.rb

@@ -3,7 +3,7 @@ module AlacrityRails
     class ActionController
       def self.activate
         ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |name, started, finished, unique_id, data|
-          AlacrityRails::Client.store_request(
+          AlacrityRails::Client.store_metadata(
             controller: data[:controller],
             action: data[:action],
             format: data[:format]

data/lib/alacrity-rails/transaction/base.rb

@@ -1,5 +1,13 @@
 module AlacrityRails::Transaction
   class Base
+    def initialize(data={})
+       # May be overridden
+    end
+
+    def finalize(response)
+      # May be overridden
+    end
+
     def post_request
       Net::HTTP::Post.new(endpoint, {
         "Authorization" => authorization_header_value,
@@ -22,6 +30,39 @@ module AlacrityRails::Transaction
     end
     def authorization_header_value; self.class.authorization_header_value end
 
+    def store_metadata(data)
+      # May be overridden
+    end
+
+    def store_timeline_event(data)
+      timeline_events << {
+        name: data[:name],
+        event_type: data[:event_type],
+        engine: data[:engine],
+        started_at: data[:started_at],
+        finished_at: data[:finished_at],
+        detail: data[:detail]
+      }
+    end
+
+    def timeline_events
+      @timeline_events ||= []
+    end
+
+    def prepared_timeline_events
+      timeline_events.uniq do |timeline_event|
+        timeline_event.values_at(:engine, :started_at, :finished_at, :detail).join('~')
+      end.map do |timeline_event|
+        timeline_event[:started_at] = absolute_time(timeline_event[:started_at].to_datetime)
+        timeline_event[:finished_at] = absolute_time(timeline_event[:finished_at].to_datetime)
+        timeline_event
+      end
+    end
+
+    def absolute_time(datetime)
+      datetime.strftime('%Q').to_i
+    end
+
     def to_json
       @to_json ||= super.to_json
     end

data/lib/alacrity-rails/transaction/custom.rb

@@ -0,0 +1,29 @@
+module AlacrityRails::Transaction
+  class Custom < Base
+    attr_accessor :data, :start_time, :end_time
+
+    def initialize(data={})
+      self.data = data
+      self.start_time = DateTime.now
+    end
+
+    def finalize(response)
+      self.end_time = DateTime.now
+    end
+
+    def as_json(*args)
+      {
+        environment: AlacrityRails::ServerConfig.environment,
+        event_type: 'custom',
+        started_at: absolute_time(start_time),
+        finished_at: absolute_time(end_time),
+        data: data,
+        timeline_events: prepared_timeline_events
+      }
+    end
+
+    def self.endpoint
+      @endpoint ||= URI("#{AlacrityRails::Config.collector_host}/v2/events")
+    end
+  end
+end

data/lib/alacrity-rails/transaction/web_transaction.rb

@@ -2,30 +2,20 @@ module AlacrityRails::Transaction
   class WebTransaction < Base
     attr_accessor :url, :controller, :action, :format, :method, :status
 
-    def initialize(env={})
+    def initialize(data={})
       @middleware_started_at = DateTime.now
-      self.url = env['REQUEST_URI']
-      self.method = env['REQUEST_METHOD']
+      self.url = data[:url]
+      self.method = data[:method]
     end
 
-    def store_request(data)
+    def store_metadata(data)
       self.controller = data[:controller]
       self.action = data[:action]
       self.format = data[:format]
     end
 
-    def store_timeline_event(data)
-      timeline_events << {
-        name: data[:name],
-        event_type: data[:event_type],
-        engine: data[:engine],
-        started_at: data[:started_at],
-        finished_at: data[:finished_at],
-        detail: data[:detail]
-      }
-    end
-
-    def finalize!
+    def finalize(response)
+      self.status = response&.first
       @middleware_finished_at = DateTime.now
     end
 
@@ -51,23 +41,5 @@ module AlacrityRails::Transaction
     def self.endpoint
       @endpoint ||= URI("#{AlacrityRails::Config.collector_host}/v1/web-transactions")
     end
-
-    def timeline_events
-      @timeline_events ||= []
-    end
-
-    def prepared_timeline_events
-      timeline_events.uniq do |timeline_event|
-        timeline_event.values_at(:engine, :started_at, :finished_at, :detail).join('~')
-      end.map do |timeline_event|
-        timeline_event[:started_at] = absolute_time(timeline_event[:started_at].to_datetime)
-        timeline_event[:finished_at] = absolute_time(timeline_event[:finished_at].to_datetime)
-        timeline_event
-      end
-    end
-
-    def absolute_time(datetime)
-      datetime.strftime('%Q').to_i
-    end
   end
 end

data/lib/alacrity-rails/version.rb

@@ -1,3 +1,3 @@
 module AlacrityRails
-  VERSION = '0.9.1'
+  VERSION = '0.10.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alacrity-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Alacrity, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,7 @@ files:
 - lib/alacrity-rails/client.rb
 - lib/alacrity-rails/config.rb
 - lib/alacrity-rails/diagnostic.rb
+- lib/alacrity-rails/instrumentor.rb
 - lib/alacrity-rails/middleware.rb
 - lib/alacrity-rails/probe/action_controller.rb
 - lib/alacrity-rails/probe/action_mailer.rb
@@ -51,6 +52,7 @@ files:
 - lib/alacrity-rails/server_config.rb
 - lib/alacrity-rails/transaction/base.rb
 - lib/alacrity-rails/transaction/connection_test.rb
+- lib/alacrity-rails/transaction/custom.rb
 - lib/alacrity-rails/transaction/server_startup.rb
 - lib/alacrity-rails/transaction/web_transaction.rb
 - lib/alacrity-rails/version.rb
@@ -75,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rails Agent for the Alacrity Application Health Platform