grpc_newrelic_interceptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f48d560a64c635ca1a2a5766cdfeca630f653750b42e75155c05f96440ad15e
+  data.tar.gz: 6a3760be8b5e0d6f3661f5ff39b40e8980e91cccf2d24eb976000b9c1629fccc
+SHA512:
+  metadata.gz: e211b44a114ae8f521c8168e48fec436b88fdc8295befc29f8b26b72f239332fcbad2f7ca4e3e65dfc98513ff3840b137a6a582a11caa3cd4f8011a48a11ca4c
+  data.tar.gz: 46ebb1247039200b02bb35a6d39d5282cca0a4f2f14e74b26c317382e1b155ed4b46e9337e69a92a1e7dec4faed9226f6284cf34b5f8749dbf1142f06d11068a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_newrelic_interceptor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    grpc_newrelic_interceptor (0.0.1)
+      grpc
+      newrelic_rpm (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    google-protobuf (3.10.0-universal-darwin)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    grpc (1.24.0)
+      google-protobuf (~> 3.8)
+      googleapis-common-protos-types (~> 1.0)
+    method_source (0.9.2)
+    newrelic_rpm (6.7.0.359)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  google-protobuf
+  grpc_newrelic_interceptor!
+  pry
+  pry-doc
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nao Minami
+
+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/README.md

@@ -0,0 +1,49 @@
+# GrpcNewrelicInterceptor
+An interceptor for using New Relic with gRPC.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grpc_newrelic_interceptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grpc_newrelic_interceptor
+
+## Usage
+
+```ruby
+require 'grpc'
+require 'grpc_newrelic_interceptor'
+
+NewRelic::Agent.manual_start  # start newrelic agent
+
+server = GRPC::RpcServer.new(
+  interceptors: [
+    GrpcNewrelicInterceptor.new,
+  ]
+)
+server.handle(MyHandler.new)
+server.run_till_terminated_or_interrupted(['SIGINT'])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/south37/grpc_newrelic_interceptor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grpc_newrelic_interceptor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grpc_newrelic_interceptor.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grpc_newrelic_interceptor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grpc_newrelic_interceptor"
+  spec.version       = GrpcNewrelicInterceptor::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{An interceptor for using New Relic with gRPC.}
+  spec.description   = %q{An interceptor for using New Relic with gRPC.}
+  spec.homepage      = "https://github.com/south37/grpc_newrelic_interceptor"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/south37/grpc_newrelic_interceptor"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "google-protobuf"
+  spec.add_dependency "newrelic_rpm", "~> 6.0"
+  spec.add_dependency "grpc"
+end

data/lib/grpc_newrelic_interceptor.rb

@@ -0,0 +1,11 @@
+require "grpc_newrelic_interceptor/server_interceptor"
+require "grpc_newrelic_interceptor/version"
+
+module GrpcNewrelicInterceptor
+  class << self
+    def new(options = {})
+      ServerInterceptor.new(**options)
+    end
+  end
+end
+

data/lib/grpc_newrelic_interceptor/server_interceptor.rb

@@ -0,0 +1,100 @@
+require "newrelic_rpm"
+require "grpc"
+
+module GrpcNewrelicInterceptor
+  class ServerInterceptor < GRPC::ServerInterceptor
+    Request = Struct.new(:path, :user_agent, :request_method)
+
+    # @param [<#service_name>] ignored_services
+    # @param [#filter, nil] params_filter
+    def initialize(ignored_services: [], params_filter: nil)
+      @ignored_services = Set.new(ignored_services.map(&:service_name))
+      @params_filter    = params_filter
+    end
+
+    ##
+    # Intercept a unary request response call.
+    #
+    # @param [Object] request
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @param [Method] method
+    #
+    def request_response(request:, call:, method:)
+      return yield if !newrelic_enabled?
+
+      service_name = get_service_name(method)
+
+      return yield if @ignored_services.include?(service_name)
+
+      # NewRelic::Agent::Tracer.in_transaction is introduced in Newrelic v6.0.0.
+      # We can use it for custom instrumentation.
+      # cf. https://github.com/newrelic/rpm/blob/6.0.0.351/lib/new_relic/agent/tracer.rb#L42-L55
+      transaction_options = {
+        partial_name: get_partial_name(method),
+        category:     :rack,
+        options:      {
+          request:         get_request(method, call),
+          filtered_params: filter(request.to_h),
+        }
+      }
+      NewRelic::Agent::Tracer.in_transaction(transaction_options) do
+        yield
+      end
+    end
+
+    # NOTE: For now, we don't support server_streamer, client_streamer and bidi_streamer
+
+  private
+
+    # @param [Method] method
+    # @return [String]
+    def get_service_name(method)
+      method.owner.service_name
+    end
+
+    # @param [Method] method
+    # @return [String]
+    def get_partial_name(method)
+      "#{method.owner.name}/#{method.name}"
+    end
+
+    # @param [Method] method
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @return [Request]
+    def get_request(method, call)
+      service_name = get_service_name(method)
+
+      # path is represented as "/" Service-Name "/" {method name}
+      # e.g. /google.pubsub.v2.PublisherService/CreateTopic.
+      # cf. https://github.com/grpc/grpc/blob/v1.24.0/doc/PROTOCOL-HTTP2.md
+      path = "/#{service_name}/#{camelize(method.name.to_s)}"
+
+      # gRPC's HTTP method is always POST.
+      # cf. https://github.com/grpc/grpc/blob/v1.24.0/doc/PROTOCOL-HTTP2.md
+      method = "POST"
+
+      Request.new(path, call.metadata['user-agent'], method)
+    end
+
+    # @param [String] term
+    # @return [String]
+    def camelize(term)
+      term.split("_").map(&:capitalize).join
+    end
+
+    # @param [Hash] params
+    # @return [Hash]
+    def filter(params)
+      if !@params_filter.nil?
+        @params_filter.filter(params)
+      else
+        params
+      end
+    end
+
+    # @return [bool]
+    def newrelic_enabled?
+      NewRelic::Agent.instance.started?
+    end
+  end
+end

data/lib/grpc_newrelic_interceptor/version.rb

@@ -0,0 +1,3 @@
+module GrpcNewrelicInterceptor
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: grpc_newrelic_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry-doc
+  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: google-protobuf
+  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: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  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'
+description: An interceptor for using New Relic with gRPC.
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grpc_newrelic_interceptor.gemspec
+- lib/grpc_newrelic_interceptor.rb
+- lib/grpc_newrelic_interceptor/server_interceptor.rb
+- lib/grpc_newrelic_interceptor/version.rb
+homepage: https://github.com/south37/grpc_newrelic_interceptor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/south37/grpc_newrelic_interceptor
+  source_code_uri: https://github.com/south37/grpc_newrelic_interceptor
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An interceptor for using New Relic with gRPC.
+test_files: []