plain_apm 0.6.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e97786261500cb8d3f51d59adcf10e16fae25ec9d75abb892f9f484e6a8f301e
-  data.tar.gz: 81d5e828c98ab00c203d429e963c6ad54c39a81e5ac21c21f84400e0daed0287
+  metadata.gz: 2b4d2bddabd031b2b17d2edcf27e32f323c217b2331c469072e95d0afeb58ec7
+  data.tar.gz: a892bbd62da4a10b074046c39326576355d591bf02982f9d336a97d887f99bc6
 SHA512:
-  metadata.gz: 0b967abf825f2a5e11c7318a207cfe7d254142999e80d255cd991802a85527fd89957c6819c0ef42a6e6887cb83c2084193c8cad760f906b8981b4514cae1b72
-  data.tar.gz: 7db71b4417c755e4146ea5a9824f926dcc548b6a0de9952eaa752917fd85078af651f357acbd78c2900c89c4bf30df4183ef5ab67b5c7028f2591dc5e19a847a
+  metadata.gz: b523dbaea426bbb9f2e4c2808efb4937ebf5c842361d07c9a0ae6a23bef03fe8bef0a71815710b4c55a7f8a1eeaea01e8b0fbe01bb3ed9af58743a31aa09c0aa
+  data.tar.gz: 93c110b5e728cd6e934cbb25e56bd5345e3cc45dc1776922ca39a5de902e19a996fcc2aa7de0c749b231e8faf137b16be49f1d9389bec1735986223f18bc6798

data/ext/object_tracing/extconf.rb

@@ -1,6 +1,6 @@
-require 'mkmf'
+require "mkmf"
 
-have_header('ruby/ruby.h') or missing('ruby/ruby.h')
-have_header('ruby/debug.h') or missing('ruby/debug.h')
+have_header("ruby/ruby.h") or missing("ruby/ruby.h")
+have_header("ruby/debug.h") or missing("ruby/debug.h")
 
-create_makefile('object_tracing')
+create_makefile("object_tracing")

data/lib/plain_apm/agent.rb

@@ -19,23 +19,6 @@ module PlainApm
     def collect(event)
       return unless @config.enabled
 
-      ##
-      # 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)
-        event.merge!(PlainApm::Extensions::Context.current)
-      end
-
-      event.merge!(
-        "version" => PlainApm::VERSION,
-        "collected_at" => Time.now.utc.to_f,
-        "hostname" => Socket.gethostname,
-        "pid" => Process.pid,
-        "thread_id" => Thread.current.object_id.to_s,
-      )
-
       @events << event
     end
 

data/lib/plain_apm/event_attributes.rb

@@ -0,0 +1,131 @@
+module PlainApm
+  module EventAttributes
+    SOURCES_WITH_HOST_ATTRIBUTES = %w[
+      action_controller
+      action_mailer
+      active_job
+      deploy
+      exception
+    ].freeze
+
+    # FIXME: This is duplicated for ErrorReporter
+    IGNORED_EXCEPTIONS = [
+      "Sidekiq::JobRetry::Skip", # Sidekiq uses exceptions for control flow.
+      "ActionController::RoutingError" # Rails unmapped route, raised before the request hits the app.
+    ].freeze
+
+    def attributes_from_deploy(tool, revision)
+      source = "deploy"
+
+      attrs = {
+        "source" => source,
+        "revision" => revision,
+        "name" => tool
+      }
+
+      attrs.merge!(agent_attributes)
+      attrs.merge!(host_attributes) if add_host_attributes?(source)
+
+      [tool, attrs]
+    end
+
+    def attributes_from_exception(e, context)
+      source = "exception"
+
+      return [source, nil] if IGNORED_EXCEPTIONS.include?(e.class.name)
+
+      attrs = {
+        "class" => e.class.name,
+        "message" => e.message,
+        "backtrace" => e.backtrace
+      }
+
+      if context[:env]
+        attrs["params"] = 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
+      end
+
+      if e.cause
+        attrs.merge!({
+          "cause_class" => e.cause.class.name,
+          "cause_message" => e.cause.message,
+          "cause_backtrace" => e.cause.backtrace
+        })
+      end
+
+      attrs.merge!(context_attributes, agent_attributes)
+      attrs.merge!(host_attributes) if add_host_attributes?(source)
+
+      [source, attrs]
+    end
+
+    def attributes_from_notification(event)
+      name, source = *event.name.split(".")
+      loc = source_location
+
+      attrs = {
+        "source" => source,
+        "name" => name,
+        "allocations" => event.allocations,
+        "thread_allocations" => event.thread_allocations,
+        "started_at" => event.time,
+        "finished_at" => event.end
+      }
+
+      attrs["source_location"] = loc if !loc.nil?
+      attrs.merge!(context_attributes, agent_attributes)
+      attrs.merge!(host_attributes) if add_host_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
+    end
+
+    def agent_attributes
+      {
+        "version" => PlainApm::VERSION
+      }
+    end
+
+    def host_attributes
+      {
+        "collected_at" => Time.now.iso8601(9),
+        "hostname" => Socket.gethostname,
+        "pid" => Process.pid,
+        "thread_id" => Thread.current.object_id
+      }
+    end
+
+    def add_host_attributes?(source)
+      SOURCES_WITH_HOST_ATTRIBUTES.include?(source)
+    end
+
+    def source_location
+      filtered_backtrace&.first
+    end
+
+    def filtered_backtrace
+      if defined?(Rails) && defined?(Rails::BacktraceCleaner)
+        @cleaner ||= Rails::BacktraceCleaner.new
+        @cleaner.clean(caller)
+      end
+    end
+  end
+end

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

