plain_apm 0.2.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39a4ac239df66dd854830dcc645189a5a21aa1708acae43d2928fb03c691bd6
-  data.tar.gz: 1acda2ec24a71c06870c32697d00f63136fad59dacecea4e21b99c5df05982cc
+  metadata.gz: 9c90c84af568ff044876f532e72d6275670a0866f13ca3bc81de6ef726ae4d4a
+  data.tar.gz: 3be569a19a2b5f7aed767336ba39490a56435608db9f387c52ca3980d0d5303c
 SHA512:
-  metadata.gz: 3f3c3d112b0bf4b364711d0072fdea6db28da08be2cf36c82bb3c982b9b3c7ba8205caa3a642be503e731c29a88d0e8684b246291dffa24b469a2600d3c875fc
-  data.tar.gz: c62b897b2b45e7f4bf98059d344e647099592c7b8541950d0a271b0a2ae7d8e3e70bd11a75775de0de7f0094313157cb698ccee13ec3edec2a1aee9c6090c180
+  metadata.gz: 681bf3e9efd941ff2dbb88e38af19ffd96d6f790756b82e831f81e4ee33cc44f1d486aac53ca0417fd1fb3990a8b19811563473d765087d96b400e3f33708f84
+  data.tar.gz: b5a9cd30b8fd458a95ecfb8f2e9caf5c9e6b2a6d2e98c4ad7446c06ea5539efb8eca38b35a58fd9c3578e45a5a3272c2febac68bdca092ae4283330562783145

data/lib/plain_apm/agent.rb

@@ -72,7 +72,8 @@ module PlainApm
         Hooks::ActionView,
         Hooks::ActiveJob,
         Hooks::ActiveRecord,
-        Hooks::ErrorReporter
+        Hooks::ErrorReporter,
+        Hooks::Manual
       ].map(&:new).each(&:install)
     end
 

data/lib/plain_apm/config.rb

@@ -7,19 +7,37 @@ module PlainApm
     attr_accessor :endpoint, :app_key, :enabled
 
     def initialize
-      @enabled = enabled?
+      @enabled = enabled? && key_present?
       @endpoint = ENV["PLAIN_APM_ENDPOINT"] || DEFAULT_EVENT_ENDPOINT
-      @app_key = ENV["PLAIN_APM_APP_KEY"] || warn("Missing PLAIN_APM_APP_KEY environment variable, plain_apm agent won't start.")
+      @app_key = ENV["PLAIN_APM_APP_KEY"]
+
+      if enabled? && !key_present?
+        warn("Missing PLAIN_APM_APP_KEY environment variable, plain_apm agent won't start.")
+      end
     end
 
     private
 
     def enabled?
-      force = ENV["PLAIN_APM_ENABLED"] == "1"
-      key_present = ENV["PLAIN_APM_APP_KEY"] != ""
-      production = (ENV["RAILS_ENV"] || ENV["RACK_ENV"]) == "production"
+      (production? || force_enabled?) && !force_disabled?
+    end
+
+    def key_present?
+      ENV["PLAIN_APM_APP_KEY"] != ""
+    end
+
+    def production?
+      (ENV["RAILS_ENV"] || ENV["RACK_ENV"]) == "production"
+    end
+
+    # Allow to start in e.g. development.
+    def force_enabled?
+      ENV["PLAIN_APM_ENABLED"] == "1"
+    end
 
-      key_present && (production || force)
+    # Do not instrument
+    def force_disabled?
+      ENV["PLAIN_APM_DISABLED"] == "1"
     end
   end
 end

data/lib/plain_apm/helpers.rb

@@ -0,0 +1,12 @@
+module PlainApm
+  module Helpers
+    def plain_apm_context(context = {})
+      PlainApm::Extensions::Context.context.merge!(context)
+    end
+
+    def plain_apm_instrument(name, context = {}, &block)
+      sanitized_name = name.gsub(/\W/, "_").gsub(/(?!^)([A-Z])/) { |m| "_#{m}" }.gsub(/_+/, "_").downcase
+      ActiveSupport::Notifications.instrument("#{sanitized_name}.manual.plain_apm", **context, &block)
+    end
+  end
+end

data/lib/plain_apm/hooks/deploy.rb

@@ -18,7 +18,13 @@ module PlainApm
         tool, revision = *result
 
         Agent.instance.collect(
-          {"source" => tool, "revision" => revision, "name" => "deploy"}
+          {
+            "source" => tool,
+            "revision" => revision,
+            "name" => "deploy",
+            "started_at" => Time.now.to_f,
+            "finished_at" => Time.now.to_f
+          }
         )
       end
 

data/lib/plain_apm/hooks/manual.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PlainApm
+  module Hooks
+    class Manual < ActiveSupportSubscriber
+      NOTIFICATION_PATTERN = /\A[^!]\w+\.manual\.plain_apm\Z/.freeze
+
+      private
+
+      def notification_pattern
+        NOTIFICATION_PATTERN
+      end
+
+      def payload(event)
+        name, source, _ = *event.name.split(".")
+
+        {
+          "source" => source,
+          "name" => name,
+          "backtrace" => filtered_backtrace,
+          "started_at" => event.time,
+          "finished_at" => event.end,
+          "allocations" => event.allocations,
+          "payload" => event.payload
+        }
+      end
+    end
+  end
+end

data/lib/plain_apm/version.rb

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

data/lib/plain_apm.rb

@@ -12,10 +12,10 @@ begin
   require "rack/body_proxy"
 
   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)
+  require_relative "plain_apm/helpers"
 rescue LoadError
   nil
 end
@@ -31,6 +31,7 @@ require_relative "plain_apm/hooks/action_pack"
 require_relative "plain_apm/hooks/action_view"
 require_relative "plain_apm/hooks/active_job"
 require_relative "plain_apm/hooks/active_record"
+require_relative "plain_apm/hooks/manual"
 require_relative "plain_apm/hooks/error_reporter"
 
 module PlainApm

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plain_apm
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.4.0
 platform: ruby
 authors:
 - PlainAPM Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -85,12 +85,12 @@ files:
 - 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/helpers.rb
 - lib/plain_apm/hooks/action_mailer.rb
 - lib/plain_apm/hooks/action_pack.rb
 - lib/plain_apm/hooks/action_view.rb
@@ -99,6 +99,7 @@ files:
 - lib/plain_apm/hooks/active_support_subscriber.rb
 - lib/plain_apm/hooks/deploy.rb
 - lib/plain_apm/hooks/error_reporter.rb
+- lib/plain_apm/hooks/manual.rb
 - lib/plain_apm/transport.rb
 - lib/plain_apm/version.rb
 homepage: https://plainapm.com

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

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