plain_apm 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86351e7cfbfef5b9e4916152f8f7638f3d25ec63eea2228552a7ed18a30af210
-  data.tar.gz: 3e2054248c4affa80a1a563fb340310fbeeac0d75caf9fc77dadcf1c14a9f975
+  metadata.gz: 22fd1fe0f960151ee14b8a6bfc21c960533baf3f6a6eb86666f0f10253213c74
+  data.tar.gz: 2ec36a0a3d381563f6b7d48dfb54ea01d42f1a06576436c7613665c934167221
 SHA512:
-  metadata.gz: 594f73225b32f2b172251c848b176c1c8fc1370a45d0804bd3741be82eff94cb26fc5526d290127591c274ee886723782890bc1be095b00b158f85331c366f2c
-  data.tar.gz: 6435cb48e14b99c36b1457e28eb343a65618cbda9a0a014e15031b3e08b17aa6da0e15dd3cffa5808df4b44d5db19b180c102103320c231b95d1da1a39bf14c2
+  metadata.gz: e75c9b55fa3a4b3bbde453fef90239f0ed2daea79917115fb41a470fd387bfd7ecf15d6cab45bdc8f1f4fa7c162ea9f5e65ba7455b4414073e5ab106f13d32a4
+  data.tar.gz: e86597538c045928dff96133dba5dfff9d8db15f0caa568d4a3c4db15a21874943e0e0fd567aa57e32735dde121e9314d0883e929a106bd29c7ade6ba7ec1144

data/lib/plain_apm/agent.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "singleton"
-require "json"
 
 module PlainApm
   class Agent
@@ -15,48 +14,67 @@ module PlainApm
       instance.start
     end
 
-    def self.stop
-      instance.stop
-    end
-
     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
 
+      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: Multiple threads
       @publisher = Thread.new { publisher_loop }
+    end
 
-      install_hooks
-
-      # 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
       @events << nil
       @publisher.join
       @publisher = nil
     end
 
-    private
-
     def configure
       @config = Config.new
     end
@@ -95,10 +113,12 @@ module PlainApm
       loop do
         event = @events.pop
 
-        break if event.nil?
+        Thread.exit if event.nil?
+
+        meta = { queue: @events.size, pid: $$, thread: Thread.current.object_id }
 
-        # TODO: event serialization
-        _response, _error, _retriable = transport.deliver(JSON.generate(event))
+        # TODO: event serialization, batching
+        _response, _error, _retriable = transport.deliver(event, meta)
 
         # TODO: retries / drops
       end

data/lib/plain_apm/config.rb

@@ -10,14 +10,12 @@ 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
 
     def enabled?
-      (production? || force_enabled?) && !force_disabled?
+      ((production? && !interactive?) || force_enabled?) && !force_disabled?
     end
 
     def key_present?
@@ -28,6 +26,10 @@ module PlainApm
       (ENV["RAILS_ENV"] || ENV["RACK_ENV"]) == "production"
     end
 
+    def interactive?
+      $stdout.tty?
+    end
+
     # Allow to start in e.g. development.
     def force_enabled?
       ENV["PLAIN_APM_ENABLED"] == "1"

data/lib/plain_apm/transport.rb

@@ -2,6 +2,7 @@
 
 require "net/http"
 require "json"
+require "zlib"
 
 module PlainApm
   class Transport
@@ -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.0"
+  VERSION = "0.9.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plain_apm
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - PlainAPM Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest