dead_bro 0.2.10 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac04c555f3f82572e94327d09b90672869eb17c129deb87c78f746625cb5afd
-  data.tar.gz: 4639f701e7bd5dff8b36933e85b405dbbe43a2ccc664c94f16b6e2ea98987fda
+  metadata.gz: 2c308968cd84cfa8df47974178b741ab2847809754e86dc49cbe716d07a7a0bb
+  data.tar.gz: 6cdfb10f1ac9b2ecd9994bf6f35d8468022dc024e16e9ab31c1664fa91db7041
 SHA512:
-  metadata.gz: fee0d59a0362226babd057547b8138078d5ce3da4a75a3c5a2bbd175ee21b3043485e9f6c8e0b0a27a18c2373f10827fc7804f64c96888a41eea8d3c8eb8ea74
-  data.tar.gz: 1e044e7a275a5e52843119e00488a8a458e6d6f95420543014edd1074985bcdeebe1cbeef579e436a4eb31836eb6f9e24961c039851c4c82b2b0a76184cf23d2
+  metadata.gz: 2a8f31655b9512739fa991ee94675c1f948c5ae2229dbb9de62a4e3c6ea0b5a8883ea880f986d911044e200d0c8ae6e696f6d8a58e5c338da6c8c3756c08e543
+  data.tar.gz: ddf1ed72e8310eb1f42db17f5124b704c5214447706ed68c1f9bae9f47f669fbf56006733f430a064af0fc8965be161dbb85bcaca2aee6b6c14a68b4865216f9

data/FEATURES.md

@@ -284,12 +284,7 @@ A comprehensive feature list for comparing ApmBro with other APM (Application Pe
 ## Deployment & Environment
 
 ### Deploy Tracking
-- **Deploy ID Resolution**: Multiple sources for deploy identification
-  - Explicit configuration
-  - Rails settings/credentials
-  - Environment variables (APM_BRO_DEPLOY_ID, GIT_REV)
-  - Heroku (HEROKU_SLUG_COMMIT)
-  - Process-stable UUID fallback
+- **Deploy ID Resolution**: Multiple sources for deploy identification (`Configuration#deploy_id=` wins when set, then ENV in `Configuration::DEPLOY_REVISION_ENV_KEYS` order—including `DEAD_BRO_DEPLOY_ID`, git/CI vars, `DD_VERSION`, etc.), otherwise a **per-process UUID** (fine for single dyno/process; unusable alone for fleets like ECS replicas)
 - **Revision Tracking**: Includes deploy/revision ID in all metric payloads
 
 ### Environment Support

data/README.md

@@ -30,6 +30,25 @@ end
 
 That is enough to start shipping metrics. Create or copy the key from your DeadBro account, then wire it into `DEAD_BRO_API_KEY` (or assign `config.api_key` directly).
 
+### Deploy / release tracking (ECS, Kubernetes, autoscaling groups)
+
+DeadBro sends a **`revision`** string on every payload so charts and deploys group metrics by release. If you do **not** configure a stable value, the gem generates a UUID **once per Ruby process**. With multiple containers or EC2 instances, each replica then looks like a separate deployment.
+
+**Use one shared identifier for every task in the same rollout**, for example:
+
+- Set `DEAD_BRO_DEPLOY_ID` (or `dead_bro_DEPLOY_ID`) in the task definition / pod spec to your **git SHA**, **image digest**, or CD **release id** injected at build or deploy time.
+- Or set it in Ruby (this wins over environment variables when non-blank):
+
+```ruby
+DeadBro.configure do |config|
+  config.deploy_id = ENV.fetch("GIT_SHA") { raise "Set GIT_SHA in the task definition" }
+end
+```
+
+The gem also checks these environment variables in order (first non-empty wins): `DEAD_BRO_DEPLOY_ID`, `dead_bro_DEPLOY_ID`, `GIT_REV`, `GIT_COMMIT`, `GIT_COMMIT_SHA`, `GIT_SHA`, `CODEBUILD_RESOLVED_SOURCE_REVISION`, `HEROKU_SLUG_COMMIT`, `RENDER_GIT_COMMIT`, `DD_VERSION`, `APP_REVISION`, `RELEASE_VERSION`, `SOURCE_VERSION`.
+
+For **Amazon ECS**, add one of these variables in your task definition from CodeBuild, GitHub Actions, or your pipeline so all tasks in the service share the same value for that image version.
+
 ### Dashboard configuration
 
 Use the DeadBro UI to turn features on or off, set sample rates, define controller/job inclusions and exclusions, tune slow-query EXPLAIN, enable queue and system metrics, and adjust related limits. After you deploy the initializer above, those choices take effect when the gem receives them from the API (typically on the next successful metric or heartbeat response).

data/lib/dead_bro/client.rb

@@ -15,11 +15,12 @@ module DeadBro
     def post_metric(event_name:, payload:, force: false)
       return if @configuration.api_key.nil?
       return unless @configuration.enabled
+      return if @configuration.skip_tracking?
       return if !force && !@configuration.should_sample?
       return if circuit_open?
 
       payload = truncate_payload_for_request(payload)
-      body = {event: event_name, payload: payload, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id}
+      body = {event: event_name, payload: payload, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id, gem_version: DeadBro::VERSION}
 
       dispatch_request(
         url: metrics_endpoint_url,
@@ -35,7 +36,7 @@ module DeadBro
       return if @configuration.api_key.nil?
 
       @configuration.last_heartbeat_attempt_at = Time.now.utc
-      body = {event: "heartbeat", payload: {}, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id}
+      body = {event: "heartbeat", payload: {}, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id, gem_version: DeadBro::VERSION}
 
       dispatch_request(
         url: metrics_endpoint_url,
@@ -50,10 +51,11 @@ module DeadBro
     def post_monitor_stats(payload)
       return if @configuration.api_key.nil?
       return unless @configuration.enabled
+      return if @configuration.skip_tracking?
       return unless @configuration.job_queue_monitoring_enabled
       return if circuit_open?
 
-      body = {payload: payload, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id}
+      body = {payload: payload, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id, gem_version: DeadBro::VERSION}
 
       dispatch_request(
         url: monitor_endpoint_url,
@@ -140,6 +142,12 @@ module DeadBro
             @configuration.last_heartbeat_at = Time.now.utc
           end
         end
+
+        if response.is_a?(Net::HTTPSuccess)
+          @configuration.skip_until = nil
+        elsif response.is_a?(Net::HTTPInsufficientStorage)
+          @configuration.skip_until = Time.now.utc + DeadBro::Configuration::METRICS_BACKEND_SKIP_AFTER_507_SECONDS
+        end
       elsif @circuit_breaker && @configuration.circuit_breaker_enabled
         @circuit_breaker.record_failure
       end

data/lib/dead_bro/configuration.rb

@@ -7,7 +7,7 @@ module DeadBro
     # returns it in a response; local configure() values apply until the next remote update.
     attr_accessor :api_key, :open_timeout, :read_timeout, :enabled, :ruby_dev,
       :circuit_breaker_enabled, :circuit_breaker_failure_threshold, :circuit_breaker_recovery_timeout,
-      :circuit_breaker_retry_timeout, :deploy_id, :disk_paths, :interfaces_ignore
+      :circuit_breaker_retry_timeout, :disk_paths, :interfaces_ignore
 
     # Remote-managed settings (overwritten by backend JSON `settings` on successful API responses)
     attr_accessor :memory_tracking_enabled, :allocation_tracking_enabled,
@@ -22,6 +22,10 @@ module DeadBro
     # Tracks when we last received settings from the backend (in-memory only)
     attr_accessor :settings_received_at
 
+    # After HTTP 507 Insufficient Storage from the API, skip all tracking until this
+    # UTC time (in-memory only). Cleared on the next successful API response.
+    attr_accessor :skip_until
+
     # Last successful heartbeat HTTP response time while disabled (in-memory only)
     attr_accessor :last_heartbeat_at
 
@@ -30,6 +34,26 @@ module DeadBro
 
     HEARTBEAT_INTERVAL = 60 # seconds
 
+    METRICS_BACKEND_SKIP_AFTER_507_SECONDS = 600 # 10 minutes
+
+    # First non-empty ENV value wins for release/revision payloads and deploy grouping on the server.
+    # Order is roughly: DeadBro-native → common CI/hosting → observability tooling.
+    DEPLOY_REVISION_ENV_KEYS = %w[
+      DEAD_BRO_DEPLOY_ID
+      dead_bro_DEPLOY_ID
+      GIT_REV
+      GIT_COMMIT
+      GIT_COMMIT_SHA
+      GIT_SHA
+      CODEBUILD_RESOLVED_SOURCE_REVISION
+      HEROKU_SLUG_COMMIT
+      RENDER_GIT_COMMIT
+      DD_VERSION
+      APP_REVISION
+      RELEASE_VERSION
+      SOURCE_VERSION
+    ].freeze
+
     REMOTE_SETTING_KEYS = %w[
       enabled sample_rate memory_tracking_enabled allocation_tracking_enabled
       explain_analyze_enabled slow_query_threshold_ms max_sql_queries_to_send max_logs_to_send
@@ -47,7 +71,7 @@ module DeadBro
       @circuit_breaker_failure_threshold = 3
       @circuit_breaker_recovery_timeout = 60
       @circuit_breaker_retry_timeout = 300
-      @deploy_id = resolve_deploy_id
+      @explicit_deploy_revision = nil
       @disk_paths = ["/"]
       @interfaces_ignore = %w[lo lo0 docker0]
 
@@ -69,11 +93,23 @@ module DeadBro
       @enable_system_stats = false
 
       @settings_received_at = nil
+      @skip_until = nil
       @last_heartbeat_at = nil
       @last_heartbeat_attempt_at = nil
       @settings_mutex = Mutex.new
     end
 
+    # Current release revision sent as `revision` on all API payloads — same semantics as `#resolve_deploy_id`.
+    def deploy_id
+      resolve_deploy_id
+    end
+
+    # Overrides ENV-based resolution when set to a non-empty string (or clears override when nil/blank).
+    def deploy_id=(value)
+      s = value&.respond_to?(:to_s) ? value.to_s.strip : ""
+      @explicit_deploy_revision = s.empty? ? nil : s
+    end
+
     def excluded_controllers=(value)
       @excluded_controllers = Array(value).map(&:to_s)
       @compiled_excluded_controllers = compile_patterns(@excluded_controllers)
@@ -123,8 +159,28 @@ module DeadBro
       last_heartbeat_attempt_at.nil? || (Time.now.utc - last_heartbeat_attempt_at) >= HEARTBEAT_INTERVAL
     end
 
+    def skip_tracking?
+      t = skip_until
+      return false unless t
+
+      Time.now.utc < t
+    end
+
     def resolve_deploy_id
-      ENV["dead_bro_DEPLOY_ID"] || ENV["GIT_REV"] || ENV["HEROKU_SLUG_COMMIT"] || DeadBro.process_deploy_id
+      explicit = @explicit_deploy_revision&.to_s&.strip
+      return explicit unless explicit.nil? || explicit.empty?
+
+      DEPLOY_REVISION_ENV_KEYS.each do |key|
+        v = ENV[key]
+        next unless v.respond_to?(:to_s)
+
+        stripped = v.to_s.strip
+        next if stripped.empty?
+
+        return stripped
+      end
+
+      DeadBro.process_deploy_id
     end
 
     def excluded_controller?(controller_name, action_name = nil)

data/lib/dead_bro/job_sql_tracking_middleware.rb

@@ -5,6 +5,8 @@ module DeadBro
     def self.subscribe!
       # Start SQL tracking when a job begins - use the start event, not the complete event
       ActiveSupport::Notifications.subscribe("perform_start.active_job") do |name, started, finished, _unique_id, data|
+        next if DeadBro.configuration.skip_tracking?
+
         # Clear logs for this job
         DeadBro.logger.clear
 

data/lib/dead_bro/job_subscriber.rb

@@ -15,6 +15,11 @@ module DeadBro
       # Track job execution
       ActiveSupport::Notifications.subscribe(JOB_EVENT_NAME) do |name, started, finished, _unique_id, data|
         begin
+          if DeadBro.configuration.skip_tracking?
+            drain_job_tracking
+            next
+          end
+
           job_class_name = data[:job].class.name
           if DeadBro.configuration.excluded_job?(job_class_name)
             drain_job_tracking
@@ -106,6 +111,11 @@ module DeadBro
       # Track job exceptions
       ActiveSupport::Notifications.subscribe(JOB_EXCEPTION_EVENT_NAME) do |name, started, finished, _unique_id, data|
         begin
+          if DeadBro.configuration.skip_tracking?
+            drain_job_tracking
+            next
+          end
+
           job_class_name = data[:job].class.name
           if DeadBro.configuration.excluded_job?(job_class_name)
             next
@@ -215,7 +225,7 @@ module DeadBro
           (arg.length > 200) ? arg[0, 200] + "..." : arg
         when Hash
           # Filter sensitive keys and limit size
-          filtered = arg.except(*%w[password token secret key])
+          filtered = arg.reject { |k, _| %w[password token secret key].include?(k.to_s) }
           (filtered.keys.size > 20) ? filtered.first(20).to_h : filtered
         when Array
           arg.first(5)

data/lib/dead_bro/sql_tracking_middleware.rb

@@ -7,6 +7,8 @@ module DeadBro
     end
 
     def call(env)
+      return @app.call(env) if DeadBro.configuration.skip_tracking?
+
       # Clear logs for this request
       DeadBro.logger.clear
 

data/lib/dead_bro/subscriber.rb

@@ -16,6 +16,12 @@ module DeadBro
           next
         end
 
+        if DeadBro.configuration.skip_tracking?
+          client.post_heartbeat if DeadBro.configuration.heartbeat_due?
+          drain_request_tracking
+          next
+        end
+
         # Skip excluded controllers or controller#action pairs
         # Also check exclusive_controller_actions - if defined, only track those
         notification = data.is_a?(Hash) ? data : {}

data/lib/dead_bro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeadBro
-  VERSION = "0.2.10"
+  VERSION = "0.2.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dead_bro
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.13
 platform: ruby
 authors:
 - Emanuel Comsa
@@ -65,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="