oneapm_rpm 1.1.2 → 1.1.3

data/lib/one_apm/rack/middleware_hooks.rb

@@ -6,7 +6,7 @@ module OneApm::Rack
   class MiddlewareHooks < MiddlewareBase
 
     def self.needed?
-      !OneApm::Agent.config[:disable_rack_middleware]
+      !OneApm::Manager.config[:disable_rack_middleware]
     end
 
     def traced_call(env)

data/lib/one_apm/rack/middleware_tracing.rb

@@ -67,7 +67,7 @@ module OneApm::Rack
 
         result
       rescue Exception => e
-        OneApm::Agent.notice_error(e)
+        OneApm::Manager.notice_error(e)
         raise e
       ensure
         OneApm::Transaction.stop(state)
@@ -75,7 +75,7 @@ module OneApm::Rack
     end
 
     def events
-      OneApm::Agent.instance.events
+      OneApm::Manager.agent.events
     end
   end
 end

data/lib/one_apm/support/chained_call.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-# This class is used by OneApm::Agent.set_sql_obfuscator to chain multiple
+# This class is used by OneApm::Manager.set_sql_obfuscator to chain multiple
 # obfuscation blocks when not using the default :replace action
 class OneApm::ChainedCall
   def initialize(block1, block2)

data/lib/one_apm/support/coerce.rb

@@ -75,7 +75,7 @@ module OneApm
     def log_failure(value, type, context, error)
       msg = "Unable to convert '#{value}' to #{type}"
       msg += " in context '#{context}'" if context
-      OneApm::Agent.logger.warn(msg, error)
+      OneApm::Manager.logger.warn(msg, error)
     end
   end
 end

data/lib/one_apm/support/collection_helper.rb

@@ -35,7 +35,7 @@ module OneApm
   # Return nil if there is no backtrace
 
   def strip_oa_from_backtrace(backtrace)
-    if backtrace && !Agent.config[:disable_backtrace_cleanup]
+    if backtrace && !Manager.config[:disable_backtrace_cleanup]
       # this is for 1.9.1, where strings no longer have Enumerable
       backtrace = backtrace.split("\n") if String === backtrace
       backtrace = backtrace.map(&:to_s)

data/lib/one_apm/support/encoders.rb

@@ -23,7 +23,7 @@ module OneApm
           normalize_encodings = if opts[:skip_normalization]
             false
           else
-            Agent.config[:normalize_json_string_encodings]
+            OneApm::Manager.config[:normalize_json_string_encodings]
           end
           json = ::OneApm::JSONWrapper.dump(data, :normalize => normalize_encodings)
           Base64.encode64(Compressed.encode(json))

data/lib/one_apm/support/environment_report.rb

@@ -69,8 +69,8 @@ module OneApm
     report_on('Database adapter'  ) do
       ActiveRecord::Base.configurations[OneApm::Probe.instance.env]['adapter']
     end
-    report_on('Framework'       ) { Agent.config[:framework].to_s  }
-    report_on('Dispatcher'      ) { Agent.config[:dispatcher].to_s }
+    report_on('Framework'       ) { OneApm::Manager.config[:framework].to_s  }
+    report_on('Dispatcher'      ) { OneApm::Manager.config[:dispatcher].to_s }
     report_on('Environment'     ) { OneApm::Probe.instance.env }
     report_on('Rails version'   ) { ::Rails::VERSION::STRING       }
     report_on('Rails threadsafe') do
@@ -96,17 +96,17 @@ module OneApm
           if value
             data[key] = value
 
-            Agent.record_metric("Supportability/EnvironmentReport/success", 0.0)
-            Agent.record_metric("Supportability/EnvironmentReport/success/#{key}", 0.0)
+            OneApm::Manager.record_metric("Supportability/EnvironmentReport/success", 0.0)
+            OneApm::Manager.record_metric("Supportability/EnvironmentReport/success/#{key}", 0.0)
           else
-            Agent.logger.debug("EnvironmentReport ignoring value for #{key.inspect} which came back falsey: #{value.inspect}")
-            Agent.record_metric("Supportability/EnvironmentReport/empty", 0.0)
-            Agent.record_metric("Supportability/EnvironmentReport/empty/#{key}", 0.0)
+            OneApm::Manager.logger.debug("EnvironmentReport ignoring value for #{key.inspect} which came back falsey: #{value.inspect}")
+            OneApm::Manager.record_metric("Supportability/EnvironmentReport/empty", 0.0)
+            OneApm::Manager.record_metric("Supportability/EnvironmentReport/empty/#{key}", 0.0)
           end
         rescue => e
