gruf-profiler 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46bfbb7bd1631ffae355f4a520b5bbf9574f6dde
-  data.tar.gz: 0f7e4c1a87264e8be7d683f6c6610020ab1da207
+  metadata.gz: c9c14f9f878d1d5ce008eebb556adc64de1cde19
+  data.tar.gz: cf0e4090eb21bb266b796a89fb2b0d756c640355
 SHA512:
-  metadata.gz: cbc0f155cf7070e1346bbc8f2554e7887654f35769d2e29885264cfd3da627b611b0b654af90de0bd92e8e046cf7d1a912787811df5238deeb309b9252b94702
-  data.tar.gz: f8339f9b59ba2519f5ba8ab07ebe15d382379089040b2216dd06ca1b41183fef58c6a8a28afaa4c09a7b9fafd5cec30da077f6d82bf3616f603feb0668d25670
+  metadata.gz: fb30135dd11b0b76cc4e7ccc22fd19d4aefeea049af33d26495b59139f7e6a8818416b33346456da7f89d6eaa4102304016111a3808dc5aa14911eca63af9a1c
+  data.tar.gz: c5b5907e9ad2790f8e9164c8866fd379bfcf7ce4d75d26e73af1e87edde8bd3eca47f51337e02f8ecb151bd36310fcda04d677161c944ce293a6e05ff381dbab

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 Changelog for the gruf-profiler gem.
 
+h3. 1.0.0
+
+- Support for gruf 2.0
+
 h3. 0.1.0
 
 - Add rubocop

data/README.md

@@ -1,8 +1,8 @@
 # gruf-profiler - Profiler for gruf
 
-[![Build Status](https://travis-ci.org/bigcommerce/gruf-profiler.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf-profiler) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-profiler.svg?branch=master)](http://inch-ci.org/github/bigcommerce/gruf-profiler)
+[![Build Status](https://travis-ci.org/bigcommerce/gruf-profiler.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf-profiler) [![Gem Version](https://badge.fury.io/rb/gruf-profiler.svg)](https://badge.fury.io/rb/gruf-profiler) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-profiler.svg?branch=master)](http://inch-ci.org/github/bigcommerce/gruf-profiler)
 
-Adds a profiler for [gruf](https://github.com/bigcommerce/gruf) 1.0.0 or later.
+Adds a profiler interceptor for [gruf](https://github.com/bigcommerce/gruf) 2.0.0 or later.
 
 ## Installation
 
@@ -14,7 +14,10 @@ Then in an initializer or before use, after loading gruf:
 
 ```ruby
 require 'gruf/profiler'
-Gruf::Hooks::Registry.add(:profiler, Gruf::Profiler::Hook)
+
+Gruf.configure do |c|
+  c.interceptors[Gruf::Profiler::Interceptor] = {}
+end
 ```
 
 ## Usage
@@ -45,7 +48,7 @@ You can adjust that log level to say, INFO, like so:
 
 ```ruby
 Gruf.configure do |c|
-  c.hook_options[:profiler] = {
+  c.interceptors[Gruf::Profiler::Interceptor] = {
     log_level: :info
   }
 end

data/lib/gruf/profiler.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -15,8 +14,11 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 require_relative 'profiler/version'
-require_relative 'profiler/hook'
+require_relative 'profiler/interceptor'
 
+##
+# Base gruf module
+#
 module Gruf
   ##
   # Initialization class for the profiler

data/lib/gruf/profiler/{hook.rb → interceptor.rb}

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -14,6 +13,9 @@
 # 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.
 #
+require 'rbtrace'
+require 'memory_profiler'
+
 module Gruf
   module Profiler
     ##
@@ -21,34 +23,21 @@ module Gruf
     #
     # Add to your gruf initializer:
     #   require 'gruf/profiler'
-    #   Gruf::Hooks::Registry.add(:profiler, Gruf::Profiler::Hook)
+    #   Gruf.configure do |c|
+    #     c.interceptors[Gruf::Profiler::Interceptor] = {}
+    #   end
     #
-    class Hook < Gruf::Hooks::Base
-      ##
-      # Initializes the hook
-      #
-      def setup
-        require 'rbtrace'
-        require 'memory_profiler'
-      end
-
+    class Interceptor < Gruf::Interceptors::ServerInterceptor
       ##
       # Wraps the entire gruf call and provides memory reports
       #
-      # @param [Symbol] call_signature
-      # @param [Object] _request
-      # @param [GRPC::ActiveCall] _active_call
-      #
-      def outer_around(call_signature, _request, _active_call, &_block)
+      def call
         result = nil
         report = MemoryProfiler.report(memory_profiler_options) do
           result = yield
         end
         if report
-          pp_options = memory_profiler_options.fetch(:pretty_print_options, {})
-          io_obj = pp_options.fetch(:io, nil)
-          report_string = io_obj ? report.pretty_print(io_obj, pp_options) : report.pretty_print(pp_options)
-          log("gruf profile for #{service_key}.#{method_key(call_signature)}:\n#{report_string}")
+          profile(report)
         else
           log('Memory profiler did not return a report')
         end
@@ -58,48 +47,41 @@ module Gruf
       private
 
       ##
-      # Log a message with a configurable level to the gruf logger
-      # @param [String]
+      # Profile the given report to logs
       #
-      def log(msg)
-        level = options.fetch(:log_level, :debug).to_sym
-        Gruf.logger.send(level, msg)
-      end
-
-      ##
-      # Parse the method signature
+      # @param [MemoryProfiler::Reporter] report
       #
-      # @return [String]
-      #
-      def method_key(call_signature)
-        "#{service_key}.#{call_signature.to_s.gsub('_without_intercept', '')}"
+      def profile(report)
+        io_obj = pretty_print_options.fetch(:io, nil)
+        report_string = io_obj ? report.pretty_print(io_obj, pretty_print_options) : report.pretty_print(pretty_print_options)
+        log("gruf profile for #{request.method_name}:\n#{report_string}")
       end
 
       ##
-      # Determine a log-friendly service key name
-      #
-      # @return [String]
+      # Log a message with a configurable level to the gruf logger
+      # @param [String]
       #
-      def service_key
-        service.class.name.underscore.tr('/', '.')
+      def log(msg)
+        level = options.fetch(:log_level, :debug).to_sym
+        Gruf.logger.send(level, msg)
       end
 
       ##
-      # Get profiler options
+      # Get sub-options for the memory profiler
       #
       # @return [Hash]
       #
-      def options
-        @options.fetch(:profiler, {})
+      def memory_profiler_options
+        options.fetch(:memory_profiler, top: 50)
       end
 
       ##
-      # Get sub-options for the memory profiler
+      # Get sub-options for pretty printing
       #
       # @return [Hash]
       #
-      def memory_profiler_options
-        options.fetch(:memory_profiler, top: 50)
+      def pretty_print_options
+        memory_profiler_options.fetch(:pretty_print_options, {})
       end
     end
   end

data/lib/gruf/profiler/version.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -16,6 +15,6 @@
 #
 module Gruf
   module Profiler
-    VERSION = '0.1.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,7 +120,7 @@ files:
 - README.md
 - gruf-profiler.gemspec
 - lib/gruf/profiler.rb
-- lib/gruf/profiler/hook.rb
+- lib/gruf/profiler/interceptor.rb
 - lib/gruf/profiler/version.rb
 homepage: https://github.com/bigcommerce/gruf-profiler
 licenses: