plain_apm 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41210e3cc29f6e3645782734560b34029d5b4add1b1037d1f58aaccad4d862e1
-  data.tar.gz: f34874b032c24d198306605b7cb97c86a6c302028fb964e1bff3510e22996daf
+  metadata.gz: a2950f7d2e02a813b67a5bfb4c2ff7cc522acb8770404e3ef3dcef4e13aa4c4c
+  data.tar.gz: 4af16bf90b9904db8f5adf9efc6438aec2a6f31954a481f1a3384fbdadddf1d4
 SHA512:
-  metadata.gz: 6f13aa7ab1389bc50e92ec060f8efd370c00355b871c347d74696d362d5212a53c0a6606b78cbf3c763d18b1d9dd0a1783add010897c201af38371f762af6be8
-  data.tar.gz: d657c5a1c56158c94c7f1b5d366b2d52aa38e9d29fc46e820af96e695ee69494de0464228f4fad6eb2788f410b88c00d55d30092c8effb00d0da5b5609d6c7bd
+  metadata.gz: 6ceba3781efda4b4b60dc66f85ed07a065b47c624d7c6da2fbd42d52bc525cf2b95204d9030aa6e5540e7f6e5e6112b387a40008b29c69236cedcbeb9ae62e69
+  data.tar.gz: '08dcda87123a5e006442cfe574da4ee41c011a28880b559a19bb65871785eb06154ba19f86c00d159c7d0c3e40b22c9758b6a373150de1344a001062fab0cd96'

data/lib/plain_apm/agent.rb

@@ -1,62 +1,82 @@
 # frozen_string_literal: true
 
 require "singleton"
-require "json"
 
 module PlainApm
   class Agent
     include Singleton
 
-    def self.collect(event)
-      instance.collect(event)
+    def enabled?
+      @config && @config.enabled
     end
 
-    def self.start
-      instance.start
-    end
+    def collect(event)
+      return unless enabled?
 
-    def self.stop
-      instance.stop
-    end
+      # stop accepting events when shutting down / shutdown.
+      return if @status != :running
 
-    def collect(event)
-      return unless @config.enabled
+      publisher_start if @pid != $$
 
       @events << event
     end
 
     def start
-      # Already running
-      return unless @publisher.nil?
+      if !defined?(@started)
+        @started = true
+      else
+        return
+      end
 
       configure
 
-      return unless @config.enabled
+      return unless enabled?
+
+      warn("PlainAPM agent enabled.")
+
+      setup_at_exit_hooks
+      publisher_start
+      install_hooks
+    end
+
+    private
+
+    def stop
+      uninstall_hooks
+      publisher_shutdown
+    end
+
+    def publisher_start
+      # Store PID for fork detection
+      @pid = $$
+
+      # Already running
+      return if @publisher&.alive?
 
-      # TODO: sized queue w/ a timeout.
-      @events = Thread::Queue.new
+      # TODO: sized queue.
+      @events = PlainApm::Queue.new
 
       # TODO: Multiple threads
       @publisher = Thread.new { publisher_loop }
 
-      install_hooks
+      @status = :running
+    end
 
-      # TODO: add a cleaner shutdown.
+    def setup_at_exit_hooks
       at_exit { stop }
     end
 
-    def stop
+    def publisher_shutdown
       return if @publisher.nil?
 
-      uninstall_hooks
-
+      # FIXME: raise in / kill the threads after a pre-determined timeout not
+      # to block
+      @status = :shutting_down
       @events << nil
       @publisher.join
       @publisher = nil
     end
 
-    private
-
     def configure
       @config = Config.new
     end
@@ -92,16 +112,38 @@ module PlainApm
         app_key: @config.app_key
       )
 
-      loop do
-        event = @events.pop
-
-        break if event.nil?
+      buf = []
+      timeout = 1.0
 
-        # TODO: event serialization
-        _response, _error, _retriable = transport.deliver(JSON.generate(event))
-
-        # TODO: retries / drops
+      loop do
+        event = @events.pop(timeout: timeout)
+
+        buf << event if event
+
+        case @status
+        when :running
+          # not a timeout or full buffer
+          next if !event.nil? && buf.size < 128
+          send(transport, buf)
+          buf = []
+        when :shutting_down
+          send(transport, buf)
+          buf = []
+          @status = :shutdown
+          break
+        when :shutdown
+          nil
+        else
+          # ?
+        end
       end
     end
+
+    # TODO: retries / drops
+    def send(transport, buf)
+      return if buf.empty?
+      meta = { queue: @events.size, pid: $$, thread: Thread.current.object_id, sent_at: Time.now.to_f }
+      _response, _error, _retriable = transport.deliver(buf, meta)
+    end
   end
 end

data/lib/plain_apm/config.rb

@@ -10,8 +10,6 @@ module PlainApm
       @enabled = enabled? && key_present?
       @endpoint = ENV["PLAIN_APM_ENDPOINT"] || DEFAULT_EVENT_ENDPOINT
       @app_key = ENV["PLAIN_APM_APP_KEY"]
-
-      warn("PlainAPM agent enabled.") if enabled
     end
 
     private

data/lib/plain_apm/event_attributes.rb

@@ -21,34 +21,45 @@ module PlainApm
 
       return [source, nil] if IGNORED_EXCEPTIONS.include?(e.class.name)
 
-      attrs = {
-        "class" => e.class.name,
-        "message" => e.message,
-        "backtrace" => e.backtrace
-      }
+      attrs = context_attributes
+
+      attrs[:class] = e.class.name
+      attrs[:message] = e.message
+      attrs[:backtrace] = e.backtrace
 
       if error_source
-        attrs["event_source"] = error_source
+        attrs[:event_source] = error_source
       end
 
       if context[:env]
-        attrs["params"] = context[:env]["action_dispatch.request.parameters"]
+        attrs[:params] = context[:env]["action_dispatch.request.parameters"]
       end
 
       if context[:job]&.is_a?(ActiveJob::Base)
-        attrs["job_class"] = context[:job].class.name
-        attrs["queue_name"] = context[:job].queue_name
+        attrs[:job_class] = context[:job].class.name
+        attrs[:queue_name] = context[:job].queue_name
+      end
+
+      # https://bugs.ruby-lang.org/issues/19197
+      root_cause = e
+      root_cause = root_cause.cause while root_cause.cause
+
+      if root_cause != e
+        attrs[:root_cause_class] = root_cause.class.name
+        attrs[:root_cause_message] = root_cause.message
+        attrs[:root_cause_backtrace] = root_cause.backtrace
+        loc = source_location(root_cause.backtrace)
+        if !loc.nil?
+          attrs[:root_cause_location] = loc
+        end
       end
 
-      if e.cause
-        attrs.merge!({
-          "cause_class" => e.cause.class.name,
-          "cause_message" => e.cause.message,
-          "cause_backtrace" => e.cause.backtrace
-        })
+      loc = source_location(e.backtrace)
+      if !loc.nil?
+        attrs[:source_location] = loc
       end
 
-      attrs.merge!(trace_attributes(source))
+      add_trace_attributes(attrs)
 
       [source, attrs]
     end
@@ -57,70 +68,73 @@ module PlainApm
       name, source = *event.name.split(".")
       loc = source_location
 
-      attrs = {
-        "source" => source,
-        "name" => name,
-        "allocations" => event.allocations,
-        "event_time" => event.time,
-        "duration" => event.duration
-      }
+      attrs = context_attributes
 
-      attrs["thread_allocations"] = event.thread_allocations if event.respond_to?(:thread_allocations)
-      attrs["source_location"] = loc if !loc.nil?
+      attrs[:source] = source
+      attrs[:name] = name
+      attrs[:allocations] = event.allocations
+      attrs[:event_time] = event.time
+      attrs[:duration] = event.duration
 
-      attrs.merge!(trace_attributes(source))
+      if event.respond_to?(:thread_allocations)
+        attrs[:thread_allocations] = event.thread_allocations
+      end
+
+      if !loc.nil?
+        attrs[:source_location] = loc
+      end
+
+      add_trace_attributes(attrs)
 
       [name, attrs]
     end
 
     private
 
-    def trace_attributes(source)
-      process_attributes.merge(context_attributes)
-    end
-
-    def process_attributes
-      {
-        "thread_id" => Thread.current.object_id,
-        "collected_at" => Time.now.iso8601(9),
-        # TODO: There is a perf cost in Rubies until 3.3, so it might be a good
-        # idea to cache this. See https://bugs.ruby-lang.org/issues/19443 for
-        # the feature.
-        "pid" => Process.pid,
-        "version" => PlainApm::VERSION
-      }.merge(
-        cached_attributes
-      )
+    # TODO: There is a perf cost in Rubies for Process.pid until 3.3, so it
+    # might be a good idea to cache this. See
+    # https://bugs.ruby-lang.org/issues/19443 for the feature.
+    def add_trace_attributes(attrs)
+      attrs[:thread_id] = Thread.current.object_id
+      attrs[:collected_at] = Time.now.to_f
+      attrs[:pid] = Process.pid
+      attrs[:version] = PlainApm::VERSION
+      attrs[:hostname] = cached_attributes[:hostname]
+      attrs[:revision] = cached_attributes[:revision]
     end
 
     def cached_attributes
       @cached_attributes ||= {
-        "hostname" => Socket.gethostname,
-        "revision" => PlainApm::DeployTracking.revision
+        hostname: Socket.gethostname,
+        revision: PlainApm::DeployTracking.revision
       }
     end
 
+    ##
+    # 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.
     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.transform_keys(&:to_s)
+        PlainApm::Extensions::Context.current.dup
       else
         {}
       end
     end
 
-    def source_location
-      filtered_backtrace&.first
+    def source_location(backtrace = nil)
+      return if self.class.rails_root.nil?
+      call = (backtrace || caller).find { |frame| frame.start_with?(self.class.rails_root) } || return
+      call[(self.class.rails_root.size + 1)..-1]
     end
 
-    def filtered_backtrace
-      if defined?(Rails) && defined?(Rails::BacktraceCleaner)
-        @cleaner ||= Rails::BacktraceCleaner.new
-        @cleaner.clean(caller)
+    def self.included(other)
+      other.class_eval do
+        def self.rails_root
+          return @rails_root if defined?(@rails_root)
+          @rails_root = (defined?(Rails) && Rails.root.to_s.present?) ? Rails.root.to_s.freeze : nil
+        end
       end
     end
   end

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

@@ -7,27 +7,21 @@
 #
 # See LICENSE.txt in the current directory for the license.
 
-begin
-  require "rails/railtie"
-rescue LoadError
-  nil
-end
-
 module PlainApm
   module Extensions
     module Context
-      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
+      class Railtie < Rails::Railtie
+        initializer(:plain_apm_thread_context, after: :plain_apm_agent_start) do |app|
+          next if !PlainApm.agent.enabled?
+
+          ActiveSupport.on_load(:active_job, run_once: true) 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
+          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

data/lib/plain_apm/extensions/context.rb

@@ -1,3 +1,7 @@
+require_relative "context/rack"
+require_relative "context/active_job"
+require_relative "context/railtie" if defined?(Rails::Railtie)
+
 module PlainApm
   module Extensions
     module Context

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

@@ -26,7 +26,7 @@ module PlainApm
 
       ##
       # Allow tracing request ID through jobs
-      ActiveSupport.on_load(:active_job) do |klass|
+      ActiveSupport.on_load(:active_job, run_once: true) do |klass|
         klass.prepend(ActiveJob)
       end
     end

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

@@ -29,8 +29,8 @@ module PlainApm
 
           return if event.nil?
 
-          event["source"] = source
-          event["name"] = "rack_middleware"
+          event[:source] = source
+          event[:name] = "rack_middleware"
 
           PlainApm.agent.collect(event)
         end

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

@@ -1,19 +1,13 @@
 # frozen_string_literal: true
 
-begin
-  require "rails/railtie"
-rescue LoadError
-  nil
-end
-
 module PlainApm
   module Extensions
     module Exceptions
-      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
+      class Railtie < Rails::Railtie
+        initializer(:plain_apm_exceptions_middleware, after: :plain_apm_agent_start) do |app|
+          next if !PlainApm.agent.enabled?
+
+          app.config.middleware.insert(0, PlainApm::Extensions::Exceptions::Rack)
         end
       end
     end

data/lib/plain_apm/extensions/exceptions.rb

@@ -0,0 +1,3 @@
+require_relative "exceptions/rack"
+require_relative "exceptions/railtie" if defined?(Rails::Railtie)
+

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

@@ -16,14 +16,8 @@ module PlainApm
           @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
+        def now_thread_allocations
+          PlainApm::ObjectTracing.total_thread_allocated_objects
         end
       end
     end

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

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
-begin
-  require "rails/railtie"
-rescue LoadError
-  nil
-end
-
 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
+      class Railtie < Rails::Railtie
+        initializer(:plain_apm_thread_allocationss, after: :plain_apm_agent_start) do
+          next if !PlainApm.agent.enabled?
+
+          require "object_tracing"
+
+          ActiveSupport::Notifications::Event.prepend(
+            PlainApm::Extensions::ThreadAllocations::ActiveSupportEvent
+          )
         end
       end
     end

data/lib/plain_apm/extensions/thread_allocations.rb

@@ -0,0 +1,2 @@
+require_relative "thread_allocations/active_support_event"
+require_relative "thread_allocations/railtie" if defined?(Rails::Railtie)

data/lib/plain_apm/helpers.rb

@@ -1,12 +1,13 @@
 module PlainApm
   module Helpers
     def plain_apm_context(context = {})
+      return unless PlainApm.agent.enabled?
       PlainApm::Extensions::Context.context.merge!(context)
     end
 
     def plain_apm_instrument(name, context = {}, &block)
+      return unless PlainApm.agent.enabled? && defined?(ActiveSupport::Notifications)
       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_mailer.rb

@@ -17,16 +17,18 @@ module PlainApm
 
         case name
         when "deliver"
-          base.merge({
-            "message_id" => payload[:message_id],
-            "mailer" => payload[:mailer],
-            "perform_deliveries" => payload[:perform_deliveries]
-          })
+          base.tap do |o|
+            o[:message_id] = payload[:message_id]
+            o[:mailer] = payload[:mailer]
+            o[:perform_deliveries] = payload[:perform_deliveries]
+          end
         when "process"
-          base.merge({
-            "mailer" => payload[:mailer],
-            "action" => payload[:action]
-          })
+          base.tap do |o|
+            o[:mailer] = payload[:mailer]
+            o[:action] = payload[:action]
+          end
+        else
+          nil
         end
       end
     end

data/lib/plain_apm/hooks/action_pack.rb

@@ -17,20 +17,22 @@ module PlainApm
 
         case name
         when "process_action"
-          base.merge({
-            "controller" => payload[:controller],
-            "action" => payload[:action],
-            "params" => payload[:params],
-            "format" => payload[:format],
-            "method" => payload[:method],
-            "path" => payload[:path],
-            "status" => payload[:status]
-          })
+          base.tap do |o|
+            o[:controller] = payload[:controller]
+            o[:action] = payload[:action]
+            o[:params] = payload[:params]
+            o[:format] = payload[:format]
+            o[:method] = payload[:method]
+            o[:path] = payload[:path]
+            o[:status] = payload[:status]
+          end
         when "redirect_to", "start_processing", "halted_callback", "send_file", "send_data"
           nil
         when "read_fragment", "write_fragment", "exist_fragment?", "expire_fragment"
           # controller, action, key
           nil
+        else
+          nil
         end
       end
     end

data/lib/plain_apm/hooks/action_view.rb

@@ -17,27 +17,29 @@ module PlainApm
 
         case name
         when "render_collection"
-          base.merge({
-            "identifier" => identifier(payload[:identifier]),
-            "layout" => payload[:layout],
-            "count" => payload[:count],
-            "cache_hits" => payload[:cache_hits]
-          })
+          base.tap do |o|
+            o[:identifier] = identifier(payload[:identifier])
+            o[:layout] = payload[:layout]
+            o[:count] = payload[:count]
+            o[:cache_hits] = payload[:cache_hits]
+          end
         when "render_layout"
-          base.merge({
-            "identifier" => identifier(payload[:identifier])
-          })
+          base.tap do |o|
+            o[:identifier] = identifier(payload[:identifier])
+          end
         when "render_template"
-          base.merge({
-            "identifier" => identifier(payload[:identifier]),
-            "layout" => payload[:layout]
-          })
+          base.tap do |o|
+            o[:identifier] = identifier(payload[:identifier])
+            o[:layout] = payload[:layout]
+          end
         when "render_partial"
-          base.merge({
-            "identifier" => identifier(payload[:identifier]),
-            "layout" => payload[:layout],
-            "cache_hit" => payload[:cache_hit]
-          })
+          base.tap do |o|
+            o[:identifier] = identifier(payload[:identifier])
+            o[:layout] = payload[:layout]
+            o[:cache_hit] = payload[:cache_hit]
+          end
+        else
+          nil
         end
       end
 

data/lib/plain_apm/hooks/active_job.rb

@@ -16,33 +16,35 @@ module PlainApm
         payload = event.payload
         job = payload[:job]
 
-        base.merge!({
-          "queue_name" => job.queue_name,
-          "job_id" => job.job_id,
-          "job_class" => job.class.name,
-          "job_arguments" => job.arguments,
-          "executions" => job.executions,
-          "enqueued_at" => enqueued_at(job),
-          "dequeued_at" => dequeued_at(job),
-          "scheduled_at" => job.scheduled_at,
-          "adapter" => payload[:adapter].class.name,
-          "aborted" => payload[:aborted]
-        })
+        base.tap do |o|
+          o[:queue_name] = job.queue_name
+          o[:job_id] = job.job_id
+          o[:job_class] = job.class.name
+          o[:job_arguments] = job.arguments
+          o[:executions] = job.executions
+          o[:enqueued_at] = enqueued_at(job)
+          o[:dequeued_at] = dequeued_at(job)
+          o[:scheduled_at] = job.scheduled_at
+          o[:adapter] = payload[:adapter].class.name
+          o[:aborted] = payload[:aborted]
+        end
 
         case name
         when "enqueue", "enqueue_at", "perform"
           base
         when "enqueue_retry"
-          base.merge({
-            "error" => payload[:error],
-            "wait" => payload[:wait]
-          })
+          base.tap do |o|
+            o[:error] = payload[:error]
+            o[:wait] = payload[:wait]
+          end
         when "retry_stopped", "discard"
-          base.merge({
-            "error" => payload[:error]
-          })
+          base.tap do |o|
+            o[:error] = payload[:error]
+          end
         when "perform_start"
           nil
+        else
+          nil
         end
       end
 

data/lib/plain_apm/hooks/active_record.rb

@@ -22,9 +22,17 @@ module PlainApm
 
         case name
         when "sql"
-          base.merge({"sql" => payload[:sql], "sql_name" => payload[:name]})
+          base.tap do |o|
+            o[:sql] = payload[:sql]
+            o[:sql_name] = payload[:name]
+          end
         when "instantiation"
-          base.merge({"class_name" => payload[:class_name], "record_count" => payload[:record_count]})
+          base.tap do |o|
+            o[:class_name] = payload[:class_name]
+            o[:record_count] = payload[:record_count]
+          end
+        else
+          nil
         end
       end
     end

data/lib/plain_apm/hooks/active_support.rb

@@ -15,34 +15,36 @@ module PlainApm
         name, base = attributes_from_notification(event)
         payload = event.payload
 
-        base["store"] = payload[:store]
+        base[:store] = payload[:store]
 
         case name
         when "cache_read"
-          base.merge({
-            "key" => payload[:key],
-            "hit" => payload[:hit],
-            "trigger" => payload[:super_operation]
-          })
+          base.tap do |o|
+            o[:key] = payload[:key]
+            o[:hit] = payload[:hit]
+            o[:trigger] = payload[:super_operation]
+          end
         when "cache_read_multi"
-          base.merge({
-            "keys" => payload[:key],
-            "hits" => payload[:hits]
-          })
+          base.tap do |o|
+            o[:keys] = payload[:key]
+            o[:hits] = payload[:hits]
+          end
         when "cache_fetch_hit"
-          base.merge({
-            "key" => payload[:key],
-            "hit" => true
-          })
+          base.tap do |o|
+            o[:key] = payload[:key]
+            o[:hit] = true
+          end
         when "cache_write", "cache_write_multi", "cache_generate", "cache_delete", "cache_delete_matched", "cache_exist?"
-          base.merge({
-            "key" => payload[:key]
-          })
+          base.tap do |o|
+            o[:key] = payload[:key]
+          end
         when "cache_increment", "cache_decrement"
-          base.merge({
-            "key" => payload[:key],
-            "amount" => payload[:amount]
-          })
+          base.tap do |o|
+            o[:key] = payload[:key]
+            o[:amount] = payload[:amount]
+          end
+        else
+          nil
         end
       end
     end

data/lib/plain_apm/hooks/active_support_subscriber.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-begin
-  require "active_support"
-  require "active_support/notifications"
-rescue LoadError
-  nil
-end
-
 module PlainApm
   module Hooks
     class ActiveSupportSubscriber

data/lib/plain_apm/hooks/error_reporter.rb

@@ -27,8 +27,8 @@ module PlainApm
 
         return if event.nil?
 
-        event["source"] = event_source
-        event["name"] = "error_reporter"
+        event[:source] = event_source
+        event[:name] = "error_reporter"
 
         ::PlainApm.agent.collect(event)
       end

data/lib/plain_apm/hooks/manual.rb

@@ -14,12 +14,12 @@ module PlainApm
       def payload(event)
         name, base = attributes_from_notification(event)
 
-        base.merge({
-          "source" => "user",
-          "name" => "manual",
-          "payload_name" => name,
-          "payload" => event.payload
-        })
+        base.tap do |o|
+          o[:source] = "user"
+          o[:name] = "manual"
+          o[:payload_name] = name
+          o[:payload] = event.payload
+        end
       end
     end
   end

data/lib/plain_apm/queue.rb

@@ -0,0 +1,123 @@
+module PlainApm
+  if RUBY_VERSION >= "3.2.0"
+    Queue = Thread::Queue
+  else
+    # The queue is made to conform to the ruby/spec
+    class Queue
+      ClosedQueueError = Class.new(StopIteration)
+
+      def initialize(initial = nil)
+        @data = []
+        @num_waiting = 0
+        @closed = false
+        @mutex = Mutex.new
+        @cv = ConditionVariable.new
+
+        return if initial.nil?
+
+        raise TypeError, "can't convert #{initial.class} into Array" unless initial.respond_to?(:to_a)
+
+        elems = initial.to_a
+        raise TypeError, "can't convert #{initial.class} into Array (#{initial.class}#to_a gives #{elems.class})" unless elems.is_a?(Array)
+
+        @data.concat(elems)
+      end
+
+      def close
+        @mutex.synchronize do
+          return if @closed
+          @closed = true
+          # Wake up everyone waiting on this.
+          @cv.broadcast
+        end
+      end
+
+      def closed?
+        @closed
+      end
+
+      def clear
+        @data = []
+      end
+
+      def num_waiting
+        @num_waiting
+      end
+
+      def empty?
+        @data.empty?
+      end
+
+      def length
+        @data.length
+      end
+
+      alias_method :size, :length
+
+      def push(obj)
+        @mutex.synchronize do
+          raise ClosedQueueError if closed?
+          @data << obj
+          @cv.signal
+        end
+      end
+
+      alias_method :<<, :push
+      alias_method :enq, :push
+
+      def pop(non_block = false, timeout: nil)
+        if non_block && timeout
+          raise ArgumentError, "can't set a timeout if non_block is enabled"
+        end
+
+        if !timeout.nil? && !timeout.is_a?(Numeric)
+          raise TypeError, "no implicit conversion to float from #{timeout.class.name.downcase}"
+        end
+
+        @mutex.synchronize do
+          # The data is there.
+          return @data.shift if !@data.empty?
+
+          # Non block raises on empty queue
+          raise ThreadError, "queue empty" if non_block
+
+          # 0 means immediate timeout. Closed empty queue also immediately returns a nil
+          return nil if timeout == 0 || @closed
+
+          # Blocking and open. Let's wait.
+          timeout_at = timeout.nil? ? nil : now + timeout.to_f
+
+          begin
+            # We could keep the threads in an array, but a counter should do as well.
+            @num_waiting += 1
+
+            while @data.empty? && !@closed
+              if timeout_at.nil?
+                # Wait indefinitely.
+                @cv.wait(@mutex)
+              else
+                # Wait for what's left of the deadline
+                break if (left = timeout_at - now) <= 0.0
+                @cv.wait(@mutex, left)
+              end
+            end
+          ensure
+            @num_waiting -= 1
+          end
+
+          # Return whatever is there now, or nil (if timed out)
+          @data.shift
+        end
+      end
+
+      alias_method :deq, :pop
+      alias_method :shift, :pop
+
+      private
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/plain_apm/transport.rb

@@ -2,6 +2,7 @@
 
 require "net/http"
 require "json"
+require "zlib"
 
 module PlainApm
   class Transport