-          Agent.logger.debug("EnvironmentReport failed to retrieve value for #{key.inspect}: #{e}")
-          Agent.record_metric("Supportability/EnvironmentReport/error", 0.0)
-          Agent.record_metric("Supportability/EnvironmentReport/error/#{key}", 0.0)
+          OneApm::Manager.logger.debug("EnvironmentReport failed to retrieve value for #{key.inspect}: #{e}")
+          OneApm::Manager.record_metric("Supportability/EnvironmentReport/error", 0.0)
+          OneApm::Manager.record_metric("Supportability/EnvironmentReport/error/#{key}", 0.0)
         end
         data
       end

data/lib/one_apm/{agent → support}/event/event_listener.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module OneApm::Agent
+module OneApm::Support
   class EventListener
 
     attr_accessor :runaway_threshold
@@ -18,7 +18,7 @@ module OneApm::Agent
 
     def check_for_runaway_subscriptions(event)
       count = @events[event].size
-      OneApm::Agent.logger.debug("Run-away event subscription on #{event}? Subscribed #{count}") if count > @runaway_threshold
+      OneApm::Manager.logger.debug("Run-away event subscription on #{event}? Subscribed #{count}") if count > @runaway_threshold
     end
 
     def clear
@@ -32,7 +32,7 @@ module OneApm::Agent
         begin
           handler.call(*args)
         rescue => err
-          OneApm::Agent.logger.debug("Failure during notify for #{event}", err)
+          OneApm::Manager.logger.debug("Failure during notify for #{event}", err)
         end
       end
     end

data/lib/one_apm/{agent → support}/event/event_loop.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
 require 'thread'
-require 'one_apm/agent/event/timer'
+require 'one_apm/support/event/timer'
 
 module OneApm
-  module Agent
+  module Support
     class EventLoop
 
       def initialize
@@ -47,7 +47,7 @@ module OneApm
       end
 
       def run
-        OneApm::Agent.logger.debug "Running event loop"
+        OneApm::Manager.logger.debug "Running event loop"
         while !stopped?
           run_once
         end
@@ -93,7 +93,7 @@ module OneApm
       end
 
       def dispatch_event(event, args)
-        OneApm::Agent.logger.debug("EventLoop: Dispatching event '#{event}' with #{@subscriptions[event].size} callback(s).")
+        OneApm::Manager.logger.debug("EventLoop: Dispatching event '#{event}' with #{@subscriptions[event].size} callback(s).")
 
         errors = []
         @subscriptions[event].each do |s|
@@ -107,7 +107,7 @@ module OneApm
         end
 
         if !errors.empty?
-          OneApm::Agent.logger.error "#{errors.size} error(s) running task for event '#{event}' in Agent Event Loop:", *errors
+          OneApm::Manager.logger.error "#{errors.size} error(s) running task for event '#{event}' in Agent Event Loop:", *errors
         end
       end
 
@@ -125,19 +125,19 @@ module OneApm
       end
 
       def fire_every(interval, event)
-        OneApm::Agent.logger.debug "Firing event #{event} every #{interval} seconds."
+        OneApm::Manager.logger.debug "Firing event #{event} every #{interval} seconds."
         fire(:__add_timer, Timer.new(interval, event, true))
       end
 
       def fire_after(interval, event)
-        OneApm::Agent.logger.debug "Firing event #{event} after #{interval} seconds."
+        OneApm::Manager.logger.debug "Firing event #{event} after #{interval} seconds."
         fire(:__add_timer, Timer.new(interval, event, false))
       end
 
       def wakeup
         @self_pipe_wr.write_nonblock '.'
       rescue Errno::EAGAIN
-        OneApm::Agent.logger.debug "Failed to wakeup event loop"
+        OneApm::Manager.logger.debug "Failed to wakeup event loop"
       end
     end
   end

data/lib/one_apm/{agent → support}/event/timer.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module OneApm
-  module Agent
+  module Support
     class EventLoop
       class Timer
 

data/lib/one_apm/{agent → support}/event/worker_loop.rb

@@ -1,19 +1,16 @@
 # encoding: utf-8
 
 require 'thread'
+
 module OneApm
-  module Agent
+  module Support
 
-    # A worker loop executes a set of registered tasks on a single thread.
-    # A task is a proc or block with a specified call period in seconds.
     class WorkerLoop
 
       attr_accessor :period, :propagate_errors
       attr_reader :iterations
 
-      # Optional argument :duration (in seconds) for how long the worker loop runs
-      # or :limit (integer) for max number of iterations
-      def initialize(opts={})
+      def initialize(opts = {})
         @should_run = true
         @next_invocation_time = Time.now
         @period = 60.0
@@ -23,7 +20,6 @@ module OneApm
         @propagate_errors = opts.fetch(:propagate_errors, false)
       end
 
-      # Reset state that is changed by running the worker loop
       def setup(period, task)
         @task = task
         @period = period if period
@@ -35,10 +31,7 @@ module OneApm
         @next_invocation_time = (now + @period)
       end
 
-      # Run infinitely, calling the registered tasks at their specified
-      # call periods.  The caller is responsible for creating the thread
-      # that runs this worker loop.  This will run the task immediately.
-      def run(period=nil, &block)
+      def run(period = nil, &block)
         setup(period, block)
         while keep_running? do
           sleep_time = schedule_next_invocation
@@ -56,7 +49,6 @@ module OneApm
         @next_invocation_time - Time.now
       end
 
-      # a simple accessor for @should_run
       def keep_running?
         @should_run && under_duration? && under_limit?
       end
@@ -69,14 +61,10 @@ module OneApm
         @limit.nil? || @iterations < @limit
       end
 
-      # Sets @should_run to false. Returns false
       def stop
         @should_run = false
       end
 
-      # Executes the block given to the worker loop, and handles many
-      # possible errors. Also updates the execution time so that the
-      # next run occurs on schedule, even if we execute at some odd time
       def run_task
         if @propagate_errors
           @task.call
@@ -84,11 +72,9 @@ module OneApm
           begin
             @task.call
           rescue OneApm::ForceRestartException, OneApm::ForceDisconnectException
-            # blow out the loop
             raise
           rescue => e
-            # Don't blow out the stack for anything that hasn't already propagated
-            ::OneApm::Agent.logger.error "Error running task in Agent Worker Loop:", e
+            OneApm::Manager.logger.error "Error running task in Agent Worker Loop:", e
           end
         end
       end

data/lib/one_apm/{agent/pipe/pipe_channel_manager.rb → support/forked_process_channel.rb}

@@ -3,13 +3,8 @@
 require 'base64'
 
 module OneApm
-  module Agent
-
-    #--
-    # Manages the registering and servicing of pipes used by child
-    # processes to report data to their parent, rather than directly
-    # to the collector.
-    module PipeChannelManager
+  module Support
+    module ForkedProcessChannel
       extend self
 
       def register_report_channel(id)
@@ -24,36 +19,8 @@ module OneApm
         @listener ||= Listener.new
       end
 
-      # Expected initial sequence of events for Pipe usage:
-      #
-      # 1. Pipe is created in parent process (read and write ends open)
-      # 2. Parent process forks
-      # 3. An after_fork hook is invoked in the child
-      # 4. From after_fork hook, child closes read end of pipe, and
-      #    writes a ready marker on the pipe (after_fork_in_child).
-      # 5. The parent receives the ready marker, and closes the write end of the
-      #    pipe in response (after_fork_in_parent).
-      #
-      # After this sequence of steps, an exit (whether clean or not) of the
-      # child will result in the pipe being marked readable again, and giving an
-      # EOF marker (nil) when read. Note that closing of the unused ends of the
-      # pipe in the parent and child processes is essential in order for the EOF
-      # to be correctly triggered. The ready marker mechanism is used because
-      # there's no easy hook for after_fork in the parent process.
-      #
-      # This class provides message framing (separation of individual messages),
-      # but not serialization. Serialization / deserialization is the
-      # responsibility of clients.
-      #
-      # Message framing works like this:
-      #
-      # Each message sent across the pipe is preceded by a length tag that
-      # specifies the length of the message that immediately follows, in bytes.
-      # The length tags are serialized as unsigned big-endian long values, (4
-      # bytes each). This means that the maximum theoretical message size is
-      # 4 GB - much larger than we'd ever need or want for this application.
-      #
       class Pipe
+
         READY_MARKER = "READY"
         NUM_LENGTH_BYTES = 4
 
@@ -98,11 +65,11 @@ module OneApm
               @out.read(message_length)
             else
               length_hex = length_bytes.bytes.map { |b| b.to_s(16) }.join(' ')
-              OneApm::Agent.logger.error("Failed to deserialize message length from pipe. Bytes: [#{length_hex}]")
+              OneApm::Manager.logger.error("Failed to deserialize message length from pipe. Bytes: [#{length_hex}]")
               nil
             end
           else
-            OneApm::Agent.logger.error("Failed to read bytes for length from pipe.")
+            OneApm::Manager.logger.error("Failed to read bytes for length from pipe.")
             nil
           end
         end
@@ -123,17 +90,12 @@ module OneApm
         def closed?
           @out.closed? && @in.closed?
         end
+
       end
 
       class Listener
-        attr_reader   :thread
 
-        # This attr_accessor intentionally provides unsynchronized access to the
-        # @pipes hash. It is used to look up the write end of the pipe from
-        # within the Resque child process, and must be unsynchronized in order
-        # to avoid a potential deadlock in which the PipeChannelManager::Listener
-        # thread in the parent process is holding the @pipes_lock at the time of
-        # the fork.
+        attr_reader   :thread
         attr_accessor :pipes, :timeout, :select_timeout
 
         def initialize
@@ -168,8 +130,7 @@ module OneApm
                 @pipes.values.map{|pipe| pipe.out} + [wake.out]
               end
 
-              OneApm::Agent.record_metric('Supportability/Listeners',
-                (Time.now - now).to_f) if now
+              OneApm::Manager.record_metric('Supportability/Listeners', (Time.now - now).to_f) if now
 
               if ready = IO.select(pipes_to_listen_to, [], [], @select_timeout)
                 now = Time.now
@@ -185,7 +146,7 @@ module OneApm
               break unless should_keep_listening?
             end
           end
-          sleep 0.001 # give time for the thread to spawn
+          sleep 0.001
         end
 
         def stop_listener_thread
@@ -231,7 +192,7 @@ module OneApm
               payload = unmarshal(raw_payload)
               if payload
                 endpoint, items = payload
-                OneApm::Agent.instance.merge_data_for_endpoint(endpoint, items)
+                OneApm::Manager.agent.merge_data_for_endpoint(endpoint, items)
               end
             end
           end
@@ -244,8 +205,8 @@ module OneApm
             Marshal.load(data)
           end
         rescue StandardError => e
-          ::OneApm::Agent.logger.error "Failure unmarshalling message from Resque child process", e
-          ::OneApm::Agent.logger.debug Base64.encode64(data)
+          OneApm::Manager.logger.error "Failure unmarshalling message from Resque child process", e
+          OneApm::Manager.logger.debug Base64.encode64(data)
           nil
         end
 
@@ -269,6 +230,7 @@ module OneApm
             @pipes.values.find{|pipe| pipe.out == out_handle }
           end
         end
+
       end
     end
   end

data/lib/one_apm/support/json_marshaller.rb

@@ -9,7 +9,7 @@ module OneApm
       OK_YAJL_VERSION = OneApm::VersionNumber.new("1.2.1")
 
       def initialize
-        ::OneApm::Agent.logger.info "Using JSON marshaller (#{OneApm::JSONWrapper.backend_name})"
+        OneApm::Manager.logger.info "Using JSON marshaller (#{OneApm::JSONWrapper.backend_name})"
         warn_for_yajl
       end
 
@@ -17,11 +17,11 @@ module OneApm
         if defined?(::Yajl)
           require 'yajl/version'
           if OneApm::VersionNumber.new(::Yajl::VERSION) < OK_YAJL_VERSION
-            ::OneApm::Agent.logger.warn "Detected yajl-ruby version #{::Yajl::VERSION} which can cause segfaults with oneapm_rpm's thread profiling features. We strongly recommend you upgrade to the latest yajl-ruby version available."
+            OneApm::Manager.logger.warn "Detected yajl-ruby version #{::Yajl::VERSION} which can cause segfaults with oneapm_rpm's thread profiling features. We strongly recommend you upgrade to the latest yajl-ruby version available."
           end
         end
       rescue => err
-        ::OneApm::Agent.logger.warn "Failed trying to watch for problematic yajl-ruby version.", err
+        OneApm::Manager.logger.warn "Failed trying to watch for problematic yajl-ruby version.", err
       end
 
       def dump(ruby, opts={})
@@ -30,7 +30,7 @@ module OneApm
         if opts[:skip_normalization]
           normalize_encodings = false
         else
-          normalize_encodings = Agent.config[:normalize_json_string_encodings]
+          normalize_encodings = OneApm::Manager.config[:normalize_json_string_encodings]
         end
 
         OneApm::JSONWrapper.dump prepared, :normalize => normalize_encodings
@@ -38,13 +38,13 @@ module OneApm
 
       def load(data)
         if data.nil? || data.empty?
-          ::OneApm::Agent.logger.error "Empty JSON response from collector: '#{data.inspect}'"
+          OneApm::Manager.logger.error "Empty JSON response from collector: '#{data.inspect}'"
           return nil
         end
 
         return_value OneApm::JSONWrapper.load(data)
       rescue => e
-        ::OneApm::Agent.logger.debug "#{e.class.name} : #{e.message} encountered loading collector response: #{data}"
+        OneApm::Manager.logger.debug "#{e.class.name} : #{e.message} encountered loading collector response: #{data}"
         raise
       end