carrot_rpc 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ba255fb6d2e277988ef84326c30193fe9dc0ca7
-  data.tar.gz: 7c8a26c482a1041887f7ac73eb5bd9396966a3fe
+  metadata.gz: 7e96c407c46a0ad19683945d17d3994632ff201b
+  data.tar.gz: bdfc99b0940899499998b799974a9ec9b025cd47
 SHA512:
-  metadata.gz: ca9b37d0788166fe678d7281cfeac3846f662370b6a5ac6de02fc3567df59ddce010999f61555603ba7c0170f338ee5f32a9d70e7e7f71f2bc86e0cac7bf358b
-  data.tar.gz: 71d2becd5fa8dab667c8b82c3e98e194c29cd46ab95d1997304597aa929741cb2a7287fdb936d46d991c160e06642fde18b504953c868e628329a71fb8d9ad7e
+  metadata.gz: 86f4f8e38c488b1ece54d10ba3ad5a8cd97db8d39103d99801d6b44849da75531fdc448ba5ab968068cc65751179734e3bd723b45d9c721e1d4c927ac17f7aa0
+  data.tar.gz: 9f334bc0fd7b57c9155936a2ac5f5894291fad40ac1ca538509147ae41edc5502fb376a310d10fad8f8fde8c214f46c6c6fac9ed2b967b61ca8b3bc05db053f6

data/CHANGELOG.md

