gruf-newrelic 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ca810fefb72ce91aff0a9b46571dec40cddd5fe2197304ee2da749a9f9654fe
-  data.tar.gz: f9fdc33ad99aa1e77dd732dc776ce8bf38595e8bccc6261ecba1d00761a9775c
+  metadata.gz: 23c8798651475543448f574e4980de14272ade849f9fa0262accf872f9186710
+  data.tar.gz: dbc03cee8379ac1b191c2e4026ef513b410eb9b042210ecda68d22f13a7551df
 SHA512:
-  metadata.gz: 8844260ead266fc39fbeaae14abc19d17c2680d3c57f21a588877845e0a11ea2495ef44794e5d0a211c1d80b4dea0ca0264d72a36b26178738724bf0d7a5563c
-  data.tar.gz: 4bce13092c81a1826ba3af166f39ad5920da0067b43c2eff14bf96a1409646d8f3a644ffab4eb536a1e328097ea90af2ef4da54afec931d2b562031479c0122a
+  metadata.gz: '0379035e4162472b53ccfc47d64f7e1802ffdfaba0a3433c33f67920a946c1201e4a6bc10288941461b3023fe8dbd48360736b2471a0e9f34597498d4deba616'
+  data.tar.gz: cb0853ad2edeb4d70f10e277e7346d1d5b3d44d3b39bd9ec636facd1e4a0a3ffb225da970781b7513de77c4d4699591c4317a3f619c1b1011d8c58d48930ab71

data/CHANGELOG.md

@@ -1,7 +1,31 @@
 Changelog for the gruf-newrelic gem.
 
-h3. Pending Release
+### Pending Release
 
-h3. 1.0.0
+### 1.4.0
+
+- Ruby 3 support, remove support for Ruby < 2.6
+- Loosen gem dependencies, add bundler 2 support
+
+### 1.3.0
+
+- Allow customization of transaction name prefix [#7]
+
+### 1.2.1
+
+- Fix issue with NewRelic trace headers when they are arrays 
+
+### 1.2.0
+
+- Added ClientInterceptor with New Relic Distributed tracing support
+- Refactored ServerInterceptor with New Relic Distributed tracing support
+
+### 1.1.0
+
+- Bump newrelic gem dependency to ~> 6
+- Drop Ruby 2.2 support
+- Update bundler support
+
+### 1.0.0
 
 - Initial public release

data/README.md

@@ -1,6 +1,6 @@
 # gruf-newrelic - New Relic support for gruf
 
-[![Build Status](https://travis-ci.com/bigcommerce/gruf-newrelic.svg?branch=master)](https://travis-ci.com/bigcommerce/gruf-newrelic) [![Gem Version](https://badge.fury.io/rb/gruf-newrelic.svg)](https://badge.fury.io/rb/gruf-newrelic) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-newrelic.svg?branch=master)](http://inch-ci.org/github/bigcommerce/gruf-newrelic)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-newrelic/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-newrelic/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf-newrelic.svg)](https://badge.fury.io/rb/gruf-newrelic) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-newrelic.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-newrelic)
 
 Adds New Relic support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0+.
 
@@ -20,6 +20,22 @@ end
 
 This will add New Relic tracing support to all gruf controllers.
 
+### Distributed Tracing
+When controller receives gRPC request, it will automatically apply NewRelic distributed tracing information to current
+request if it is present in `newrelic` header. Make sure request has `newrelic` header with tracing payload (see below)
+and that your account and application settings have distributed tracing enabled
+
+If you are using `::Gruf::Client` to make gRPC request, you need to explicitly add NewRelic Client Interceptor
+in `client_options`:
+```ruby
+client = ::Gruf::Client.new(
+  service: ::Demo::ThingService, 
+  client_options: {
+    interceptors: [::Gruf::Newrelic::ClientInterceptor.new]
+  }
+)
+```
+
 ## License
 
 Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved 

data/lib/gruf/newrelic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018-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 +18,7 @@
 require_relative 'newrelic/version'
 require_relative 'newrelic/configuration'
 require_relative 'newrelic/server_interceptor'
+require_relative 'newrelic/client_interceptor'
 
 ##
 # Gruf main base module
@@ -24,6 +27,8 @@ module Gruf
   # Newrelic gruf module
   #
   module Newrelic
+    NEWRELIC_TRACE_HEADER = 'newrelic'
+
     extend Configuration
   end
 end

data/lib/gruf/newrelic/client_interceptor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018-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 'new_relic/agent'
+
+module Gruf
+  module Newrelic
+    ##
+    # New Relic transaction tracing for Gruf endpoints
+    #
+    class ClientInterceptor < ::Gruf::Interceptors::ClientInterceptor
+      def call(request_context:)
+        metadata = request_context.metadata
+        payload = ::NewRelic::Agent::DistributedTracing.create_distributed_trace_payload
+
+        metadata[NEWRELIC_TRACE_HEADER] = payload.http_safe if payload
+
+        yield
+      end
+    end
+  end
+end

data/lib/gruf/newrelic/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018-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
@@ -20,7 +22,8 @@ module Gruf
     #
     module Configuration
       VALID_CONFIG_KEYS = {
-        server_category: :controller
+        server_category: :controller,
+        transaction_name_prefixes: []
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys

data/lib/gruf/newrelic/server_interceptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018-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
@@ -13,6 +15,7 @@
 # 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 'new_relic/agent'
+require 'new_relic/agent/distributed_tracing'
 
 module Gruf
   module Newrelic
@@ -23,18 +26,28 @@ module Gruf
       include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
 
       def call
+        class_name_components = Gruf::Newrelic.transaction_name_prefixes + [request.service]
         opts = {
           category: Gruf::Newrelic.server_category,
-          class_name: request.service,
+          class_name: class_name_components.join('/'),
           name: request.method_key
         }
 
         # Yield to the given block with NewRelic tracing.
         # http://www.rubydoc.info/github/newrelic/rpm/NewRelic%2FAgent%2FInstrumentation%2FControllerInstrumentation:perform_action_with_newrelic_trace
         perform_action_with_newrelic_trace(opts) do
+          accept_distributed_tracing
           yield
         end
       end
+
+      private
+
+      def accept_distributed_tracing
+        payload = request.active_call.metadata[NEWRELIC_TRACE_HEADER]
+        payload = payload.first if payload.is_a?(Enumerable)
+        ::NewRelic::Agent::DistributedTracing.accept_distributed_trace_payload(payload)
+      end
     end
   end
 end

data/lib/gruf/newrelic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018-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,6 +17,6 @@
 #
 module Gruf
   module Newrelic
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,85 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: gruf-newrelic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-05 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.6'
 - !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.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.82'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: newrelic_rpm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 description: Plugin for New Relic for gruf
 email:
 - splittingred@gmail.com
@@ -91,6 +147,7 @@ files:
 - CODE_OF_CONDUCT.md
 - README.md
 - lib/gruf/newrelic.rb
+- lib/gruf/newrelic/client_interceptor.rb
 - lib/gruf/newrelic/configuration.rb
 - lib/gruf/newrelic/server_interceptor.rb
 - lib/gruf/newrelic/version.rb
@@ -98,7 +155,7 @@ homepage: https://github.com/bigcommerce/gruf-new-relic
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,16 +163,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: Plugin for New Relic for gruf
 test_files: []