yabeda-hotcell 0.0.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9369f5229ab4571f30d14935b33d5c5de90da1db6319a7f2f2cf07f628658bd
-  data.tar.gz: 5e0d716dcd184fcd9c9bd64b17d66645441d4c4b89fd9d262d68a3e664381de1
+  metadata.gz: 0fb7ba45b18d7d8edcaca91975fe68e3fc3acd213a676ca703564184d7df15fe
+  data.tar.gz: a709e9d5df13952723126af13d9189c2dbbff865ec1fb39813da9514737578df
 SHA512:
-  metadata.gz: fd41b7aff574b0d969e17999149eda6471275d94d4e467b40dbee7be8a90e8661108ba224422eefe09098b9570aeabcbec968a7a0f45a54c12203cd7f2c22a88
-  data.tar.gz: 12159d1d9cd1d04171457190c2cf02f537c97b3bf2692cbbc1080298c9a8d1fad31377f6eb7683f59889d48cf729a3f544b23b74e0fe265b2b6ffb1513fb384d
+  metadata.gz: 8a325a46e9342f07ecfbecef29fd42187c2e6594a255eca648df52c5eae98d1c13520aa5fae8756d32644d428747eb0b17242b18b5a5f98006fac0953d32aa51
+  data.tar.gz: 91b9ec082349f6a3e94f487ecb33dc172ee26f231bc22edfb33529728acf2e267e04007a67dc6c97bd4f979c1813ee77c0c8774f400df28c5db86a898aa167fa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 37signals, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,3 +1,3 @@
 # yabeda-hotcell
 
-Yabeda metrics for [HotCell](https://github.com/basecamp/hotcell). This gem will be published shortly.
+Part of [HotCell](https://github.com/basecamp/hotcell). See the repository README.

data/lib/yabeda/hot_cell/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module HotCell
+    VERSION = "0.6.0"
+  end
+end

data/lib/yabeda/hot_cell.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "hot_cell/client"
+require "yabeda"
+
+require "yabeda/hot_cell/version"
+
+module Yabeda
+  # A cell's control socket is host-local, and the collect block runs in every scraped process on every host,
+  # which matches that topology exactly.
+  #
+  # Two namespace traps here, both silent. Inside `module Yabeda`, `HotCell` resolves to this module, so the
+  # client must be named ::HotCell. And `hotcell` is a DSL method that exists only inside Yabeda.configure, so
+  # anything factored out of the collect block must say Yabeda.hotcell.
+  module HotCell
+    def self.install!
+      Yabeda.configure do
+        group :hotcell
+
+        counter :requests, comment: "Calls through perform_in_hotcell, by outcome",
+          tags: %i[ cell operation code cause ]
+        histogram :perform, comment: "Time the cell spent performing", unit: :seconds,
+          tags: %i[ cell operation ], buckets: [ 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 120 ]
+
+        gauge :up, comment: "1 when the local cell answers its control socket",
+          tags: %i[ cell ], aggregation: :most_recent
+        gauge :running, comment: "Workers busy right now", tags: %i[ cell ], aggregation: :most_recent
+        gauge :queued, comment: "Connections waiting for a worker", tags: %i[ cell ], aggregation: :most_recent
+        gauge :queue_high_water, comment: "Deepest the queue has been since boot",
+          tags: %i[ cell ], aggregation: :most_recent
+        gauge :cancelled, comment: "Callers that gave up before the cell answered (a floor)",
+          tags: %i[ cell ], aggregation: :most_recent
+        gauge :killed, comment: "Workers killed since boot, by cause",
+          tags: %i[ cell cause ], aggregation: :most_recent
+        gauge :uptime_seconds, comment: "Seconds since the supervisor booted",
+          tags: %i[ cell ], aggregation: :most_recent
+
+        collect { Yabeda::HotCell.collect_stats }
+      end
+
+      subscribe_to_performs
+    end
+
+    def self.collect_stats
+      ::HotCell.cells.each_value do |cell|
+        next unless cell.enabled?
+
+        response = cell.metrics
+        Yabeda.hotcell.up.set({ cell: cell.name }, response&.ok? ? 1 : 0)
+        next unless response&.ok?
+
+        set_counters cell, response.result
+      end
+    rescue => error
+      # A scrape must not fail because a cell is misbehaving. In a Rails application this is Rails.error.
+      ::ActiveSupport.error_reporter.report error, handled: true
+    end
+
+    # The subscriber raises into whoever called instrument, so an unguarded bug here would arrive as a failed
+    # call rather than as missing metrics.
+    def self.subscribe_to_performs
+      ::ActiveSupport::Notifications.subscribe "perform.hot_cell" do |event|
+        record_perform event
+      rescue => error
+        ::ActiveSupport.error_reporter.report error, handled: true
+      end
+    end
+
+    # A failed call is not reported from here: the raise the caller sees already reaches the error reporter.
+    def self.record_perform(event)
+      labels = { cell: event.payload[:cell], operation: event.payload[:operation] }
+
+      # Empty rather than absent, because a label that is sometimes missing is a separate series in Prometheus
+      # and a query by code would silently split.
+      Yabeda.hotcell.requests.increment(labels.merge(code: event.payload[:code] || "ok",
+                                                     cause: event.payload[:cause].to_s))
+      Yabeda.hotcell.perform.measure(labels, (event.payload[:perform_ms] || 0) / 1000.0)
+    end
+
+    private_class_method def self.set_counters(cell, counters)
+      tags = { cell: cell.name }
+
+      Yabeda.hotcell.running.set(tags, counters[:running])
+      Yabeda.hotcell.queued.set(tags, counters[:queued])
+      Yabeda.hotcell.queue_high_water.set(tags, counters[:queue_high_water])
+      Yabeda.hotcell.cancelled.set(tags, counters[:cancelled])
+      Yabeda.hotcell.uptime_seconds.set(tags, counters[:uptime_s])
+      ::HotCell::Codes::PERMANENT_BY_CAUSE.each_key do |cause|
+        Yabeda.hotcell.killed.set(tags.merge(cause: cause), counters[:killed_by].fetch(cause.to_sym, 0))
+      end
+    end
+  end
+end

data/lib/yabeda-hotcell.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Bundler auto-requires a gem named "yabeda-hotcell" as "yabeda-hotcell", then as "yabeda/hotcell". This gem
+# uses neither path, because hot_cell/ is what yields the HotCell constant under the default inflection.
+require "yabeda/hot_cell"

metadata

@@ -1,25 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-hotcell
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Dalessio
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hotcell-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: |
+  Yabeda metrics for an application that calls HotCell cells: a counter and a histogram for every call,
+  and gauges polled from each local cell's control socket.
 email:
 - mike@37signals.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
+- lib/yabeda-hotcell.rb
+- lib/yabeda/hot_cell.rb
+- lib/yabeda/hot_cell/version.rb
 homepage: https://github.com/basecamp/hotcell
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/basecamp/hotcell
+  source_code_uri: https://github.com/basecamp/hotcell/tree/v0.6.0/yabeda-hotcell
+  changelog_uri: https://github.com/basecamp/hotcell/blob/v0.6.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/basecamp/hotcell/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -28,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -37,6 +76,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Yabeda metrics for HotCell. Reserves the name; the real gem will be published
-  shortly.
+summary: Yabeda metrics for HotCell.
 test_files: []