grpc_newrelic_interceptor 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f48d560a64c635ca1a2a5766cdfeca630f653750b42e75155c05f96440ad15e
-  data.tar.gz: 6a3760be8b5e0d6f3661f5ff39b40e8980e91cccf2d24eb976000b9c1629fccc
+  metadata.gz: 6f762f4530a5289380b3d015ee4071a2ff8e083a9e803fb791c79e54ac2c410c
+  data.tar.gz: 89cd8daa94234ab1e7c5c4730d184e196e3142a53bba1136ee6288cddd00e031
 SHA512:
-  metadata.gz: e211b44a114ae8f521c8168e48fec436b88fdc8295befc29f8b26b72f239332fcbad2f7ca4e3e65dfc98513ff3840b137a6a582a11caa3cd4f8011a48a11ca4c
-  data.tar.gz: 46ebb1247039200b02bb35a6d39d5282cca0a4f2f14e74b26c317382e1b155ed4b46e9337e69a92a1e7dec4faed9226f6284cf34b5f8749dbf1142f06d11068a
+  metadata.gz: cda2787034a018697c5bcce58811fa9fd2420ee50d9b36a0007c2db476a93044c6a5e343163d4457e994c7f265d4a258f85bc610d09ab6b87f47479741982a24
+  data.tar.gz: 4d2c6d53e87600fa3294716df62ff56139cc268d516e0c2146cb10487698bcfb87dbd24a7d20755d54a41a6cd3c8d5259717bc57916d9af8eaf8dd23f356caf2

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+        gemfile: ['Gemfile']
+        include:
+        - ruby: "3.0"
+          gemfile: "gemfiles/newrelic-6.gemfile"
+        - ruby: "3.0"
+          gemfile: "gemfiles/newrelic-7.gemfile"
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+    - uses: actions/checkout@v2.4.0
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle install
+    - run: bundle exec rspec

data/.gitignore

@@ -1,8 +1,57 @@
-/.bundle/
-/.yardoc
-/_yardoc/
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+*.gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+## 0.0.5
+
+- Fixed
+  - Support Ruby 3.0 keyword arguments https://github.com/wantedly/grpc_newrelic_interceptor/pull/15
+- Misc
+  - Bump actions/checkout from 2.3.5 to 2.4.0 https://github.com/wantedly/grpc_newrelic_interceptor/pull/14
+
+## 0.0.4
+
+- Added
+  - Allow newrelic_rpm 7.x and 8.x https://github.com/wantedly/grpc_newrelic_interceptor/pull/11
+- Misc
+  - Migrate to GitHub Actions https://github.com/wantedly/grpc_newrelic_interceptor/pull/10
+  - Set up dependabot https://github.com/wantedly/grpc_newrelic_interceptor/pull/12
+
+## 0.0.3
+
+- Fixed
+  - Fix server interceptor with overridden methods https://github.com/wantedly/grpc_newrelic_interceptor/pull/8
+- Misc
+  - Bump rake https://github.com/wantedly/grpc_newrelic_interceptor/pull/5
+
+## 0.0.2
+
+- Added
+  - Add client interceptor https://github.com/wantedly/grpc_newrelic_interceptor/pull/1
+- Misc
+  - Activate Travis CI https://github.com/wantedly/grpc_newrelic_interceptor/pull/2
+  - Update README https://github.com/wantedly/grpc_newrelic_interceptor/pull/3
+
+## 0.0.1
+
+Initial release.

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in grpc_newrelic_interceptor.gemspec
 gemspec
+
+gem "newrelic_rpm", "~> 8.0"

data/README.md

@@ -19,6 +19,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Server
+
 ```ruby
 require 'grpc'
 require 'grpc_newrelic_interceptor'
@@ -27,13 +29,26 @@ NewRelic::Agent.manual_start  # start newrelic agent
 
 server = GRPC::RpcServer.new(
   interceptors: [
-    GrpcNewrelicInterceptor.new,
+    GrpcNewrelicInterceptor::ServerInterceptor.new,
   ]
 )
 server.handle(MyHandler.new)
 server.run_till_terminated_or_interrupted(['SIGINT'])
 ```
 
+### Client
+
+```ruby
+require 'grpc'
+require 'grpc_newrelic_interceptor'
+
+url = "dns:test-service:80"
+stub = TestService::Stub.new(url, :this_channel_is_insecure, interceptors: [
+  GrpcNewrelicInterceptor::ClientInterceptor.new,
+])
+stub.hello_rpc
+```
+
 ## 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.
@@ -42,7 +57,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/south37/grpc_newrelic_interceptor.
+Bug reports and pull requests are welcome on GitHub at https://github.com/wantedly/grpc_newrelic_interceptor.
 
 ## License
 

data/gemfiles/newrelic-6.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_newrelic_interceptor.gemspec
+gemspec path: ".."
+
+gem "newrelic_rpm", "~> 6.0"
+

data/gemfiles/newrelic-7.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_newrelic_interceptor.gemspec
+gemspec path: ".."
+
+gem "newrelic_rpm", "~> 7.0"
+

data/grpc_newrelic_interceptor.gemspec

@@ -10,11 +10,11 @@ Gem::Specification.new do |spec|
 
   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.homepage      = "https://github.com/wantedly/grpc_newrelic_interceptor"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/south37/grpc_newrelic_interceptor"
+  spec.metadata["source_code_uri"] = "https://github.com/wantedly/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.
@@ -26,11 +26,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.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 "newrelic_rpm", ">= 6.0", "< 9.0"
   spec.add_dependency "grpc"
 end

data/lib/grpc_newrelic_interceptor/client_interceptor.rb

@@ -0,0 +1,79 @@
+require "newrelic_rpm"
+require "grpc"
+
+module GrpcNewrelicInterceptor
+  class ClientInterceptor < GRPC::ClientInterceptor
+    ##
+    # Intercept a unary request response call
+    #
+    # @param [Object] request
+    # @param [GRPC::ActiveCall] call
+    # @param [String] method
+    # @param [Hash] metadata
+    #
+    def request_response(request:, call:, method:, metadata:)
+      return yield if !newrelic_enabled?
+
+      segment = NewRelic::Agent::Tracer.start_external_request_segment(
+        library:   "gRPC".freeze,
+        uri:       dummy_uri(method),
+        procedure: get_method_name(method),
+      )
+
+      begin
+        response = nil
+
+        # TODO(south37) Set metadta as reqeust headers
+        # segment.add_request_headers something
+
+        # RUBY-1244 Disable further tracing in request to avoid double
+        # counting if connection wasn't started (which calls request again).
+        NewRelic::Agent.disable_all_tracing do
+          response = yield
+        end
+
+        # NOTE: Here, we can not get metadata of response.
+        # TODO(south37) Improve ClientInterceptor to get metadata and set it as
+        # response headers
+        # segment.read_response_headers something
+
+        response
+      ensure
+        segment.finish
+      end
+    end
+
+    # NOTE: For now, we don't support server_streamer, client_streamer and bidi_streamer
+
+  private
+
+    # @param [String] method
+    # @return [URI]
+    def dummy_uri(method)
+      # Here, we use service_name as domain name.
+      service_name = get_service_name(method)
+      ::NewRelic::Agent::HTTPClients::URIUtil.parse_and_normalize_url("http://#{service_name}")
+    end
+
+    # @param [String] method
+    # @return [String]
+    def get_service_name(method)
+      # Here, method is a string which represents a full path of gRPC method.
+      # e.g. "/wantedly.users.UserService/GetUser"
+      method.split('/')[1]
+    end
+
+    # @param [String] method
+    # @return [String]
+    def get_method_name(method)
+      # Here, method is a string which represents a full path of gRPC method.
+      # e.g. "/wantedly.users.UserService/GetUser"
+      method.split('/')[2]
+    end
+
+    # @return [bool]
+    def newrelic_enabled?
+      NewRelic::Agent.instance.started?
+    end
+  end
+end

data/lib/grpc_newrelic_interceptor/server_interceptor.rb

@@ -37,7 +37,7 @@ module GrpcNewrelicInterceptor
           filtered_params: filter(request.to_h),
         }
       }
-      NewRelic::Agent::Tracer.in_transaction(transaction_options) do
+      NewRelic::Agent::Tracer.in_transaction(**transaction_options) do
         yield
       end
     end
@@ -49,13 +49,13 @@ module GrpcNewrelicInterceptor
     # @param [Method] method
     # @return [String]
     def get_service_name(method)
-      method.owner.service_name
+      method.receiver.class.service_name
     end
 
     # @param [Method] method
     # @return [String]
     def get_partial_name(method)
-      "#{method.owner.name}/#{method.name}"
+      "#{method.receiver.class.name}/#{method.name}"
     end
 
     # @param [Method] method

data/lib/grpc_newrelic_interceptor/version.rb

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

data/lib/grpc_newrelic_interceptor.rb

@@ -1,3 +1,4 @@
+require "grpc_newrelic_interceptor/client_interceptor"
 require "grpc_newrelic_interceptor/server_interceptor"
 require "grpc_newrelic_interceptor/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_newrelic_interceptor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Nao Minami
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,22 @@ dependencies:
   name: newrelic_rpm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -129,27 +135,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/newrelic-6.gemfile
+- gemfiles/newrelic-7.gemfile
 - grpc_newrelic_interceptor.gemspec
 - lib/grpc_newrelic_interceptor.rb
+- lib/grpc_newrelic_interceptor/client_interceptor.rb
 - lib/grpc_newrelic_interceptor/server_interceptor.rb
 - lib/grpc_newrelic_interceptor/version.rb
-homepage: https://github.com/south37/grpc_newrelic_interceptor
+homepage: https://github.com/wantedly/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: 
+  homepage_uri: https://github.com/wantedly/grpc_newrelic_interceptor
+  source_code_uri: https://github.com/wantedly/grpc_newrelic_interceptor
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: An interceptor for using New Relic with gRPC.
 test_files: []

data/.travis.yml

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

data/Gemfile.lock

@@ -1,56 +0,0 @@
-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