@@ -3,49 +3,52 @@
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
 - [Changelog](#changelog)
+  - [v1.1.0](#v110)
+    - [Enhancements](#enhancements)
+    - [Bug Fixes](#bug-fixes)
   - [v1.0.0](#v100)
     - [Incompatible Changes](#incompatible-changes)
   - [v0.8.1](#v081)
-    - [Enhancements](#enhancements)
-  - [v0.8.0](#v080)
     - [Enhancements](#enhancements-1)
+  - [v0.8.0](#v080)
+    - [Enhancements](#enhancements-2)
   - [v0.7.1](#v071)
-    - [Bug Fixes](#bug-fixes)
-  - [v0.7.0](#v070)
     - [Bug Fixes](#bug-fixes-1)
+  - [v0.7.0](#v070)
+    - [Bug Fixes](#bug-fixes-2)
     - [Incompatible Changes](#incompatible-changes-1)
   - [v0.6.0](#v060)
-    - [Enhancements](#enhancements-2)
+    - [Enhancements](#enhancements-3)
   - [v0.5.1](#v051)
-    - [Bug Fixes](#bug-fixes-2)
+    - [Bug Fixes](#bug-fixes-3)
   - [v0.5.0](#v050)
-    - [Enhancements](#enhancements-3)
+    - [Enhancements](#enhancements-4)
     - [Incompatible Changes](#incompatible-changes-2)
   - [v0.4.1](#v041)
-    - [Bug Fixes](#bug-fixes-3)
-  - [v0.4.0](#v040)
-    - [Enhancements](#enhancements-4)
     - [Bug Fixes](#bug-fixes-4)
-    - [Incompatible Changes](#incompatible-changes-3)
-  - [v0.3.0](#v030)
+  - [v0.4.0](#v040)
     - [Enhancements](#enhancements-5)
     - [Bug Fixes](#bug-fixes-5)
-  - [v0.2.3](#v023)
+    - [Incompatible Changes](#incompatible-changes-3)
+  - [v0.3.0](#v030)
     - [Enhancements](#enhancements-6)
     - [Bug Fixes](#bug-fixes-6)
+  - [v0.2.3](#v023)
+    - [Enhancements](#enhancements-7)
+    - [Bug Fixes](#bug-fixes-7)
     - [Upgrading](#upgrading)
   - [v0.2.1](#v021)
-    - [Bug Fixes](#bug-fixes-7)
-  - [v0.2.0](#v020)
-    - [Enhancements](#enhancements-7)
     - [Bug Fixes](#bug-fixes-8)
-    - [Incompatible Changes](#incompatible-changes-4)
-  - [v0.1.2](#v012)
+  - [v0.2.0](#v020)
     - [Enhancements](#enhancements-8)
     - [Bug Fixes](#bug-fixes-9)
-  - [v0.1.1](#v011)
+    - [Incompatible Changes](#incompatible-changes-4)
+  - [v0.1.2](#v012)
     - [Enhancements](#enhancements-9)
     - [Bug Fixes](#bug-fixes-10)
+  - [v0.1.1](#v011)
+    - [Enhancements](#enhancements-10)
+    - [Bug Fixes](#bug-fixes-11)
     - [Incompatible Changes](#incompatible-changes-5)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -53,6 +56,22 @@
 # Changelog
 All significant changes in the project are documented here.
 
+## v1.1.0
+
+### Enhancements
+* [#55](https://github.com/C-S-D/carrot_rpc/pull/55) - [@shamil614](https://github.com/shamil614)
+  * `ActiveSupport::Notifications` to enable universal metrics gathering
+    * `client.SERVER_QUEUE.remote_call` will include `correlation_id` of request
+    * `server.SERVER_QUEUE.consume` will include `correlation_id` of request
+* [#56](https://github.com/C-S-D/carrot_rpc/pull/56) - [@KronicDeth](https://gitub.com/KronicDeth)
+  * Match client log tags to server log tags.
+    * Client tags will start with `client` as server tags start with `server`. 
+    * When available, it will have `server_queue=SERVER_QUEUE_NAME`.
+    * Finally, it will always have `correlation_id=CORRELATION_ID`.
+
+### Bug Fixes
+* [#56](https://github.com/C-S-D/carrot_rpc/pull/56) - `client.SERVER_QUEUE_NAME.remote_call` `ActiveSupport::Notification` was using the server queue object instead of name, so it interpolated as `#<...>`. - [@KronicDeth](https://gitub.com/KronicDeth)
+
 ## v1.0.0
 ### Incompatible Changes
 * [#48](https://github.com/C-S-D/carrot_rpc/pull/48) - Remove queue for correlation_id when RpcClient#wait_for_result raises an exception. -[@nward](https://github.com/nward)

data/lib/carrot_rpc.rb

@@ -2,6 +2,7 @@
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/hash/except"
 require "active_support/dependencies/autoload"
+require "active_support/notifications"
 require "bunny"
 
 # standard library

data/lib/carrot_rpc/rpc_client.rb

@@ -70,16 +70,26 @@ class CarrotRpc::RpcClient
   # @param remote_method [String, Symbol] the method to be called on current receiver
   # @param params [Hash] the arguments for the method being called.
   # @return [Object] the result of the method call.
+  #
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def remote_call(remote_method, params)
     start
     subscribe
+    server_queue_name = server_queue.name
     correlation_id = SecureRandom.uuid
-    logger.with_correlation_id(correlation_id) do
-      params = self.class.before_request.call(params) if self.class.before_request
-      publish(correlation_id: correlation_id, method: remote_method, params: request_key_formatter(params))
-      wait_for_result(correlation_id)
-    end
+    extra = { correlation_id: correlation_id }
+
+    ActiveSupport::Notifications.instrument("client.#{server_queue_name}.remote_call", extra: extra) {
+      logger.tagged("client", "server_queue=#{server_queue_name}", "correlation_id=#{correlation_id}") {
+        params = self.class.before_request.call(params) if self.class.before_request
+        publish(correlation_id: correlation_id, method: remote_method, params: request_key_formatter(params))
+        wait_for_result(correlation_id)
+      }
+    }
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   def wait_for_result(correlation_id)
     # Should be good to timeout here because we're blocking in the main thread here.
@@ -138,15 +148,17 @@ class CarrotRpc::RpcClient
   private
 
   def consume(_delivery_info, properties, payload)
-    logger.with_correlation_id(properties[:correlation_id]) do
+    correlation_id = properties[:correlation_id]
+
+    logger.tagged("client", "correlation_id=#{correlation_id}") {
       logger.debug "Receiving response: #{payload}"
 
       response = JSON.parse(payload).with_indifferent_access
 
       result = parse_response(response)
       result = response_key_formatter(result).with_indifferent_access if result.is_a? Hash
-      @results[properties[:correlation_id]].push(result)
-    end
+      @results[correlation_id].push(result)
+    }
   end
 
   # Logic to find the data from the RPC response.

data/lib/carrot_rpc/rpc_server.rb

@@ -59,19 +59,25 @@ class CarrotRpc::RpcServer
                  request_message: request_message
   end
 
-  def consume(_delivery_info, properties, payload)
-    logger.tagged("server", "queue=#{server_queue.name}", "correlation_id=#{properties[:correlation_id]}") do
-      logger.debug "Receiving request: #{payload}"
-
-      # rubocop:disable Lint/RescueException
-      begin
-        request_message = JSON.parse(payload).with_indifferent_access
-
-        process_request(request_message, properties: properties)
-      rescue Exception => exception
-        logger.error(exception)
+  def consume(_delivery_info, properties, payload) # rubocop:disable Metrics/MethodLength
+    queue_name = server_queue.name
+    correlation_id = properties[:correlation_id]
+    extra = { correlation_id: correlation_id }
+
+    ActiveSupport::Notifications.instrument("server.#{queue_name}.consume", extra: extra) do
+      logger.tagged("server", "queue=#{queue_name}", "correlation_id=#{correlation_id}") do
+        logger.debug "Receiving request: #{payload}"
+
+        # rubocop:disable Lint/RescueException
+        begin
+          request_message = JSON.parse(payload).with_indifferent_access
+
+          process_request(request_message, properties: properties)
+        rescue Exception => exception
+          logger.error(exception)
+        end
+        # rubocop:enable Lint/RescueException
       end
-      # rubocop:enable Lint/RescueException
     end
   end
 

data/lib/carrot_rpc/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module CarrotRpc
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrot_rpc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Scott Hamilton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Remote Procedure Call (RPC) using the Bunny Gem over RabbitMQ