@@ -16,7 +17,7 @@ module PlainApm
     HTTP_TIMEOUTS = [
       Net::OpenTimeout,
       Net::ReadTimeout,
-      RUBY_VERSION >= "2.6.0" ? Net::WriteTimeout : nil
+      Net::WriteTimeout
     ].compact.freeze
 
     ERRNO_ERRORS = [
@@ -47,10 +48,7 @@ module PlainApm
 
       http.open_timeout = HTTP_OPEN_TIMEOUT_SECONDS
       http.read_timeout = HTTP_READ_TIMEOUT_SECONDS
-
-      if RUBY_VERSION >= "2.6.0"
-        http.write_timeout = HTTP_WRITE_TIMEOUT_SECONDS
-      end
+      http.write_timeout = HTTP_WRITE_TIMEOUT_SECONDS
 
       at_exit { shutdown }
     end
@@ -60,9 +58,9 @@ module PlainApm
     #
     # @param data [String] serialized payload to POST
     # @return [Array] [response, error, retriable]
-    def deliver(data)
+    def deliver(data, meta = {})
       http_response do
-        http_request(http, uri.path, data)
+        http_request(http, uri.path, data, meta)
       end
     end
 
@@ -82,16 +80,21 @@ module PlainApm
       http.finish if http.started?
     end
 
-    def http_request(http, path, body)
-      request = Net::HTTP::Post.new(path, http_headers)
-      http.request(request, body)
+    def http_request(http, path, body, meta)
+      request = Net::HTTP::Post.new(path, http_headers(meta))
+      http.request(request, Zlib::Deflate.deflate(JSON.generate(body)))
     end
 
-    def http_headers
+    def http_headers(meta)
+      meta_headers = meta.map do |k, v|
+        ["X-PlainApm-#{k.to_s.split("_").map(&:capitalize).join("-")}", v.to_s]
+      end.to_h
+
       {
         "Content-Type" => "application/json, charset=UTF-8",
+        "Content-Encoding" => "gzip",
         "X-PlainApm-Key" => app_key
-      }
+      }.merge(meta_headers)
     end
 
     def http_response

data/lib/plain_apm/version.rb

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

data/lib/plain_apm.rb

@@ -1,13 +1,31 @@
 # frozen_string_literal: true
 
+# Rails deps
+begin
+  require "active_support"
+  require "active_support/notifications"
+  require "rails/railtie"
+rescue LoadError
+  nil
+end
+
 require_relative "plain_apm/version"
 require_relative "plain_apm/transport"
+require_relative "plain_apm/queue"
 require_relative "plain_apm/config"
 require_relative "plain_apm/agent"
 require_relative "plain_apm/deploy_tracking"
 require_relative "plain_apm/event_attributes"
+require_relative "plain_apm/helpers"
+
+# Per thread context for request IDs / job IDs.
+require_relative "plain_apm/extensions/context"
 
-require "object_tracing"
+# Rack exceptions. Activate the middleware if in Rails.
+require_relative "plain_apm/extensions/exceptions"
+
+# Per thread allocations in ASN events
+require_relative "plain_apm/extensions/thread_allocations"
 
 # Rails instrumentation. The hooks won't install unless
 # ActiveSupport::Notifications is loaded.
@@ -21,23 +39,6 @@ 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
   # Allow swapping out the Agent for a synchronous, in-memory implementation in
   # the tests.
@@ -49,16 +50,12 @@ module PlainApm
     @@agent ||= Agent.instance
   end
 
-  begin
-    require "rails/railtie"
-  rescue LoadError
-    nil
-  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 }
+      # allows reading settings from ENV vars set in config/initializers.
+      initializer(:plain_apm_agent_start, after: :load_config_initializers) do
+        PlainApm.agent.start
+      end
     end
   else
     PlainApm.agent.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plain_apm
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - PlainAPM Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -107,9 +107,11 @@ files:
 - 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.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
@@ -122,6 +124,7 @@ files:
 - lib/plain_apm/hooks/active_support_subscriber.rb
 - lib/plain_apm/hooks/error_reporter.rb
 - lib/plain_apm/hooks/manual.rb
+- lib/plain_apm/queue.rb
 - lib/plain_apm/transport.rb
 - lib/plain_apm/version.rb
 homepage: https://plainapm.com