deployangel 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e80de544815ec904e01198f948c81c722ddadb005f6e87761827ac1cb3a362
-  data.tar.gz: 6175861126a88ed4bc09bdaf600c03e1ce5cd88fa3361c53d7c761ff7a066b38
+  metadata.gz: 5250331c4f5a2c2715d94bbbfc62f61daae1f58a744e1430a231a23077a7c540
+  data.tar.gz: 8db08acb92e1b8923038e2f726481197eb082e308d1f59a6e18911a04d6c3301
 SHA512:
-  metadata.gz: 9d20de4305540d12d4b24223c7f4eda020b0855b8205cbeac03c51bf8befc701cb783a1e4600c3781b7d15b906a739aa63988bacc4864bc15a286e32c0138405
-  data.tar.gz: 38682cdc5941ad48af3ed324356d5bf71309bc5fe2c41fd0c582198ce0315c1863575f5896b13516b634cf6d56e69aee1124a3491c2fa4aae28c49f4b6a77a59
+  metadata.gz: '0548b47a265acf82aa9cb67e566142ec4e4e648af0e828217066f8104bc24bf305fd397a1bdb2741de7bf919e10e0d8e4d76fcdd2d9e865e0aaf46ebca226acd'
+  data.tar.gz: e622c67f73c8475ff52dd8628e296de2950dce36b7a83e447d23e3a523fdf950a13801ee654972e2c60d176f8c6ddfd7230bec31159cc604b77782bb4a4757a6

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.7 (2026-10-04)
+
+- Health checks from OkComputer, health_check, and rails-healthcheck are left
+  out like Rails' own, wherever they're mounted.
+- `config.ignored_routes` leaves out other routes, such as a health check
+  served by your own controller: `[ "GET /healthz" ]`. HEAD requests to a
+  listed GET route are left out too, and listed routes aren't sent in the
+  route table, so DeployAngel never expects them to run.
+
 ## 0.1.6 (2026-10-04)
 
 - Requests to Rails' health check (`rails/health#show`, at `/up` by default)

data/README.md

@@ -111,6 +111,19 @@ DeployAngel.configure do |config|
 end
 ```
 
+Health checks aren't recorded: load balancers and uptime monitors call them
+all the time and they always answer fast, so they would make your app look
+busier and healthier than its real pages. The agent recognizes Rails' own
+(`/up`), OkComputer, health_check, and rails-healthcheck, wherever they're
+mounted. If your health check is your own controller, list its route the way
+the dashboard shows it. HEAD requests to it are left out too:
+
+```ruby
+DeployAngel.configure do |config|
+  config.ignored_routes = [ "GET /healthz" ]
+end
+```
+
 `DEPLOYANGEL_ENABLED=true|false` forces reporting on or off in any environment.
 `DEPLOYANGEL_URL` overrides the API endpoint (default `https://api.deployangel.com`).
 

data/lib/deployangel/configuration.rb

@@ -11,7 +11,7 @@ module DeployAngel
 
     attr_accessor :token, :endpoint, :enabled, :environments, :release_version, :revision,
       :flush_interval, :open_timeout, :read_timeout, :max_queued_payloads, :max_routes, :logger,
-      :file_digests, :critical_flows
+      :file_digests, :critical_flows, :ignored_routes
 
     def initialize(env = ENV)
       @token = env["DEPLOYANGEL_TOKEN"]
@@ -28,6 +28,8 @@ module DeployAngel
       @logger = Logger.new($stderr, level: Logger::WARN, progname: "deployangel")
       @file_digests = parse_boolean(env["DEPLOYANGEL_FILE_DIGESTS"]) != false
       @critical_flows = {}
+      # Route keys as the dashboard shows them, such as "GET /healthz".
+      @ignored_routes = []
     end
 
     # Reports only with a token. By default only in the listed
@@ -39,6 +41,14 @@ module DeployAngel
       environments.include?(environment.to_s)
     end
 
+    # Whether requests to a route are left out. Rails answers HEAD with the
+    # GET route, so ignoring "GET /healthz" ignores "HEAD /healthz" too.
+    def ignored_route?(key)
+      return false if ignored_routes.empty?
+
+      ignored_routes.include?(key) || ignored_routes.include?(key.sub(/\AHEAD /, "GET "))
+    end
+
     private
       def parse_boolean(value)
         return nil if value.nil? || value.strip.empty?

data/lib/deployangel/rails/http.rb

@@ -7,10 +7,12 @@ module DeployAngel
     # never the raw path, which keeps IDs out of route keys.
     class Http
       FORMAT_SUFFIX = "(.:format)"
-      # Rails' health check (/up by default). Load balancers and uptime
-      # monitors call it all the time and it always answers fast, so
-      # counting it would make any app look busy and healthy.
-      HEALTH_CHECK_CONTROLLER = "rails/health"
+      # Health checks: Rails' own (/up by default), OkComputer, health_check,
+      # and rails-healthcheck, wherever they're mounted. Load balancers and
+      # uptime monitors call them all the time and they answer fast, so
+      # counting them would make any app look busy and healthy. Others can
+      # be left out with config.ignored_routes.
+      HEALTH_CHECK_CONTROLLERS = %w[rails/health ok_computer/ok_computer health_check/health_check healthcheck/healthchecks].freeze
 
       def initialize(app)
         @app = app
@@ -35,9 +37,10 @@ module DeployAngel
 
       private
         def record(env, status, started, unhandled:, exception: nil)
-          return if env["action_dispatch.request.path_parameters"]&.dig(:controller) == HEALTH_CHECK_CONTROLLER
+          return if HEALTH_CHECK_CONTROLLERS.include?(env["action_dispatch.request.path_parameters"]&.dig(:controller))
 
           route = route_key(env)
+          return if route && DeployAngel.configuration.ignored_route?(route)
           # Unrouted successes are static files and similar; unrouted
           # errors (such as routing 404s) still count.
           return if route.nil? && status.to_i < 400

data/lib/deployangel/rails/metadata.rb

@@ -40,12 +40,13 @@ module DeployAngel
         @app.routes.routes.flat_map do |route|
           controller = route.defaults[:controller]
           next [] if controller.nil? || controller.start_with?("rails/", "active_storage/", "action_mailbox/")
+          next [] if Http::HEALTH_CHECK_CONTROLLERS.include?(controller)
 
           path = route.path.spec.to_s.delete_suffix(FORMAT_SUFFIX)
           route.verb.to_s.split("|").reject(&:empty?).map do |verb|
             { "key" => "#{verb} #{path}", "controller" => controller, "action" => route.defaults[:action].to_s }
           end
-        end.uniq { |route| route["key"] }
+        end.uniq { |route| route["key"] }.reject { |route| @config.ignored_route?(route["key"]) }
       rescue StandardError
         []
       end

data/lib/deployangel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeployAngel
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deployangel
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Jordan Owens