dead_bro 0.2.22 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14aa1509e04c9bf1848883cc5f2a12e7783e5ac4c123c9bcddde301948e30bfb
-  data.tar.gz: b3ec01b52a1e63efda701520a014f040fff96cedcbf36fe0827f4a7e892aac90
+  metadata.gz: 2123fe4aad1331c3a33afdf2e5f9cffcfac75f5893982522569da053fc4ea403
+  data.tar.gz: a00a450442279e95799fb6ddd3e2d55b4b18e8ed26926f55c09ea076f12d02eb
 SHA512:
-  metadata.gz: 0c1f24b1718fa9aacf383d22e3b6982e76e7c5aa2c1ccf989d9c411bb0771b0a5fae60d9a780bbe845fac84cafc1a7f876b305005b9e5f3c07f82a7005b0775b
-  data.tar.gz: 469f652352cb2544b882b82dc528dced3e4725a34da033a14dd54b6e7742691a189eed1079dac1684e2da24ba587a955d4fcf3034c1c50f6a2f0d9bf514b2311
+  metadata.gz: ba0645dca3b3552e6c8b4aaef11e8f008e7822ba5d67ff9b8133c05bfe21b0a719252f655f7a893e99369aafe4c6e2ac3c886a372bc353b48c044d22b83d7f36
+  data.tar.gz: dffa7888b43a8642fb9ee32ec9334f8cb13dab4c176353171a533780d086eca99257198e0f9a4d0609cc6897a5d51a7591213da3442929c82b2bdf00aa65d738

data/README.md

@@ -14,13 +14,21 @@ Add to your Gemfile:
 gem "dead_bro", git: "https://github.com/rubydevro/dead_bro.git"
 ```
 
+Then run the install generator to create the initializer:
+
+```sh
+bin/rails generate dead_bro:install
+```
+
+This creates `config/initializers/dead_bro.rb`. Set `DEAD_BRO_API_KEY` in your environment and you're done.
+
 ## Usage
 
 By default, if Rails is present, DeadBro auto-subscribes to `process_action.action_controller` and posts metrics asynchronously.
 
 ### Required: API key in your app
 
-Add an initializer (for example `config/initializers/dead_bro.rb`) and set your API key from the environment, [Rails credentials](https://guides.rubyonrails.org/security.html#custom-credentials), or another secret store:
+The install generator above creates `config/initializers/dead_bro.rb` for you. If you prefer to add it manually, create the file and set your API key from the environment, [Rails credentials](https://guides.rubyonrails.org/security.html#custom-credentials), or another secret store:
 
 ```ruby
 DeadBro.configure do |config|

data/lib/dead_bro/collectors/jobs.rb

@@ -372,27 +372,6 @@ module DeadBro
         nil
       end
 
-      def process_hostname
-        if defined?(ProcessInfo)
-          begin
-            ProcessInfo.safe_hostname
-          rescue
-            default_hostname
-          end
-        else
-          default_hostname
-        end
-      rescue
-        default_hostname
-      end
-
-      def default_hostname
-        require "socket"
-        Socket.gethostname
-      rescue
-        "unknown"
-      end
-
       def safe_collect
         yield
       rescue => e

data/lib/dead_bro/collectors/process_info.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require "rbconfig"
-require "socket"
 
 module DeadBro
   module Collectors
@@ -20,7 +19,7 @@ module DeadBro
         {
           kind: DeadBro.process_kind,
           pid: Process.pid,
-          hostname: safe_hostname,
+          hostname: DeadBro.safe_hostname,
           boot_time: rails_boot_time,
           uptime_s: uptime_seconds(now),
           ruby_version: RUBY_VERSION,
@@ -52,12 +51,6 @@ module DeadBro
         false
       end
 
-      def safe_hostname
-        Socket.gethostname
-      rescue
-        "unknown"
-      end
-
       def rails_boot_time
         return nil unless defined?(Rails)
 

data/lib/dead_bro/collectors/sample_store.rb

@@ -86,15 +86,7 @@ module DeadBro
       end
 
       def redis_key(key)
-        env = DeadBro.env
-        host = begin
-          require "socket"
-          Socket.gethostname
-        rescue
-          "unknown"
-        end
-
-        "dead_bro:metrics:#{env}:#{host}:#{key}"
+        "dead_bro:metrics:#{DeadBro.env}:#{DeadBro.safe_hostname}:#{key}"
       end
 
       def file_path(key)

data/lib/dead_bro/configuration.rb

@@ -180,6 +180,9 @@ module DeadBro
         return stripped
       end
 
+      revision = read_revision_file
+      return revision unless revision.nil? || revision.empty?
+
       DeadBro.process_deploy_id
     end
 
@@ -249,6 +252,19 @@ module DeadBro
 
     private
 
+    # Capistrano (and similar) write the deployed git SHA to REVISION in the app root.
+    def read_revision_file
+      return nil unless defined?(Rails) && Rails.respond_to?(:root)
+
+      path = Rails.root.join("REVISION")
+      return nil unless path.file?
+
+      stripped = File.read(path).strip
+      stripped.empty? ? nil : stripped
+    rescue
+      nil
+    end
+
     # Turn a list of user-facing patterns into {pattern, has_hash, regex}
     # entries. Regex is nil when the pattern is a plain literal (cheaper eq
     # compare). Compiling up-front removes per-request regex allocation.

data/lib/dead_bro/job_subscriber.rb

@@ -105,6 +105,7 @@ module DeadBro
           job_id: data[:job].job_id,
           queue_name: data[:job].queue_name,
           arguments: safe_arguments(data[:job].arguments),
+          started_at: started.utc.iso8601(3),
           duration_ms: duration_ms,
           queue_duration_ms: queue_duration_ms,
           db_connection_wait_ms: db_connection_stats[:wait_ms],
@@ -114,7 +115,7 @@ module DeadBro
           status: "completed",
           sql_queries: sql_queries,
           rails_env: DeadBro.env,
-          host: safe_host,
+          host: DeadBro.safe_hostname,
           process_kind: DeadBro.process_kind,
           memory_usage: memory_usage_mb,
           gc_stats: gc_stats,
@@ -201,6 +202,7 @@ module DeadBro
           job_id: data[:job].job_id,
           queue_name: data[:job].queue_name,
           arguments: safe_arguments(data[:job].arguments),
+          started_at: started.utc.iso8601(3),
           duration_ms: duration_ms,
           queue_duration_ms: queue_duration_ms,
           db_connection_wait_ms: db_connection_stats[:wait_ms],
@@ -213,7 +215,7 @@ module DeadBro
           message: exception&.message&.to_s&.[](0, 1000),
           backtrace: Array(exception&.backtrace).first(50),
           rails_env: DeadBro.env,
-          host: safe_host,
+          host: DeadBro.safe_hostname,
           process_kind: DeadBro.process_kind,
           memory_usage: memory_usage_mb,
           gc_stats: gc_stats,
@@ -287,18 +289,6 @@ module DeadBro
       []
     end
 
-    def self.safe_host
-      if defined?(Rails) && Rails.respond_to?(:application)
-        begin
-          Rails.application.class.module_parent_name
-        rescue
-          ""
-        end
-      else
-        ""
-      end
-    end
-
     def self.memory_usage_mb
       DeadBro::MemoryHelpers.rss_mb
     rescue

data/lib/dead_bro/monitor.rb

@@ -67,7 +67,7 @@ module DeadBro
     def collect_and_send_stats
       payload = {
         environment: DeadBro.env,
-        host: process_hostname,
+        host: DeadBro.safe_hostname,
         pid: Process.pid,
         process_kind: DeadBro.process_kind,
         current_time: Time.now.utc.iso8601,
@@ -89,13 +89,6 @@ module DeadBro
       @client.post_monitor_stats(payload)
     end
 
-    def process_hostname
-      require "socket"
-      Socket.gethostname
-    rescue
-      "unknown"
-    end
-
     def log_error(message)
       msg = "[DeadBro::Monitor] #{message}"
       if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger

data/lib/dead_bro/subscriber.rb

@@ -136,7 +136,7 @@ module DeadBro
               status: data[:status],
               duration_ms: duration_ms,
               rails_env: DeadBro.env,
-              host: safe_host,
+              host: DeadBro.safe_hostname,
               process_kind: DeadBro.process_kind,
               params: safe_params(data),
               user_agent: safe_user_agent(data),
@@ -165,10 +165,11 @@ module DeadBro
           method: data[:method],
           path: safe_path(data),
           status: data[:status],
+          started_at: started.utc.iso8601(3),
           duration_ms: duration_ms,
           view_runtime_ms: data[:view_runtime],
           db_runtime_ms: data[:db_runtime],
-          host: safe_host,
+          host: DeadBro.safe_hostname,
           rails_env: DeadBro.env,
           process_kind: DeadBro.process_kind,
           params: safe_params(data),
@@ -230,18 +231,6 @@ module DeadBro
       ""
     end
 
-    def self.safe_host
-      if defined?(Rails) && Rails.respond_to?(:application)
-        begin
-          Rails.application.class.module_parent_name
-        rescue
-          ""
-        end
-      else
-        ""
-      end
-    end
-
     def self.safe_params(data)
       return {} unless data[:params]
 

data/lib/dead_bro/version.rb

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

data/lib/dead_bro.rb

@@ -128,6 +128,14 @@ module DeadBro
     "development"
   end
 
+  # OS hostname for identifying which machine handled a request, job, or metric.
+  def self.safe_hostname
+    require "socket"
+    Socket.gethostname
+  rescue
+    "unknown"
+  end
+
   def self.process_kind
     @process_kind ||= begin
       fingerprint = "#{$PROGRAM_NAME} #{process_command_line}".downcase

data/lib/generators/dead_bro/install/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module DeadBro
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a DeadBro initializer in config/initializers/dead_bro.rb"
+
+      def create_initializer
+        template "dead_bro.rb", "config/initializers/dead_bro.rb"
+      end
+    end
+  end
+end

data/lib/generators/dead_bro/install/templates/dead_bro.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+DeadBro.configure do |cfg|
+  cfg.api_key = ENV["DEAD_BRO_API_KEY"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dead_bro
 version: !ruby/object:Gem::Version
-  version: 0.2.22
+  version: 0.2.24
 platform: ruby
 authors:
 - Emanuel Comsa
@@ -56,6 +56,8 @@ files:
 - lib/dead_bro/subscriber.rb
 - lib/dead_bro/version.rb
 - lib/dead_bro/view_rendering_subscriber.rb
+- lib/generators/dead_bro/install/install_generator.rb
+- lib/generators/dead_bro/install/templates/dead_bro.rb
 homepage: https://www.deadbro.com
 licenses: []
 metadata: