goodsorcery 0.1.1 → 0.3.0

data/lib/goodsorcery/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module GoodSorcery
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
   NOTIFIER_NAME = "goodsorcery-ruby"
 end

data/lib/goodsorcery.rb

@@ -51,6 +51,7 @@ require_relative "goodsorcery/delivery"
 require_relative "goodsorcery/verification"
 require_relative "goodsorcery/test_event"
 require_relative "goodsorcery/client"
+require_relative "goodsorcery/performance"
 require_relative "goodsorcery/rack/middleware"
 
 # Reports exceptions to a Good Sorcery error tracker. See README.md.
@@ -152,13 +153,29 @@ module GoodSorcery
       client.test_events
     end
 
+    # Also forgets the performance payloads kept by the :test delivery.
     def clear_test_events
+      Performance.clear_test_payloads
       client.clear_test_events
     end
 
+    # Sends the recorded performance data now (with the :test delivery:
+    # builds it into test_performance_payloads). Never raises.
+    def flush_performance(include_open_minute: true)
+      Performance.flush_performance(include_open_minute: include_open_minute)
+    rescue StandardError
+      false
+    end
+
+    # [{ "path" => "/api/v1/apm/metrics", "body" => Hash }, ...] with the :test delivery.
+    def test_performance_payloads
+      Performance.test_payloads
+    end
+
     # Forgets configuration, client and the current scope. For tests.
     def reset!
       shutdown(0.5)
+      Performance.reset!
       LOCK.synchronize do
         @client = nil
         @configuration = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goodsorcery
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Philip Q Nguyen
@@ -32,18 +32,16 @@ files:
 - lib/goodsorcery/bundler_plugin.rb
 - lib/goodsorcery/client.rb
 - lib/goodsorcery/configuration.rb
+- lib/goodsorcery/configuration/performance_settings.rb
 - lib/goodsorcery/configuration/validation.rb
 - lib/goodsorcery/defaults.rb
 - lib/goodsorcery/delivery.rb
-- lib/goodsorcery/delivery/active_job_queue.rb
 - lib/goodsorcery/delivery/async.rb
 - lib/goodsorcery/delivery/backoff.rb
-- lib/goodsorcery/delivery/custom.rb
 - lib/goodsorcery/delivery/event_queue.rb
 - lib/goodsorcery/delivery/sync.rb
 - lib/goodsorcery/delivery/test.rb
 - lib/goodsorcery/delivery/worker.rb
-- lib/goodsorcery/delivery_job.rb
 - lib/goodsorcery/env_flag.rb
 - lib/goodsorcery/environment_gate.rb
 - lib/goodsorcery/errors.rb
@@ -82,6 +80,25 @@ files:
 - lib/goodsorcery/key_filter.rb
 - lib/goodsorcery/log.rb
 - lib/goodsorcery/masked_key.rb
+- lib/goodsorcery/performance.rb
+- lib/goodsorcery/performance/agent.rb
+- lib/goodsorcery/performance/aggregator.rb
+- lib/goodsorcery/performance/call_site.rb
+- lib/goodsorcery/performance/flusher.rb
+- lib/goodsorcery/performance/histogram.rb
+- lib/goodsorcery/performance/job_timing.rb
+- lib/goodsorcery/performance/measurement.rb
+- lib/goodsorcery/performance/net_http.rb
+- lib/goodsorcery/performance/payloads.rb
+- lib/goodsorcery/performance/process_label.rb
+- lib/goodsorcery/performance/recorder.rb
+- lib/goodsorcery/performance/span_list.rb
+- lib/goodsorcery/performance/sql_normalizer.rb
+- lib/goodsorcery/performance/subscribers.rb
+- lib/goodsorcery/performance/trace_buffer.rb
+- lib/goodsorcery/performance/trace_builder.rb
+- lib/goodsorcery/performance/transaction_stats.rb
+- lib/goodsorcery/performance/uuid_v7.rb
 - lib/goodsorcery/rack/middleware.rb
 - lib/goodsorcery/rack/request_details.rb
 - lib/goodsorcery/rack/request_enricher.rb

data/lib/goodsorcery/delivery/active_job_queue.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module GoodSorcery
-  module Delivery
-    # Enqueues GoodSorcery::DeliveryJob with the filtered event as a JSON
-    # string. Falls back to the background thread when ActiveJob is not loaded
-    # or enqueueing raises. Note: the event is stored in the job backend.
-    class ActiveJobQueue
-      def initialize(serializer:, queue_name:, log:, &fallback_builder)
-        @serializer = serializer
-        @queue_name = queue_name
-        @log = log
-        @fallback_builder = fallback_builder
-        @fallback = nil
-        @lock = Mutex.new
-      end
-
-      def deliver(event)
-        job = DeliveryJobLoader.job_class
-        return deliver_in_background(event, "ActiveJob is not loaded") unless job
-
-        json = @serializer.dump(event)
-        return false unless json
-
-        return true if enqueued?(job.set(queue: @queue_name).perform_later(json))
-
-        deliver_in_background(event, "GoodSorcery::DeliveryJob was not enqueued")
-      rescue StandardError => e
-        deliver_in_background(event, "enqueueing GoodSorcery::DeliveryJob failed (#{e.class})")
-      end
-
-      def flush(timeout = 5)
-        @fallback ? @fallback.flush(timeout) : true
-      end
-
-      def shutdown(timeout = 5)
-        @fallback ? @fallback.shutdown(timeout) : true
-      end
-
-      private
-
-      # perform_later returns false when a callback aborted the enqueue or
-      # the adapter raised ActiveJob::EnqueueError.
-      def enqueued?(job)
-        return false unless job
-
-        job.respond_to?(:successfully_enqueued?) ? job.successfully_enqueued? != false : true
-      end
-
-      def deliver_in_background(event, reason)
-        @log.warn_every(:active_job_fallback, 60, "#{reason}; delivering in the background thread instead")
-        fallback.deliver(event)
-      end
-
-      def fallback
-        @fallback || @lock.synchronize { @fallback ||= @fallback_builder.call }
-      end
-    end
-
-    # Defines GoodSorcery::DeliveryJob on first use, once ActiveJob is loaded.
-    module DeliveryJobLoader
-      def self.job_class
-        return GoodSorcery::DeliveryJob if GoodSorcery.const_defined?(:DeliveryJob, false)
-        return nil unless defined?(::ActiveJob::Base)
-
-        require_relative "../delivery_job"
-        GoodSorcery::DeliveryJob
-      end
-    end
-  end
-end

data/lib/goodsorcery/delivery/custom.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module GoodSorcery
-  module Delivery
-    # Wraps an app-supplied delivery object. It must respond to
-    # deliver(event_hash) and may respond to flush(timeout) and shutdown(timeout).
-    class Custom
-      attr_reader :target
-
-      def initialize(target)
-        @target = target
-      end
-
-      def deliver(event)
-        @target.deliver(event)
-      end
-
-      def flush(timeout = 5)
-        @target.respond_to?(:flush) ? @target.flush(timeout) : true
-      end
-
-      def shutdown(timeout = 5)
-        @target.respond_to?(:shutdown) ? @target.shutdown(timeout) : true
-      end
-    end
-  end
-end

data/lib/goodsorcery/delivery_job.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module GoodSorcery
-  # Sends one already-filtered event (a JSON string) synchronously. Retries
-  # 429/5xx/network failures with ActiveJob's retry_on. Any exception raised
-  # here is marked as reported first, so no integration reports it back to
-  # Good Sorcery (no recursion). The argument is captured error data, so
-  # Active Job never writes it to the log.
-  class DeliveryJob < ::ActiveJob::Base
-    WAIT = ::ActiveJob.gem_version >= Gem::Version.new("7.1") ? :polynomially_longer : :exponentially_longer
-
-    self.log_arguments = false
-    queue_as { GoodSorcery.configuration.active_job_queue }
-    retry_on GoodSorcery::RetryableDeliveryError, wait: WAIT, attempts: 5
-
-    def perform(event_json)
-      result = GoodSorcery.client.transport.post_event(event_json)
-      return unless result.retry_later?
-
-      raise GoodSorcery::RetryableDeliveryError, "event delivery failed (#{result.description})"
-    rescue Exception => e # rubocop:disable Lint/RescueException
-      ReportedMark.mark(e)
-      raise
-    end
-  end
-end