yabeda-actioncable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 831ed6899ba655794b01af416ac4d66e7955c392d037882916221726202036c6
+  data.tar.gz: 7c0776e6e5503908e1c0801a20c66608d2384838b5e49d52b6cf67888c907f99
+SHA512:
+  metadata.gz: 3a07f5c277eff792bac3274a6928d77aa3a7bafd464dfea2a256e60ecda4a2a4ef2623d889758e0d32e35d1bedd3b82c0519060c0c3d5cf36f6a5c2e9a81e4ef
+  data.tar.gz: bf9837f3b0a068bff310f6c55fe9737137e20d4072443cbac80cf5ffb2fa315da9645567650492ae53f4ebad9c1eee1556b7e92735d3cede9b56cae81975a1fa

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Stanko K.R. <hey@stanko.io>
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/yabeda/action_cable/channel_concern.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module ActionCable
+    # :nodoc:
+    module ChannelConcern
+      extend ActiveSupport::Concern
+
+      included do
+        after_subscribe do
+          stream_from(
+            Yabeda::ActionCable.stream_name,
+            proc do |json|
+              payload = ActiveSupport::JSON.decode(json)
+              Yabeda::ActionCable.collect_measurment(payload)
+            end
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/action_cable/config.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/numeric/time"
+require "set"
+
+module Yabeda
+  module ActionCable
+    class Config
+      DEFAULT_BUCKETS = [ 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10 ].freeze
+      DEFAULT_STREAM_NAME = "yabeda.action_cable.metrics"
+      DEFAULT_COLLECTION_PERIOD = 60.seconds.freeze
+      DEFAULT_CHANNEL_CLASS_NAME = "ApplicationCable::Channel"
+
+      attr_accessor :default_buckets,
+                    :buckets,
+                    :default_tags,
+                    :tags,
+                    :stream_name,
+                    :collection_period,
+                    :channel_class_name
+      attr_writer :collection_cooldown_period
+
+      def initialize
+        reset!
+      end
+
+      def reset!
+        @default_buckets = DEFAULT_BUCKETS.dup
+        @buckets = {}
+        @default_tags = {}
+        @tags = {}
+        @stream_name = DEFAULT_STREAM_NAME
+        @collection_period = DEFAULT_COLLECTION_PERIOD.dup
+        @collection_cooldown_period = nil
+        @channel_class_name = DEFAULT_CHANNEL_CLASS_NAME
+      end
+
+      def collection_cooldown_period
+        if @collection_cooldown_period.nil?
+          collection_period / 2.0
+        else
+          @collection_cooldown_period
+        end
+      end
+
+      def buckets_for(metric)
+        buckets[metric] || default_buckets
+      end
+
+      def tags_for(metric)
+        tags[metric] || default_tags
+      end
+    end
+  end
+end

data/lib/yabeda/action_cable/measurment_collector.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/numeric/time"
+
+module Yabeda
+  module ActionCable
+    class MeasurmentCollector
+      attr_reader :config
+      attr_accessor :last_collected_at
+
+      def initialize(config:)
+        @config = config
+        @mutex = Mutex.new
+      end
+
+      def measure
+        ::ActionCable.server.broadcast(config.stream_name, measurment_payload)
+      end
+
+      def collect_measurment(payload)
+        return if on_cooldown?
+
+        run_unless_already_running do
+          self.last_collected_at = Time.now
+
+          measure_connection_count
+          measure_pubsub_latency(payload)
+        end
+      end
+
+      private
+
+        attr_reader :mutex
+
+        def measurment_payload
+          {
+            sent_at: Time.now.to_f
+          }
+        end
+
+        def on_cooldown?
+          last_collected_at&.after?(config.collection_cooldown_period.ago)
+        end
+
+        def run_unless_already_running
+          lock_ackquired = mutex.try_lock
+          return unless lock_ackquired
+
+          yield
+        ensure
+          mutex.unlock if lock_ackquired
+        end
+
+        def measure_connection_count
+          Yabeda.actioncable.connection_count.set(
+            Yabeda::ActionCable.config.tags_for(:connection_count),
+            ::ActionCable.server.connections.length
+          )
+        end
+
+        def measure_pubsub_latency(payload)
+          sent_at = payload["sent_at"] || raise(ArgumentError, "Payload must contain 'sent_at' key")
+          pubsub_latency = Time.now.to_f - sent_at
+          return unless pubsub_latency.positive? || pubsub_latency.zero?
+
+          Yabeda.actioncable.pubsub_latency.measure(
+            Yabeda::ActionCable.config.tags_for(:pubsub_latency),
+            pubsub_latency
+          )
+        end
+    end
+  end
+end

data/lib/yabeda/action_cable/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "yabeda/railtie"
+
+module Yabeda
+  module ActionCable
+    # :nodoc:
+    class Railtie < ::Rails::Railtie
+      initializer "yabeda-actioncable.metrics" do
+        ::Yabeda::ActionCable.install!
+      end
+    end
+  end
+end

data/lib/yabeda/action_cable/version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module ActionCable
+    MAJOR_VERSION = 0
+    MINOR_VERSION = 1
+    PATCH_VERSION = 0
+    PRERELEASE_VERSION = nil
+
+    VERSION = [
+      MAJOR_VERSION,
+      MINOR_VERSION,
+      PATCH_VERSION,
+      PRERELEASE_VERSION
+    ].reject(&:nil?).join(".").freeze
+  end
+end

data/lib/yabeda/action_cable.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require_relative "action_cable/version"
+
+require "yabeda"
+require "action_cable"
+require "active_support/notifications"
+
+require "yabeda/action_cable/config"
+require "yabeda/action_cable/measurment_collector"
+require "yabeda/action_cable/channel_concern"
+require "yabeda/action_cable/railtie"
+
+module Yabeda
+  module ActionCable
+    class Error < StandardError; end
+
+    class << self
+      MUTEX = Mutex.new
+
+      def installed?
+        yabeda_configured? && subscirbed? && channel_concern_included?
+      end
+
+      def install!
+        configure_yabeda!
+        subscribe!
+        include_channel_concern!
+      end
+
+      def stream_name
+        config.stream_name
+      end
+
+      def measure
+        measurment_collector.measure
+      end
+
+      def collect_measurment(payload)
+        measurment_collector.collect_measurment(payload)
+      end
+
+      def configure(&block)
+        raise ArgumentError, "Block is required" unless block_given?
+
+        config.tap do |cfg|
+          block.call(cfg)
+        end
+      end
+
+      def config
+        return @config if defined?(@config)
+
+        MUTEX.synchronize do
+          @config ||= Config.new
+        end
+      end
+
+      def reset!
+        unsubscribe!
+        config.reset!
+      end
+
+      private
+
+        attr_accessor :subscribers
+
+        def configure_yabeda!
+          Yabeda.group :actioncable do
+            Yabeda.configure do
+              histogram :pubsub_latency do
+                comment "The time it takes for a message to go through the " \
+                        "PubSub backend (e.g. Redis, SolidQueue, Postgres)"
+                unit :seconds
+                buckets Yabeda::ActionCable.config.buckets_for(:pubsub_latency)
+              end
+
+              histogram :broadcast_duration do
+                comment "The time it takes to broadcast a message to the PubSub backend"
+                unit :seconds
+                buckets Yabeda::ActionCable.config.buckets_for(:broadcast_duration)
+              end
+
+              histogram :transmission_duration do
+                comment "The time it takes to write a message to a WebSocket"
+                unit :seconds
+                buckets Yabeda::ActionCable.config.buckets_for(:transmission_duration)
+              end
+
+              histogram :action_execution_duration do
+                comment "The time it takes to perform an invoked action"
+                unit :seconds
+                buckets Yabeda::ActionCable.config.buckets_for(:action_execution_duration)
+              end
+
+              counter :confirmed_subscriptions,
+                      comment: "Total number of confirmed subscriptions"
+
+              counter :rejected_subscriptions,
+                      comment: "Total number of rejected subscriptions"
+
+              gauge :connection_count,
+                    comment: "Number of open WebSocket connections",
+                    aggregation: :sum
+
+              counter :allocations_during_action,
+                      comment: "Number of allocated objects during the invoication of an action"
+            end
+          end
+        end
+
+        def yabeda_configured?
+          Yabeda.groups.include?(:actioncable)
+        end
+
+        def subscribe!
+          unsubscribe!
+
+          subscribers.push(
+            ActiveSupport::Notifications.monotonic_subscribe("perform_action.action_cable") do |event|
+              tags = { channel: event.payload[:channel_class], action: event.payload[:action] }
+
+              Yabeda.actioncable.action_execution_duration.measure(
+                config.tags_for(:action_execution_duration).merge(tags),
+                event.duration / 1000.0
+              )
+
+              Yabeda.actioncable.allocations_during_action.increment(
+                config.tags_for(:allocations_during_action).merge(tags),
+                by: event.allocations
+              )
+            end
+          )
+
+          subscribers.push(
+            ActiveSupport::Notifications.monotonic_subscribe("transmit.action_cable") do |event|
+              Yabeda.actioncable.transmission_duration.measure(
+                config.tags_for(:transmission_duration).merge(
+                  channel: event.payload[:channel_class]
+                ),
+                event.duration / 1000.0
+              )
+            end
+          )
+
+          subscribers.push(
+            ActiveSupport::Notifications.monotonic_subscribe("transmit_subscription_confirmation.action_cable") do |event|
+              Yabeda.actioncable.confirmed_subscriptions.increment(
+                config.tags_for(:confirmed_subscriptions).merge(
+                  channel: event.payload[:channel_class]
+                ),
+                by: 1
+              )
+            end
+          )
+
+          subscribers.push(
+            ActiveSupport::Notifications.monotonic_subscribe("transmit_subscription_rejection.action_cable") do |event|
+              Yabeda.actioncable.rejected_subscriptions.increment(
+                config.tags_for(:rejected_subscriptions).merge(
+                  channel: event.payload[:channel_class]
+                ),
+                by: 1
+              )
+            end
+          )
+
+          subscribers.push(
+            ActiveSupport::Notifications.monotonic_subscribe("broadcast.action_cable") do |event|
+              Yabeda.actioncable.broadcast_duration.measure(
+                config.tags_for(:broadcast_duration),
+                event.duration / 1000.0
+              )
+            end
+          )
+        end
+
+        def unsubscribe!
+          subscribers&.each { |subscriber| ActiveSupport::Notifications.unsubscribe(subscriber) }
+          self.subscribers = []
+        end
+
+        def subscirbed?
+          subscribers.present?
+        end
+
+        def include_channel_concern!
+          config.channel_class_name.constantize.include(ChannelConcern)
+        end
+
+        def channel_concern_included?
+          config.channel_class_name.constantize.include?(ChannelConcern)
+        end
+
+        def measurment_collector
+          return @measurment_collector if defined?(@measurment_collector)
+
+          MUTEX.synchronize do
+            @measurment_collector ||= MeasurmentCollector.new(config: config)
+          end
+        end
+    end
+  end
+end

data/lib/yabeda/actioncable.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "action_cable"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-actioncable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanko K.R.
+bindir: exe
+cert_chain: []
+date: 2025-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: ''
+email:
+- stanko@stanko.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- Rakefile
+- lib/yabeda/action_cable.rb
+- lib/yabeda/action_cable/channel_concern.rb
+- lib/yabeda/action_cable/config.rb
+- lib/yabeda/action_cable/measurment_collector.rb
+- lib/yabeda/action_cable/railtie.rb
+- lib/yabeda/action_cable/version.rb
+- lib/yabeda/actioncable.rb
+homepage: https://github.com/monorkin/yabeda-actioncable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/monorkin/yabeda-actioncable
+  source_code_uri: https://github.com/monorkin/yabeda-actioncable
+  changelog_uri: https://github.com/monorkin/yabeda-actioncable/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Yabeda plugin for collecting ActionCable metrics
+test_files: []