gruf-profiler 0.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Changelog for the gruf-profiler gem.
+
+h3. 0.1.0
+
+- Add rubocop
+- Add bundler-audit
+- Add configuration options for logging for memory profiler
+
+h3. 0.0.1
+
+- Initial public release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at splittingred@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -0,0 +1,69 @@
+# 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)
+
+Adds a profiler for [gruf](https://github.com/bigcommerce/gruf) 1.0.0 or later.
+
+## Installation
+
+```ruby
+gem 'gruf-profiler'
+```
+
+Then in an initializer or before use, after loading gruf:
+
+```ruby
+require 'gruf/profiler'
+Gruf::Hooks::Registry.add(:profiler, Gruf::Profiler::Hook)
+```
+
+## Usage
+
+gruf-profiler includes and requires the [rbtrace](https://github.com/tmm1/rbtrace/) 
+and [memory_profiler](https://github.com/SamSaffron/memory_profiler) gems by default.
+ 
+### rbtrace
+
+rbtrace is automatically loaded for every gruf service. You can view the 
+[README](https://github.com/tmm1/rbtrace/blob/master/README.md) for rbtrace for more information,
+but the general idea is that you can run against a running gruf instance to see tracing 
+information about a gruf server:
+
+```bash
+rbtrace -p <PID_OF_GRUF> --firehose
+```
+
+Other options for the rbtrace binary are detailed in the rbtrace documentation.
+
+### Memory Profiler
+
+[Memory Profiler](https://github.com/SamSaffron/memory_profiler) is a gem that allows you to get
+a memory usage report of a block of Ruby code. gruf-profiler automatically wraps gruf service
+requests with this and provides a report to the logger (at a default level of DEBUG).
+
+You can adjust that log level to say, INFO, like so:
+
+```ruby
+Gruf.configure do |c|
+  c.hook_options[:profiler] = {
+    log_level: :info
+  }
+end
+```
+
+## License
+
+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 
+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/gruf-profiler.gemspec

@@ -0,0 +1,42 @@
+# 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
+# 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.
+#
+$:.push File.expand_path("../lib", __FILE__)
+require 'gruf/profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf-profiler'
+  spec.version       = Gruf::Profiler::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['shaun.mccormick@bigcommerce.com']
+
+  spec.summary       = %q{Plugin for profiling gruf-backed gRPC requests}
+  spec.description   = %q{Adds memory reporting and rbtrace to gruf servers}
+  spec.homepage      = 'https://github.com/bigcommerce/gruf-profiler'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-profiler.gemspec']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'pry', '~> 0'
+
+  spec.add_runtime_dependency 'stackprof', '~> 0'
+  spec.add_runtime_dependency 'rbtrace', '~> 0'
+  spec.add_runtime_dependency 'memory_profiler', '~> 0.9'
+end

data/lib/gruf/profiler.rb

@@ -0,0 +1,26 @@
+# 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
+# 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.
+#
+require_relative 'profiler/version'
+require_relative 'profiler/hook'
+
+module Gruf
+  ##
+  # Initialization class for the profiler
+  #
+  module Profiler
+  end
+end

data/lib/gruf/profiler/hook.rb

@@ -0,0 +1,106 @@
+# 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
+# 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.
+#
+module Gruf
+  module Profiler
+    ##
+    # Gruf hook that automatically loads rbtrace and memory profiler
+    #
+    # Add to your gruf initializer:
+    #   require 'gruf/profiler'
+    #   Gruf::Hooks::Registry.add(:profiler, Gruf::Profiler::Hook)
+    #
+    class Hook < Gruf::Hooks::Base
+      ##
+      # Initializes the hook
+      #
+      def setup
+        require 'rbtrace'
+        require 'memory_profiler'
+      end
+
+      ##
+      # 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)
+        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}")
+        else
+          log('Memory profiler did not return a report')
+        end
+        result
+      end
+
+      private
+
+      ##
+      # Log a message with a configurable level to the gruf logger
+      # @param [String]
+      #
+      def log(msg)
+        level = options.fetch(:log_level, :debug).to_sym
+        Gruf.logger.send(level, msg)
+      end
+
+      ##
+      # Parse the method signature
+      #
+      # @return [String]
+      #
+      def method_key(call_signature)
+        "#{service_key}.#{call_signature.to_s.gsub('_without_intercept', '')}"
+      end
+
+      ##
+      # Determine a log-friendly service key name
+      #
+      # @return [String]
+      #
+      def service_key
+        service.class.name.underscore.tr('/', '.')
+      end
+
+      ##
+      # Get profiler options
+      #
+      # @return [Hash]
+      #
+      def options
+        @options.fetch(:profiler, {})
+      end
+
+      ##
+      # Get sub-options for the memory profiler
+      #
+      # @return [Hash]
+      #
+      def memory_profiler_options
+        options.fetch(:memory_profiler, top: 50)
+      end
+    end
+  end
+end

data/lib/gruf/profiler/version.rb

@@ -0,0 +1,21 @@
+# 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
+# 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.
+#
+module Gruf
+  module Profiler
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: gruf-profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  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: rbtrace
+  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: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Adds memory reporting and rbtrace to gruf servers
+email:
+- shaun.mccormick@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- gruf-profiler.gemspec
+- lib/gruf/profiler.rb
+- lib/gruf/profiler/hook.rb
+- lib/gruf/profiler/version.rb
+homepage: https://github.com/bigcommerce/gruf-profiler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Plugin for profiling gruf-backed gRPC requests
+test_files: []