clustered_rpc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9bc292ea42805f08ade35dbd5ccc1856fecfdebff8443c943ee9bc4f9dd4a72
-  data.tar.gz: 3d18c96eecd6b8fe288a9130a9f15b660cc4031495d196c0fed5ea1a7aad1fb6
+  metadata.gz: bdb73943e182ea222043e914d49a263e20df8aa8db4c2ccc47eefab74061edb6
+  data.tar.gz: 82547d220ca00679d58701089728728194206e9cbcfc844040acef32b3b9b8d5
 SHA512:
-  metadata.gz: 54f0b6a5c19a38ef87c0acd1c75449a307fc4605812baa6986fb5ae0e4f1ac6abce3211e5b4989329212b885f7de9f9d99b89f115287ab4c6f5b89bbfe2d628d
-  data.tar.gz: 1e9fe2a6c30c8c8e970ee648b6fd57e8f9a31900507a820b5bddccccd140d68c905798fc0d40c1ae7da61f637b2c01dbc35886cd865187e2f59e65759376cbd3
+  metadata.gz: 2d7aa773597cc740ab719bcc2ab510197b0db60041ae26e18eb97807b31c97890baa78fffa5f485e50ae15c0a162f2c85da8dde91c5aa7e7648939dab0af5e33
+  data.tar.gz: 1371470d9cd5a1db5fc95404df7d97e3fa7cfbd99da2c48a8c01b3ed1fecd65cae2308d03eda82d3250ae1a1e2d45b060ce58b6d057d0f8b4ad01b8420ad0a37

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clustered_rpc (0.1.0)
+    clustered_rpc (0.2.0)
       activesupport
 
 GEM

data/README.md

@@ -1,8 +1,12 @@
 # ClusteredRpc
+_RPC = Remote Procedure Calls_
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clustered`. To experiment with that code, run `bin/console` for an interactive prompt.
+ClusteredRpc allows you to run code on every ruby process running within your cluster.
+
+Clusters are defined using a shared pubsub broker and a common namespace.
+
+Currently only Redis PubSub is supported by ClusteredRpc.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,24 +24,110 @@ Or install it yourself as:
 
     $ gem install clustered_rpc
 
+## Configuration
+```ruby
+# Using Redis PubSub
+ClusteredRpc.config do |c|
+  c.transport_class = ClusteredRpc::Transport::RedisCluster
+  c.cluster_namespace = "myapplication"
+  c.options = {redis_url: "redis://127.0.0.1:6379/3"}
+end
+
+```
+If you are using the same redis server for multiple deployments of your application, then use different namespaces for each.
+```ruby
+ClusteredRpc.config do |c|
+  c.transport_class = ClusteredRpc::Transport::RedisCluster
+  # Using the same redis database for the development environment as well...
+  c.cluster_namespace = "myapplication_dev"
+  c.options = {redis_url: "redis://127.0.0.1:6379/3"}
+end
+```
 ## Usage
 
-Works on *static* class methods!!!
+ClusteredRpc allows static (class) methods to be run on every process within the cluster!
 
 ```ruby
 class MyClass
+  # makes all static-methods available via 'clustered_rpc' proxy method
   include ClusteredRpc::Methods
 
   def self.do_the_thing
     # important code living on many servers in the cluster
-    puts "I'm important!"
+    return "I'm important!"
   end
 end
 
 # Run the method on every process running in the cluster
+# `do_the_thing` is run on each process and the results are returned in a Hash
 MyClass.clustered_rpc.do_the_thing
+=> {
+    :request_id => "f030b020e058d7a4",
+       :success => true,
+       :results => {
+        "1ca8a7be5e" => {
+            "seconds" => 3.3e-05,
+             "result" => "I'm important"
+        },
+        "293a7be9ac" => {
+            "seconds" => 4.2e-05,
+             "result" => "I'm important"
+        }        
+    }
+}
 ```
+The keys in the results Hash (`1ca8a7be5e` and `293a7be9ac`) are the unique instance_ids assigned to each process by ClusteredRpc
+
+```ruby
+# Get the stats for your entire cluster
+ClusteredRpc::Info.clustered_rpc.stats
+=> { 
+  :request_id => "c634e6347b98a0",
+     :success => true,
+     :results => {
+      "ica817be5e" => {
+              :instance_id => "1ca8a7be5e",
+          :transport_class => "ClusteredRpc::Transport::LocalProcess",
+                  :options => {},
+               :process_id => 23566,
+                   :uptime => "03:14",
+                  :used_mb => 35.03,
+          :startup_command => "ruby-2.5.1/bin/rails console",
+             :process_type => "Rails Console",
+              :count_nodes => {}
+      },
+      {
+              :instance_id => "293a7be9ac",
+          :transport_class => "ClusteredRpc::Transport::LocalProcess",
+                  :options => {},
+               :process_id => 23736,
+                   :uptime => "42:22",
+                  :used_mb => 127.69,
+          :startup_command => "ruby-2.5.1/bin/puma",
+             :process_type => "Web Server",
+              :count_nodes => {}
+      }
+
+   }
+}
 
