plain_apm 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b4d2bddabd031b2b17d2edcf27e32f323c217b2331c469072e95d0afeb58ec7
-  data.tar.gz: a892bbd62da4a10b074046c39326576355d591bf02982f9d336a97d887f99bc6
+  metadata.gz: 3acddaa717f06d06714c34402f068f3f196cfa3f0408b5567a3e488f77305793
+  data.tar.gz: cac965341db100f19bc3199d629ddfd3bff4fd7e9f5695a9c4c11baf69ba7c50
 SHA512:
-  metadata.gz: b523dbaea426bbb9f2e4c2808efb4937ebf5c842361d07c9a0ae6a23bef03fe8bef0a71815710b4c55a7f8a1eeaea01e8b0fbe01bb3ed9af58743a31aa09c0aa
-  data.tar.gz: 93c110b5e728cd6e934cbb25e56bd5345e3cc45dc1776922ca39a5de902e19a996fcc2aa7de0c749b231e8faf137b16be49f1d9389bec1735986223f18bc6798
+  metadata.gz: 0e2919a1a3f001220ad564e982c9097b016b791296f71e2f8cadc3dda8f1abdd5a9a85aae650e239c3dbea638f6b385ef33943fd7c4e56419b340f8bb756046f
+  data.tar.gz: a7f2f65d4cf5ff3a673d54e3f196fbe79c60268104c9b531127fc87aad56de262d06a3c1858f19e0a27fff6b3fc66bd2117614081ad64c1cce030faf1d7fd97d

data/lib/plain_apm/agent.rb

@@ -2,7 +2,6 @@
 
 require "singleton"
 require "json"
-require "socket"
 
 module PlainApm
   class Agent

data/lib/plain_apm/event_attributes.rb

@@ -1,6 +1,9 @@
+require "time"
+require "socket"
+
 module PlainApm
   module EventAttributes
-    SOURCES_WITH_HOST_ATTRIBUTES = %w[
+    SOURCES_WITH_EXTRA_ATTRIBUTES = %w[
       action_controller
       action_mailer
       active_job
@@ -23,8 +26,7 @@ module PlainApm
         "name" => tool
       }
 
-      attrs.merge!(agent_attributes)
-      attrs.merge!(host_attributes) if add_host_attributes?(source)
+      attrs.merge!(trace_attributes(source))
 
       [tool, attrs]
     end
@@ -41,7 +43,7 @@ module PlainApm
       }
 
       if context[:env]
-        attrs["params"] = env["action_dispatch.request.parameters"]
+        attrs["params"] = context[:env]["action_dispatch.request.parameters"]
       end
 
       if context[:job]&.is_a?(ActiveJob::Base)
@@ -57,8 +59,7 @@ module PlainApm
         })
       end
 
-      attrs.merge!(context_attributes, agent_attributes)
-      attrs.merge!(host_attributes) if add_host_attributes?(source)
+      attrs.merge!(trace_attributes(source))
 
       [source, attrs]
     end
@@ -71,50 +72,52 @@ module PlainApm
         "source" => source,
         "name" => name,
         "allocations" => event.allocations,
-        "thread_allocations" => event.thread_allocations,
-        "started_at" => event.time,
-        "finished_at" => event.end
+        "event_time" => event.time,
+        "duration" => event.duration
       }
 
+      attrs["thread_allocations"] = event.thread_allocations if event.respond_to?(:thread_allocations)
       attrs["source_location"] = loc if !loc.nil?
-      attrs.merge!(context_attributes, agent_attributes)
-      attrs.merge!(host_attributes) if add_host_attributes?(source)
+
+      attrs.merge!(trace_attributes(source))
 
       [name, attrs]
     end
 
     private
 
-    def context_attributes
-      ##
-      # Context contains the trace ID (which comes from either
-      # HTTP_X_REQUEST_ID header, the deserialized job,
-      # or is generated by the trace_id middleware).
-      # It can also carry user inserted app data.
-      if defined?(PlainApm::Extensions::Context)
-        PlainApm::Extensions::Context.current
-      else
-        {}
-      end
+    def trace_attributes(source)
+      process_attributes.merge(context_attributes)
     end
 
-    def agent_attributes
+    def process_attributes
       {
+        "thread_id" => Thread.current.object_id,
+        "collected_at" => Time.now.iso8601(9),
         "version" => PlainApm::VERSION
-      }
+      }.merge(
+        host_attributes
+      )
     end
 
     def host_attributes
-      {
-        "collected_at" => Time.now.iso8601(9),
+      @host_attributes ||= {
         "hostname" => Socket.gethostname,
-        "pid" => Process.pid,
-        "thread_id" => Thread.current.object_id
+        "pid" => Process.pid
       }
     end
 
-    def add_host_attributes?(source)
-      SOURCES_WITH_HOST_ATTRIBUTES.include?(source)
+    def context_attributes
+      ##
+      # Context contains the trace ID (which comes from either
+      # HTTP_X_REQUEST_ID header, the deserialized job,
+      # or is generated by the trace_id middleware).
+      # It can also carry user inserted app data.
+      if defined?(PlainApm::Extensions::Context)
+        PlainApm::Extensions::Context.current
+      else
+        {}
+      end
     end
 
     def source_location

data/lib/plain_apm/extensions/context/active_job.rb

@@ -24,12 +24,6 @@ module PlainApm
           super(job)
         end
       end
-
-      ##
-      # Allow tracing request ID through jobs
-      ActiveSupport.on_load(:active_job) do |klass|
-        klass.prepend(ActiveJob)
-      end
     end
   end
 end

data/lib/plain_apm/extensions/context/middleware.rb

@@ -11,7 +11,7 @@ require "securerandom"
 module PlainApm
   module Extensions
     module Context
-      class Middleware
+      class Rack
         def initialize(app)
           @app = app
         end
@@ -21,8 +21,12 @@ module PlainApm
 
           status, headers, body = @app.call(env)
 
-          body = Rack::BodyProxy.new(body) do
-            Context.clear!
+          body = if defined?(Rack::BodyProxy)
+            Rack::BodyProxy.new(body) do
+              Context.clear!
+            end
+          else
+            body
           end
 
           processed = true

data/lib/plain_apm/extensions/context/rack.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+##
+# This code is inspired by request_store gem by Steve Klabnik:
+#
+# https://github.com/steveklabnik/request_store/
+#
+# See LICENSE.txt in the current directory for the license.
+module PlainApm
+  module Extensions
+    module Context
+      class Rack
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          Context.trace_id = trace_id(env)
+
+          status, headers, body = @app.call(env)
+
+          body = Rack::BodyProxy.new(body) do
+            Context.clear!
+          end
+
+          processed = true
+
+          [status, headers, body]
+        ensure
+          Context.clear! if !processed
+        end
+
+        private
+
+        def trace_id(env)
+          request_id(env) || SecureRandom.uuid
+        end
+
+        def request_id(env)
+          env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
+        end
+      end
+    end
+  end
+end

data/lib/plain_apm/extensions/context/railtie.rb

@@ -9,12 +9,18 @@
 module PlainApm
   module Extensions
     module Context
-      class Railtie < Rails::Railtie
-        initializer "plain_apm.insert_context_middleware" do |app|
-          if defined?(ActionDispatch::RequestId)
-            app.config.middleware.insert_after ActionDispatch::RequestId, PlainApm::Extensions::Context::Middleware
-          else
-            app.config.middleware.insert_after Rack::MethodOverride, PlainApm::Extensions::Context::Middleware
+      if defined?(Rails::Railtie)
+        class Railtie < Rails::Railtie
+          initializer "plain_apm.initialize_context" do |app|
+            ActiveSupport.on_load(:active_job) do |klass|
+              klass.prepend(PlainApm::Extensions::Context::ActiveJob)
+            end
+
+            if defined?(ActionDispatch::RequestId)
+              app.config.middleware.insert_after ActionDispatch::RequestId, PlainApm::Extensions::Context::Rack
+            else
+              app.config.middleware.insert_after Rack::MethodOverride, PlainApm::Extensions::Context::Rack
+            end
           end
         end
       end

data/lib/plain_apm/extensions/exceptions/rack.rb

@@ -32,7 +32,7 @@ module PlainApm
           event["source"] = source
           event["name"] = "rack_middleware"
 
-          PlainApm::Agent.collect(event)
+          PlainApm.agent.collect(event)
         end
       end
     end

data/lib/plain_apm/extensions/exceptions/railtie.rb

@@ -3,9 +3,11 @@
 module PlainApm
   module Extensions
     module Exceptions
-      class Railtie < Rails::Railtie
-        initializer "plain_apm.insert_exceptions_middleware" do |app|
-          app.config.middleware.insert(0, PlainApm::Extensions::Exceptions::Rack)
+      if defined?(Rails::Railtie)
+        class Railtie < Rails::Railtie
+          initializer "plain_apm.insert_exceptions_middleware" do |app|
+            app.config.middleware.insert(0, PlainApm::Extensions::Exceptions::Rack)
+          end
         end
       end
     end

data/lib/plain_apm/extensions/thread_allocations/active_support_event.rb

@@ -0,0 +1,31 @@
+module PlainApm
+  module Extensions
+    module ThreadAllocations
+      module ActiveSupportEvent
+        def start!
+          super
+          @thread_allocation_count_start = now_thread_allocations
+        end
+
+        def finish!
+          super
+          @thread_allocation_count_finish = now_thread_allocations
+        end
+
+        def thread_allocations
+          @thread_allocation_count_finish - @thread_allocation_count_start
+        end
+
+        if defined?(PlainApm::ObjectTracing)
+          def now_thread_allocations
+            PlainApm::ObjectTracing.total_thread_allocated_objects
+          end
+        else
+          def now_thread_allocations
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plain_apm/extensions/thread_allocations/railtie.rb

@@ -0,0 +1,15 @@
+module PlainApm
+  module Extensions
+    module ThreadAllocations
+      if defined?(Rails::Railtie)
+        class Railtie < Rails::Railtie
+          initializer "plain_apm.thread_allocations_in_active_support_events" do
+            ActiveSupport::Notifications::Event.prepend(
+              PlainApm::Extensions::ThreadAllocations::ActiveSupportEvent
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plain_apm/helpers.rb

@@ -6,6 +6,7 @@ module PlainApm
 
     def plain_apm_instrument(name, context = {}, &block)
       sanitized_name = name.gsub(/\W/, "_").gsub(/(?!^)([A-Z])/) { |m| "_#{m}" }.squeeze("_").downcase
+      return unless defined?(ActiveSupport::Notifications)
       ActiveSupport::Notifications.instrument("#{sanitized_name}.manual_plain_apm", **context, &block)
     end
   end

data/lib/plain_apm/hooks/action_view.rb

@@ -43,7 +43,7 @@ module PlainApm
 
       # strip rails root
       def identifier(id)
-        return id unless defined?(Rails) && Rails.root
+        return id unless defined?(Rails) && Rails.respond_to?(:root)
 
         root = Rails.root.to_s
 

data/lib/plain_apm/hooks/active_record.rb

@@ -23,6 +23,8 @@ module PlainApm
         case name
         when "sql"
           base.merge({"sql" => payload[:sql]})
+        when "instantiation"
+          base.merge({"class_name" => payload[:class_name], "record_count" => payload[:record_count]})
         end
       end
     end

data/lib/plain_apm/hooks/active_support_subscriber.rb

@@ -6,29 +6,36 @@ module PlainApm
       include EventAttributes
 
       def install
-        begin
-          require "active_support/notifications"
-        rescue LoadError
-          return
-        end
+        return unless defined?(::ActiveSupport::Notifications)
 
         asn = ::ActiveSupport::Notifications
 
-        # Rails >= 6.1
-        if asn.respond_to?(:monotonic_subscribe)
-          asn.monotonic_subscribe(notification_pattern, method(:collect))
+        # Rails 6.0 has a slightly different arity check in the subscriber
+        # constructor, so we need to use a proc, method(:collect) won't work.
+        # https://github.com/rails/rails/blob/28bb76d3efc39b2ef663dfe2346f7c2621343cd6/activesupport/lib/active_support/notifications/fanout.rb#L93-L100
+        # vs
+        # https://github.com/rails/rails/blob/7c70791470fc517deb7c640bead9f1b47efb5539/activesupport/lib/active_support/notifications/fanout.rb#L132-L139
+        subscriber = proc { |event| collect(event) }
+
+        # #monotonic_subscribe got added in Rails >= 6.1
+        @subscription = if asn.respond_to?(:monotonic_subscribe)
+          asn.monotonic_subscribe(notification_pattern, subscriber)
         else
-          asn.subscribe(notification_pattern, method(:collect))
+          asn.subscribe(notification_pattern, subscriber)
         end
       end
 
+      def uninstall
+        ::ActiveSupport::Notifications.unsubscribe(@subscription) if @subscription
+      end
+
       def collect(event)
         # id / transaction_id is by instrumenter and thread
         payload = payload(event)
 
         return if payload.nil?
 
-        Agent.collect(payload)
+        ::PlainApm.agent.collect(payload)
       end
 
       private

data/lib/plain_apm/hooks/deploy.rb

@@ -14,12 +14,16 @@ module PlainApm
         collect
       end
 
+      def uninstall
+        # NOOP
+      end
+
       def collect
         result = git_revision || hg_revision || return
 
         _, attrs = attributes_from_deploy(*result)
 
-        Agent.collect(attrs)
+        ::PlainApm.agent.collect(attrs)
       end
 
       private

data/lib/plain_apm/hooks/error_reporter.rb

@@ -5,12 +5,7 @@ module PlainApm
       include EventAttributes
 
       def install
-        begin
-          require "active_support/error_reporter"
-          require "active_support/lazy_load_hooks"
-        rescue LoadError
-          return
-        end
+        return unless defined?(Rails) && Rails.respond_to?(:error)
 
         # Install the hook when the app is up. This might miss errors that
         # happen before that, but that's OK.
@@ -19,6 +14,14 @@ module PlainApm
         end
       end
 
+      def uninstall
+        return unless defined?(Rails) && Rails.respond_to?(:error)
+
+        # There's no unsubscribe
+        subscribers = Rails.error.instance_variable_get(:@subscribers)
+        subscribers&.delete(self)
+      end
+
       def collect(e, handled:, severity:, context: {})
         source, event = attributes_from_exception(e, context)
 
@@ -27,7 +30,7 @@ module PlainApm
         event["source"] = source
         event["name"] = "error_reporter"
 
-        PlainApm::Agent.collect(event)
+        ::PlainApm.agent.collect(event)
       end
 
       alias_method :report, :collect

data/lib/plain_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlainApm
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/plain_apm.rb

@@ -8,27 +8,11 @@ require_relative "plain_apm/event_attributes"
 
 require "object_tracing"
 
+# Deployment reporting.
 require_relative "plain_apm/hooks/deploy"
 
-# Rails extensions
-begin
-  require "rack/body_proxy"
-
-  require_relative "plain_apm/extensions/context"
-  require_relative "plain_apm/extensions/context/middleware"
-  require_relative "plain_apm/extensions/context/active_job" if defined?(ActiveSupport)
-  require_relative "plain_apm/extensions/context/railtie" if defined?(Rails::Railtie)
-  require_relative "plain_apm/extensions/thread_allocations"
-  require_relative "plain_apm/helpers"
-rescue LoadError
-  nil
-end
-
-# Rack exceptions
-require_relative "plain_apm/extensions/exceptions/rack"
-require_relative "plain_apm/extensions/exceptions/railtie" if defined?(Rails::Railtie)
-
-# Rails instrumentation
+# Rails instrumentation. The hooks won't install unless
+# ActiveSupport::Notifications is loaded.
 require_relative "plain_apm/hooks/active_support_subscriber"
 require_relative "plain_apm/hooks/action_mailer"
 require_relative "plain_apm/hooks/action_pack"
@@ -39,12 +23,40 @@ require_relative "plain_apm/hooks/active_support"
 require_relative "plain_apm/hooks/manual"
 require_relative "plain_apm/hooks/error_reporter"
 
+# Per thread context for request IDs / job IDs.
+require_relative "plain_apm/extensions/context"
+require_relative "plain_apm/extensions/context/rack"
+require_relative "plain_apm/extensions/context/active_job"
+require_relative "plain_apm/extensions/context/railtie"
+
+# Per thread allocations in ASN events
+require_relative "plain_apm/extensions/thread_allocations/active_support_event"
+require_relative "plain_apm/extensions/thread_allocations/railtie"
+
+# Helpers du jour.
+require_relative "plain_apm/helpers"
+
+# Rack exceptions. Activate the middleware if in Rails.
+require_relative "plain_apm/extensions/exceptions/rack"
+require_relative "plain_apm/extensions/exceptions/railtie"
+
 module PlainApm
-  if defined?(Rails)
+  # Allow swapping out the Agent for a synchronous, in-memory implementation in
+  # the tests.
+  def self.agent=(agent)
+    @@agent = agent
+  end
+
+  def self.agent
+    @@agent ||= Agent.instance
+  end
+
+  # after_initialize allows reading settings from ENV on app start.
+  if defined?(Rails::Railtie)
     class Railtie < Rails::Railtie
-      config.after_initialize { PlainApm::Agent.start }
+      config.after_initialize { PlainApm.agent.start }
     end
   else
-    Agent.start
+    PlainApm.agent.start
   end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: plain_apm
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - PlainAPM Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,23 +92,23 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - ext/object_tracing/extconf.rb
 - ext/object_tracing/object_tracing.c
 - lib/plain_apm.rb
 - lib/plain_apm/agent.rb
-- lib/plain_apm/backoff.rb
 - lib/plain_apm/config.rb
 - lib/plain_apm/event_attributes.rb
 - lib/plain_apm/extensions/context.rb
 - lib/plain_apm/extensions/context/LICENSE.txt
 - lib/plain_apm/extensions/context/active_job.rb
 - lib/plain_apm/extensions/context/middleware.rb
+- lib/plain_apm/extensions/context/rack.rb
 - lib/plain_apm/extensions/context/railtie.rb
 - lib/plain_apm/extensions/exceptions/active_job.rb
 - lib/plain_apm/extensions/exceptions/rack.rb
 - lib/plain_apm/extensions/exceptions/railtie.rb
-- lib/plain_apm/extensions/thread_allocations.rb
+- lib/plain_apm/extensions/thread_allocations/active_support_event.rb
+- lib/plain_apm/extensions/thread_allocations/railtie.rb
 - lib/plain_apm/helpers.rb
 - lib/plain_apm/hooks/action_mailer.rb
 - lib/plain_apm/hooks/action_pack.rb

data/Rakefile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "appraisal"
-require "standard/rake"
-require "rake/testtask"
-require "rake/extensiontask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-Rake::ExtensionTask.new("object_tracing")
-
-namespace :test do
-  task all: "appraisal:all"
-end
-
-task default: :test

data/lib/plain_apm/backoff.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module PlainApm
-  class Backoff
-    ##
-    # Exponential backoff with jitter.
-
-    DEFAULT_BASE_SECONDS = 1.5
-    DEFAULT_MAX_RETRIES = 10 # sum_0^10 1.5 ** k ~ 170s
-    DEFAULT_JITTER_MULTIPLIER = 0.2 # % of the current retry interval
-
-    ##
-    # @param base_seconds [Integer] base of the exponential retry.
-    # @param max_retries [Integer] maximum retries to perform.
-    # @param jitter_multiplier [Float] % of the current retry interval to use for jitter.
-    def initialize(base_seconds: nil, max_retries: nil, jitter_multiplier: nil)
-      @base_seconds = base_seconds || DEFAULT_BASE_SECONDS
-      @max_retries = max_retries || DEFAULT_MAX_RETRIES
-      @jitter_multiplier = jitter_multiplier || DEFAULT_JITTER_MULTIPLIER
-    end
-
-    ##
-    # @param retries [Integer] Number of current retry attempts.
-    #
-    # @return [Integer|nil] Amount of time slept, or nil if out of retries.
-    def delay_time(retries:)
-      return if retries >= max_retries
-
-      base_interval = (base_seconds**retries)
-      jitter_interval = base_interval * jitter_multiplier
-
-      # The random factor is never -1, but that shouldn't be an issue.
-      base_interval + jitter_interval * (1.0 - 2.0 * rand)
-    end
-
-    private
-
-    attr_reader :base_seconds, :max_retries, :jitter_multiplier
-  end
-end

data/lib/plain_apm/extensions/thread_allocations.rb

@@ -1,35 +0,0 @@
-module PlainApm
-  module Extensions
-    module ThreadAllocations
-      def start!
-        super
-        @thread_allocation_count_start = now_thread_allocations
-      end
-
-      def finish!
-        super
-        @thread_allocation_count_finish = now_thread_allocations
-      end
-
-      def thread_allocations
-        @thread_allocation_count_finish - @thread_allocation_count_start
-      end
-
-      private
-
-      if defined?(PlainApm::ObjectTracing)
-        def now_thread_allocations
-          PlainApm::ObjectTracing.total_thread_allocated_objects
-        end
-      else
-        def now_thread_allocations
-          0
-        end
-      end
-    end
-
-    if defined?(ActiveSupport)
-      ActiveSupport::Notifications::Event.prepend(PlainApm::Extensions::ThreadAllocations)
-    end
-  end
-end