plain_apm 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef383306da20d00a0bc5c8b2072b1dfbb3d49eb7c5d1f0710cee6d6749b726d2
-  data.tar.gz: b5c174eb5869f5909695af612182f2e9e6fe960230ce4ecd2d94b4701c5856fc
+  metadata.gz: fae5b33c61e3205e05e0321b6e2189f458095998d466c5f8f3494902eb279f26
+  data.tar.gz: 0e46fdbd9c5a3e7c6a41c4e75767046a03811c7d6c0af8688f72e14b5dce1a4e
 SHA512:
-  metadata.gz: 86dc64bd65c57fc77f4713f10bf08beeff9f32c7f9e80e3fc454b4462ff14a4cfc0613bd24879d2ec08e2692e9e35eb3ccad49b015cbfc3e331e9bcbdf4e45b9
-  data.tar.gz: 6f79c406f73217c44c06a46359722fb1ecb8d8c72e1c6de8ed5846992cab12ba56dc4c36fac18919896ab1f002a98129301d28cefde8502ccd32d7f6319f82c6
+  metadata.gz: 10f006bfd8ef860ca46a4af5656f99665c0de125d41d611a07678364650e50de6ca0b45cb34f2962a6344f6425ec8cf47af93c512bad50c2f712eca0bd3a9f65
+  data.tar.gz: 8f6d46f2e471fe8f5a917ececcee37db2f0c6e056e62f0320eb17797424ec86a73a43b942b54fd2e619becfdd0725705f8af3d3a299e8a5c6aab4ea1499de3b7

data/lib/plain_apm/agent.rb

@@ -18,11 +18,23 @@ module PlainApm
     def collect(event)
       return unless @config.enabled
 
-      @events << event.merge(
+      ##
+      # 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,
         "pid" => Process.pid,
-        "thread_id" => Thread.current.object_id.to_s
+        "thread_id" => Thread.current.object_id.to_s,
       )
+
+      @events << event 
     end
 
     def start

data/lib/plain_apm/extensions/{trace_id → context}/active_job.rb

@@ -2,15 +2,17 @@
 
 module PlainApm
   module Extensions
-    module TraceId
+    module Context
       module ActiveJob
+        # TODO: would it be useful to de-serialize the whole context (e.g. user
+        # IDs, subscriptions, etc?)
         def serialize
-          trace_id = PlainApm::Extensions::TraceId.current || SecureRandom.uuid
+          trace_id = PlainApm::Extensions::Context.trace_id || SecureRandom.uuid
           super.update("trace_id" => trace_id)
         end
 
         def deserialize(job)
-          PlainApm::Extensions::TraceId.current = job["trace_id"]
+          PlainApm::Extensions::Context.trace_id = job["trace_id"]
 
           super(job)
         end

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

@@ -0,0 +1,11 @@
+module PlainApm
+  module Extensions
+    module Context
+      module Helpers
+	def plain_apm_context(context = {})
+	  PlainApm::Extensions::Context.context.merge!(context)
+	end
+      end
+    end
+  end
+end

data/lib/plain_apm/extensions/{trace_id → context}/middleware.rb

@@ -10,26 +10,26 @@ require "securerandom"
 # See LICENSE.txt in the current directory for the license.
 module PlainApm
   module Extensions
-    module TraceId
+    module Context
       class Middleware
         def initialize(app)
           @app = app
         end
 
         def call(env)
-          TraceId.current = trace_id(env)
+          Context.trace_id = trace_id(env)
 
           status, headers, body = @app.call(env)
 
           body = Rack::BodyProxy.new(body) do
-            TraceId.current = nil
+            Context.clear!
           end
 
           processed = true
 
           [status, headers, body]
         ensure
-          TraceId.current = nil if !processed
+          Context.clear! if !processed
         end
 
         private

data/lib/plain_apm/extensions/{trace_id → context}/railtie.rb

@@ -8,13 +8,13 @@
 # See LICENSE.txt in the current directory for the license.
 module PlainApm
   module Extensions
-    module TraceId
+    module Context
       class Railtie < Rails::Railtie
-        initializer "plain_apm.insert_trace_id_middleware" do |app|
+        initializer "plain_apm.insert_context_middleware" do |app|
           if defined?(ActionDispatch::RequestId)
-            app.config.middleware.insert_after ActionDispatch::RequestId, PlainApm::Extensions::TraceId::Middleware
+            app.config.middleware.insert_after ActionDispatch::RequestId, PlainApm::Extensions::Context::Middleware
           else
-            app.config.middleware.insert_after Rack::MethodOverride, PlainApm::Extensions::TraceId::Middleware
+            app.config.middleware.insert_after Rack::MethodOverride, PlainApm::Extensions::Context::Middleware
           end
         end
       end

data/lib/plain_apm/extensions/context.rb

@@ -0,0 +1,41 @@
+module PlainApm
+  module Extensions
+    module Context
+      STORE_KEY = :plain_apm_extensions_store
+      TRACE_ID_KEY = :trace_id
+      CONTEXT_KEY = :context
+
+      def self.current
+        Thread.current[STORE_KEY] ||= {}
+      end
+
+      def self.clear!
+        Thread.current[STORE_KEY] = {}
+      end
+
+      def self.[](key)
+        current[key]
+      end
+
+      def self.[]=(key, value)
+        current[key] = value
+      end
+
+      def self.context
+        current[CONTEXT_KEY] ||= {}
+      end
+
+      def self.context=(hash)
+        current[CONTEXT_KEY] = hash
+      end
+
+      def self.trace_id
+        current[TRACE_ID_KEY]
+      end
+
+      def self.trace_id=(id)
+        current[TRACE_ID_KEY] = id
+      end
+    end
+  end
+end

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

@@ -29,8 +29,7 @@ module PlainApm
             "class" => e.class.name,
             "message" => e.message,
             "backtrace" => e.backtrace,
-            "params" => env["action_dispatch.request.parameters"],
-            "trace_id" => PlainApm::Extensions::TraceId.current
+            "params" => env["action_dispatch.request.parameters"]
           }
 
           PlainApm::Agent.collect(event)

data/lib/plain_apm/hooks/action_mailer.rb

@@ -21,8 +21,7 @@ module PlainApm
           "backtrace" => filtered_backtrace,
           "allocations" => event.allocations,
           "started_at" => event.time,
-          "finished_at" => event.end,
-          "trace_id" => trace_id
+          "finished_at" => event.end
         }
 
         case name

data/lib/plain_apm/hooks/action_pack.rb

@@ -21,8 +21,7 @@ module PlainApm
           "backtrace" => filtered_backtrace,
           "allocations" => event.allocations,
           "started_at" => event.time,
-          "finished_at" => event.end,
-          "trace_id" => trace_id
+          "finished_at" => event.end
         }
 
         case name

data/lib/plain_apm/hooks/action_view.rb

@@ -21,8 +21,7 @@ module PlainApm
           "backtrace" => filtered_backtrace,
           "started_at" => event.time,
           "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "trace_id" => trace_id
+          "allocations" => event.allocations
         }
 
         case name

data/lib/plain_apm/hooks/active_job.rb

@@ -22,7 +22,6 @@ module PlainApm
           "backtrace" => filtered_backtrace,
           "started_at" => event.time,
           "finished_at" => event.end,
-          "trace_id" => trace_id,
           "allocations" => event.allocations,
           "queue_name" => job.queue_name,
           "job_id" => job.job_id,

data/lib/plain_apm/hooks/active_record.rb

@@ -23,8 +23,7 @@ module PlainApm
           "backtrace" => filtered_backtrace,
           "started_at" => event.time,
           "finished_at" => event.end,
-          "allocations" => event.allocations,
-          "trace_id" => trace_id
+          "allocations" => event.allocations
         }
 
         case name

data/lib/plain_apm/hooks/active_support_subscriber.rb

@@ -45,13 +45,6 @@ module PlainApm
           @cleaner.clean(caller)
         end
       end
-
-      ##
-      # The trace ID (comes from either HTTP_X_REQUEST_ID header, or is
-      # generated by the trace_id middleware)
-      def trace_id
-        PlainApm::Extensions::TraceId.current
-      end
     end
   end
 end

data/lib/plain_apm/hooks/error_reporter.rb

@@ -32,8 +32,7 @@ module PlainApm
           "backtrace" => e.backtrace,
           "handled" => handled,
           "severity" => severity,
-          "context" => context,
-          "trace_id" => PlainApm::Extensions::TraceId.current
+          "context" => context
         }
 
         if e.cause

data/lib/plain_apm/version.rb

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

data/lib/plain_apm.rb

@@ -11,10 +11,11 @@ require_relative "plain_apm/hooks/deploy"
 begin
   require "rack/body_proxy"
 
-  require_relative "plain_apm/extensions/trace_id"
-  require_relative "plain_apm/extensions/trace_id/middleware"
-  require_relative "plain_apm/extensions/trace_id/active_job" if defined?(ActiveSupport)
-  require_relative "plain_apm/extensions/trace_id/railtie" if defined?(Rails::Railtie)
+  require_relative "plain_apm/extensions/context"
+  require_relative "plain_apm/extensions/context/helpers"
+  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)
 rescue LoadError
   nil
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plain_apm
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - PlainAPM Team
@@ -82,14 +82,15 @@ files:
 - lib/plain_apm/agent.rb
 - lib/plain_apm/backoff.rb
 - lib/plain_apm/config.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/helpers.rb
+- lib/plain_apm/extensions/context/middleware.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/trace_id.rb
-- lib/plain_apm/extensions/trace_id/LICENSE.txt
-- lib/plain_apm/extensions/trace_id/active_job.rb
-- lib/plain_apm/extensions/trace_id/middleware.rb
-- lib/plain_apm/extensions/trace_id/railtie.rb
 - lib/plain_apm/hooks/action_mailer.rb
 - lib/plain_apm/hooks/action_pack.rb
 - lib/plain_apm/hooks/action_view.rb

data/lib/plain_apm/extensions/trace_id.rb

@@ -1,15 +0,0 @@
-module PlainApm
-  module Extensions
-    module TraceId
-      TRACE_KEY = :plain_apm_extensions_trace_id
-
-      def self.current
-        Thread.current[TRACE_KEY]
-      end
-
-      def self.current=(id)
-        Thread.current[TRACE_KEY] = id
-      end
-    end
-  end
-end