@@ -4,11 +4,7 @@ module PlainApm
   module Extensions
     module Exceptions
       class Rack
-        # FIXME: This is duplicated for ErrorReporter
-        IGNORED_EXCEPTIONS = [
-          "Sidekiq::JobRetry::Skip",          # Sidekiq uses exceptions for control flow.
-          "ActionController::RoutingError"    # Rails unmapped route, raised before the request hits the app.
-        ].freeze
+        include EventAttributes
 
         def initialize(app)
           @app = app
@@ -29,24 +25,12 @@ module PlainApm
         private
 
         def report_exception(e, env)
-          return if IGNORED_EXCEPTIONS.include?(e.class.name)
-
-          event = {
-            "source" => "exception",
-            "name" => "rack_middleware",
-            "class" => e.class.name,
-            "message" => e.message,
-            "backtrace" => e.backtrace,
-            "params" => env["action_dispatch.request.parameters"]
-          }
-
-          if e.cause
-            event.merge!({
-              "cause_class" => e.cause.class.name,
-              "cause_message" => e.cause.message,
-              "cause_backtrace" => e.cause.backtrace
-            })
-          end
+          source, event = attributes_from_exception(e, {env: env})
+
+          return if event.nil?
+
+          event["source"] = source
+          event["name"] = "rack_middleware"
 
           PlainApm::Agent.collect(event)
         end

data/lib/plain_apm/helpers.rb

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

data/lib/plain_apm/hooks/action_mailer.rb

@@ -12,19 +12,9 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
         payload = event.payload
 
-        base = {
-          "source" => source,
-          "name" => name,
-          "backtrace" => filtered_backtrace,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations,
-          "started_at" => event.time,
-          "finished_at" => event.end
-        }
-
         case name
         when "deliver"
           base.merge({

data/lib/plain_apm/hooks/action_pack.rb

@@ -12,19 +12,9 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
         payload = event.payload
 
-        base = {
-          "source" => source,
-          "name" => name,
-          "backtrace" => filtered_backtrace,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations,
-          "started_at" => event.time,
-          "finished_at" => event.end
-        }
-
         case name
         when "process_action"
           base.merge({

data/lib/plain_apm/hooks/action_view.rb

@@ -12,19 +12,9 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
         payload = event.payload
 
-        base = {
-          "source" => source,
-          "name" => name,
-          "backtrace" => filtered_backtrace,
-          "started_at" => event.time,
-          "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations
-        }
-
         case name
         when "render_collection"
           base.merge({

data/lib/plain_apm/hooks/active_job.rb

@@ -12,18 +12,11 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
         payload = event.payload
         job = payload[:job]
 
-        base = {
-          "source" => source,
-          "name" => name,
-          "backtrace" => filtered_backtrace,
-          "started_at" => event.time,
-          "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations,
+        base.merge!({
           "queue_name" => job.queue_name,
           "job_id" => job.job_id,
           "job_class" => job.class.name,
@@ -34,7 +27,7 @@ module PlainApm
           "scheduled_at" => job.scheduled_at,
           "adapter" => payload[:adapter].class.name,
           "aborted" => payload[:aborted]
-        }
+        })
 
         case name
         when "enqueue", "enqueue_at", "perform"

data/lib/plain_apm/hooks/active_record.rb

@@ -6,6 +6,7 @@ module PlainApm
   module Hooks
     class ActiveRecord < ActiveSupportSubscriber
       NOTIFICATION_PATTERN = /\A[^!]\w+\.active_record\Z/.freeze
+      IGNORED_SQL_NAMES = %w[SCHEMA CACHE].freeze
 
       private
 
@@ -14,25 +15,14 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
         payload = event.payload
 
-        base = {
-          "source" => source,
-          "name" => name,
-          "backtrace" => filtered_backtrace,
-          "started_at" => event.time,
-          "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations
-        }
+        return if IGNORED_SQL_NAMES.include?(payload[:name])
 
         case name
         when "sql"
-          base.merge({
-            "sql_name" => payload[:name],
-            "sql" => payload[:sql]
-          })
+          base.merge({"sql" => payload[:sql]})
         end
       end
     end

data/lib/plain_apm/hooks/active_support.rb

@@ -3,7 +3,7 @@
 module PlainApm
   module Hooks
     class ActiveSupport < ActiveSupportSubscriber
-      NOTIFICATION_PATTERN = /\Acache_[\w\?]+\.active_support\Z/.freeze
+      NOTIFICATION_PATTERN = /\Acache_[\w?]+\.active_support\Z/.freeze
 
       private
 
@@ -12,26 +12,17 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
         payload = event.payload
 
-        base = {
-          "source" => source,
-          "name" => name,
-          "backtrace" => filtered_backtrace,
-          "started_at" => event.time,
-          "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations,
-          "store" => payload[:store]
-        }
+        base["store"] = payload[:store]
 
         case name
         when "cache_read"
           base.merge({
             "key" => payload[:key],
             "hit" => payload[:hit],
-            "trigger" => payload[:super_operation],
+            "trigger" => payload[:super_operation]
           })
         when "cache_read_multi"
           base.merge({

data/lib/plain_apm/hooks/active_support_subscriber.rb

@@ -3,6 +3,8 @@
 module PlainApm
   module Hooks
     class ActiveSupportSubscriber
+      include EventAttributes
+
       def install
         begin
           require "active_support/notifications"
@@ -26,7 +28,7 @@ module PlainApm
 
         return if payload.nil?
 
-        Agent.instance.collect(payload)
+        Agent.collect(payload)
       end
 
       private
@@ -38,13 +40,6 @@ module PlainApm
       def payload(event)
         raise "Not implemented"
       end
-
-      def filtered_backtrace
-        if defined?(Rails) && defined?(Rails::BacktraceCleaner)
-          @cleaner ||= Rails::BacktraceCleaner.new
-          @cleaner.clean(caller)
-        end
-      end
     end
   end
 end

data/lib/plain_apm/hooks/deploy.rb

@@ -6,6 +6,8 @@ module PlainApm
   # for performance regressions.
   module Hooks
     class Deploy
+      include EventAttributes
+
       ##
       # Collect once, immediately on install.
       def install
@@ -15,17 +17,9 @@ module PlainApm
       def collect
         result = git_revision || hg_revision || return
 
-        tool, revision = *result
-
-        Agent.instance.collect(
-          {
-            "source" => "deploy",
-            "revision" => revision,
-            "name" => tool,
-            "started_at" => Time.now.to_f,
-            "finished_at" => Time.now.to_f
-          }
-        )
+        _, attrs = attributes_from_deploy(*result)
+
+        Agent.collect(attrs)
       end
 
       private

data/lib/plain_apm/hooks/error_reporter.rb

@@ -2,10 +2,7 @@ module PlainApm
   module Hooks
     # Rails 7 error notification mechanism
     class ErrorReporter
-      IGNORED_EXCEPTIONS = [
-        "Sidekiq::JobRetry::Skip",          # Sidekiq uses exceptions for control flow.
-        "ActionController::RoutingError"    # Rails unmapped route, raised before the request hits the app.
-      ].freeze
+      include EventAttributes
 
       def install
         begin
@@ -23,33 +20,12 @@ module PlainApm
       end
 
       def collect(e, handled:, severity:, context: {})
-        return if IGNORED_EXCEPTIONS.include?(e.class.name)
+        source, event = attributes_from_exception(e, context)
 
-        event = {
-          "source" => "exception",
-          "name" => "error_reporter",
-          "class" => e.class.name,
-          "message" => e.message,
-          "backtrace" => e.backtrace,
-          "handled" => handled,
-          "severity" => severity,
-          "context" => context
-        }
+        return if event.nil?
 
-        if context[:job] && context[:job].is_a?(ActiveJob::Base)
-          event.merge!({
-            "job_class" => context[:job].class.name,
-            "queue_name" => context[:job].queue_name
-          })
-        end
-
-        if e.cause
-          event.merge!({
-            "cause_class" => e.cause.class.name,
-            "cause_message" => e.cause.message,
-            "cause_backtrace" => e.cause.backtrace
-          })
-        end
+        event["source"] = source
+        event["name"] = "error_reporter"
 
         PlainApm::Agent.collect(event)
       end

data/lib/plain_apm/hooks/manual.rb

@@ -12,19 +12,14 @@ module PlainApm
       end
 
       def payload(event)
-        name, source = *event.name.split(".")
+        name, base = attributes_from_notification(event)
 
-        {
+        base.merge({
           "source" => "user",
           "name" => "manual",
-          "backtrace" => filtered_backtrace,
-          "started_at" => event.time,
-          "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "thread_allocations" => event.thread_allocations,
           "payload_name" => name,
           "payload" => event.payload
-        }
+        })
       end
     end
   end

data/lib/plain_apm/version.rb

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

data/lib/plain_apm.rb

@@ -4,6 +4,7 @@ require_relative "plain_apm/version"
 require_relative "plain_apm/transport"
 require_relative "plain_apm/config"
 require_relative "plain_apm/agent"
+require_relative "plain_apm/event_attributes"
 
 require "object_tracing"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plain_apm
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.7.0
 platform: ruby
 authors:
 - PlainAPM Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -99,6 +99,7 @@ files:
 - 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