+```
+Of course, methods can be run locally (without `.clustered_rpc`) as well
+```ruby
+# Get the stats for the local process
+ClusteredRpc::Info.stats
+=> {
+        :instance_id => "1ca8a7be5e",
+    :transport_class => "ClusteredRpc::Transport::LocalProcess",
+            :options => {},
+         :process_id => 23566,
+             :uptime => "00:01",
+            :used_mb => 35.03,
+    :startup_command => "ruby-2.5.1/bin/rails console",
+       :process_type => "Rails Console",
+        :count_nodes => {}
+}
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -46,7 +136,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clustered.
+Bug reports and pull requests are welcome on GitHub at https://github.com/megalithtracers/clustered_rpc.
 
 ## License
 

data/lib/clustered_rpc.rb

@@ -11,6 +11,7 @@ module ClusteredRpc
 
   @@instance_id = SecureRandom.hex(5)
   @@logger = ::Logger.new(STDOUT)
+  @@cluster_namespace = "clustered_rpc"
   @@transport_class = nil
   @@transport = nil
   @@options = {}
@@ -21,6 +22,9 @@ module ClusteredRpc
   def self.instance_id=(instance_id); @@instance_id = instance_id; end
   def self.instance_id; @@instance_id; end
 
+  def self.cluster_namespace=(cluster_namespace); @@cluster_namespace = cluster_namespace; end
+  def self.cluster_namespace; @@cluster_namespace; end
+
   def self.transport_class=(transport_class); @@transport_class = transport_class; end
   def self.transport_class; @@transport_class; end
 
@@ -41,8 +45,11 @@ module ClusteredRpc
     block.call(self)
 
     @@instance_id ||= SecureRandom.hex(5)
-    raise "Please set transport_class in ClusteredRpc.config" if transport_class.nil? 
-    logger.info "Clustered using #{@@transport_class}"
+    if transport_class.nil?
+      require "clustered_rpc/transport/local_process"
+      @@transport_class = ClusteredRpc::Transport::LocalProcess
+    end
+    logger.info "Clustered using #{@@transport_class}[#{@@cluster_namespace}]"
     @@transport = @@transport_class.new
     @@transport.connect
 

data/lib/clustered_rpc/info.rb

@@ -1,12 +1,13 @@
-require 'clustered/rpc_methods'
+require 'clustered_rpc/methods'
 require 'open3'
 
 module ClusteredRpc
   class Info
     include ClusteredRpc::Methods
 
-    def self.stats
+    def self.stats(detailed_memory_stats = false)
       require 'objspace'
+      r = 
       { instance_id: ClusteredRpc.instance_id, 
         transport_class: ClusteredRpc.transport_class.name.to_s, 
         options: ClusteredRpc.options,
@@ -15,11 +16,13 @@ module ClusteredRpc
         used_mb: memory_used,
         startup_command: startup_command,
         process_type: lookup_process_type(startup_command),
-        count_objects_size: ObjectSpace.count_objects_size,
-        gc: GC.stat,
-        count_nodes: ObjectSpace.count_nodes
+        count_nodes: ObjectSpace.count_nodes,
       }
-
+      if detailed_memory_stats
+        r[:count_objects_size] = ObjectSpace.count_objects_size
+        r[:gc] = GC.stat
+      end
+      r
     end
 
     def self.startup_command

data/lib/clustered_rpc/transport/redis_cluster.rb

@@ -7,7 +7,7 @@ module ClusteredRpc
       def initialize
         @redis_subscriber = nil
         @redis_publish = nil
-        @redis_message_pubsub_key = "__cluster_messages"
+        @redis_message_pubsub_key = "__#{ClusteredRpc.cluster_namespace}_messages"
         connect
       end
 

data/lib/clustered_rpc/version.rb

@@ -1,3 +1,3 @@
 module ClusteredRpc
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clustered_rpc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - megalithtracers@gmail.com
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport