gruf 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406a8f82efb12ee3d64829d9888301899a2268caf34c5ce9f4ada8c50e32700c
-  data.tar.gz: 7b2f3d645e99fc49e53a97e75b5c59c6c9c1d35c2544642f52bc7607beb7aab0
+  metadata.gz: 05c56ef80530be6983b6a54c116f0ba6c378255688ced90d11b5bb1be69e7937
+  data.tar.gz: 72f3d26b4bc35a231e11198799c58823e5f4ff0f39a21798dddcb82d5c14fd68
 SHA512:
-  metadata.gz: 93c5133334095c2319e555d902b8f597c01ec5cdc1ecd48d670fcb247ee45df4304c7623f91f50142cd10277175f22ec7c6a6ea428f70834afeee0bfc3b1373d
-  data.tar.gz: 538bee3d11ee7a1fa45b375304857cf4f8daa18f0ef545e36a69a6d147a0b8cd911b759a2bdc7b9247e882829c95ae9ebc29a72852d126985555e8970b24694e
+  metadata.gz: 7390293027865fa85e904f0c82bf106bb3596aa949ea5f0bb13668511475dfed75cfddc68efb2beb4a832507cd92db266c9fc3bf903f9ece8779a21843bf532e
+  data.tar.gz: 765c589bdf841074a7c6944006670bb72794483c427cee52562bf232563771a929e91b3de32ef8cb72c208bad62ebe4d2bdffa8d5f9daa70dc29562e6f54cce5

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.8.0
+
+- Pass the controller request object into the request logging formatters [#92]  
+
 ### 2.7.1
 
 - Add `channel_credentials` option to `Gruf::Client` and `default_channel_credentials` option to `Gruf::Configuration` [#85] [#87]

data/lib/gruf/interceptors/instrumentation/request_logging/formatters/base.rb

@@ -28,9 +28,11 @@ module Gruf
             # Format the parameters into a loggable string. Must be implemented in every derivative class
             #
             # @param [Hash] _payload The incoming request payload
+            # @param [Gruf::Controllers::Request] request The current controller request
+            # @param [Gruf::Interceptors::Timer::Result] result The timed result of the response
             # @return [String] The formatted string
             #
-            def format(_payload)
+            def format(_payload, request:, result:)
               raise NotImplementedError
             end
           end

data/lib/gruf/interceptors/instrumentation/request_logging/formatters/logstash.rb

@@ -30,9 +30,11 @@ module Gruf
             # Format the request into a JSON-friendly payload
             #
             # @param [Hash] payload The incoming request payload
+            # @param [Gruf::Controllers::Request] request The current controller request
+            # @param [Gruf::Interceptors::Timer::Result] result The timed result of the response
             # @return [String] The JSON representation of the payload
             #
-            def format(payload)
+            def format(payload, request:, result:)
               payload.merge(format: 'json').to_json
             end
           end

data/lib/gruf/interceptors/instrumentation/request_logging/formatters/plain.rb

@@ -28,9 +28,11 @@ module Gruf
             # Format the request by only outputting the message body and params (if set to log params)
             #
             # @param [Hash] payload The incoming request payload
+            # @param [Gruf::Controllers::Request] request The current controller request
+            # @param [Gruf::Interceptors::Timer::Result] result The timed result of the response
             # @return [String] The formatted string
             #
-            def format(payload)
+            def format(payload, request:, result:)
               time = payload.fetch(:duration, 0)
               grpc_status = payload.fetch(:grpc_status, 'GRPC::Ok')
               route_key = payload.fetch(:method, 'unknown')

data/lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb

@@ -100,7 +100,7 @@ module Gruf
             payload[:time] = Time.now.to_s
             payload[:host] = Socket.gethostname
 
-            logger.send(type, formatter.format(payload))
+            logger.send(type, formatter.format(payload, request: request, result: result))
 
             raise result.message unless result.successful?
 

data/lib/gruf/version.rb

@@ -16,5 +16,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '2.7.1'
+  VERSION = '2.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler