fastly_nsq 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3aa79b5a426f1f7fa76eb8e255d54aaa30d638d20e6d097fa964533411412d
-  data.tar.gz: c10d1e27b816a461a44240a334cd0e301e8286d7048e146fa2349d28d8b2c82a
+  metadata.gz: 8a96d39aaf8bfa8168a11523a097d7b06231d38f46f152d2b2432e07f51e7f69
+  data.tar.gz: 5107261e47c9c8786a86aff6369868acd98895e0e04b0745e6f31da1ac85f42b
 SHA512:
-  metadata.gz: e29c14106a807b2f956bddee68bd9befa466b3ef2cb0dd18d67d4dfad073a4ecc7f21e46347fd57b01ea46b15591c63a69c043d543fd8bdea3d074ad21862187
-  data.tar.gz: f1cbba992974f48cc0694decb443fd3e16b9465d8bcedc72afb5b6668a42f9e5cde8212e8eafac6dbe1876f074a94604e0681c54fe55c5773804a5631935111e
+  metadata.gz: e4d4bd99d0789eafcc85826942b564d541ad760c9d7c64892cb7627a38984493b5812e02d73fe93b8ce9580a28c9f5f4abf6ac9e86f5e87823d349af87e4d493
+  data.tar.gz: 25c21fcee5324ca0cb16be4fde1dd4cc434d90c7d0dc9da6fdb5158ced9b2d6e978b33799aff3aecb52fad67b84686637309b543f787adf7625ad7f984931931

data/ChangeLog.md

@@ -1,7 +1,14 @@
 # Change Log
 
-## [v1.12.0](https://github.com/fastly/fastly_nsq/tree/v1.12.0)
+## [v1.13.0](https://github.com/fastly/fastly_nsq/tree/v1.13.0)
 
+[Full Changelog](https://github.com/fastly/fastly_nsq/compare/v1.12.0...v1.13.0)
+
+**Merged pull requests:**
+
+- Add NewRelic support [\#90](https://github.com/fastly/fastly_nsq/pull/90) ([leklund](https://github.com/leklund))
+
+## [v1.12.0](https://github.com/fastly/fastly_nsq/tree/v1.12.0) (2018-07-25)
 [Full Changelog](https://github.com/fastly/fastly_nsq/compare/v1.11.0...v1.12.0)
 
 **Merged pull requests:**

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bundler-audit', '~> 0.5.0'
+gem 'newrelic_rpm', require: false
 gem 'overcommit', '~> 0.32.0'
 gem 'rake', '~> 11.1.2'
 gem 'rdoc', '~> 4.2.2'

data/lib/fastly_nsq.rb

@@ -138,6 +138,13 @@ module FastlyNsq
         end
       end
     end
+
+    # Instance of FastlyNsq::NewRelic
+    #
+    # @return [FastlyNsq::NewRelic]
+    def tracer
+      @tracer ||= FastlyNsq::NewRelic.new
+    end
   end
 end
 
@@ -148,6 +155,7 @@ require 'fastly_nsq/listener'
 require 'fastly_nsq/manager'
 require 'fastly_nsq/message'
 require 'fastly_nsq/messenger'
+require 'fastly_nsq/new_relic'
 require 'fastly_nsq/priority_queue'
 require 'fastly_nsq/priority_thread_pool'
 require 'fastly_nsq/producer'

data/lib/fastly_nsq/feeder.rb

@@ -40,6 +40,7 @@ class FastlyNsq::Feeder
         processor.call(message)
       rescue => ex
         FastlyNsq.logger.error ex
+        FastlyNsq.tracer.notice_error ex
         raise ex
       end
     end

data/lib/fastly_nsq/listener.rb

@@ -113,21 +113,28 @@ class FastlyNsq::Listener
   def call(nsq_message)
     message = FastlyNsq::Message.new(nsq_message)
 
+    msg_info = {
+      channel:  channel,
+      topic:    topic,
+      attempts: nsq_message.attempts,
+      id:       Digest::MD5.hexdigest(nsq_message.body.to_s),
+      metadata: message.meta,
+    }
+
     logger.info do
-      {
-        channel:  channel,
-        topic:    topic,
-        attempts: nsq_message.attempts,
-        id:       Digest::MD5.hexdigest(nsq_message.body.to_s),
-        metadata: message.meta,
-      }.tap do |l|
-        l[:data] = message.body if logger.level == Logger::DEBUG
+      if logger.level == Logger::DEBUG
+        msg_info.merge(data: message.body)
+      else
+        msg_info
       end
     end
 
-    preprocessor&.call(message)
-    result = processor.call(message)
-    message.finish if result
+    FastlyNsq.tracer.trace_with_newrelic(params: msg_info, class_name: processor.class.to_s) do
+      preprocessor&.call(message)
+      result = processor.call(message)
+      message.finish if result
+    end
+
     message
   end
 

data/lib/fastly_nsq/new_relic.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+begin
+  require 'newrelic_rpm'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
+##
+# FastlyNsq::NewRelic supports tracing methods with NewRelic
+# if the +newrelic_rpm+ is enabled
+class FastlyNsq::NewRelic
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation if defined?(::NewRelic)
+
+  CATEGORY = 'OtherTransaction/FastlyNsqProcessor'
+
+  attr_reader :agent
+
+  ##
+  # Create a FastlyNsq::NewRelic instance
+  # @param agent [#notice_error] optional and should only be used if you need to override the default +NewRelic::Agent+
+  # @example
+  #   tracer = FastlyNsq::NewRelic.new
+  #   tracer.notice_error(exception)
+  def initialize(agent = nil)
+    @agent = agent || (Object.const_defined?('NewRelic') ? NewRelic::Agent : nil)
+  end
+
+  ##
+  # Returns true if NewRelic is loaded and available.
+  # @return [Boolean]
+  def enabled?
+    @enabled ||= Object.const_defined?('NewRelic')
+  end
+
+  ##
+  # Notify NewRelic of an exception only if `enabled? == true`
+  # and an +agent+ is defined
+  # @param exception [Exception]
+  def notice_error(exception)
+    return unless enabled? && agent
+
+    agent.notice_error(exception)
+  end
+
+  ##
+  # Trace passed block with new relic if `enabled? == true`
+  # @param trace_args [Hash] tracing parameters passed to NewRelic
+  #
+  # @see {https://www.rubydoc.info/github/newrelic/rpm/NewRelic%2FAgent%2FInstrumentation%2FControllerInstrumentation:perform_action_with_newrelic_trace}
+  def trace_with_newrelic(**args)
+    if enabled?
+      perform_action_with_newrelic_trace(trace_args(args)) do
+        yield
+      end
+    else
+      yield
+    end
+  end
+
+  private
+
+  def trace_args(**args)
+    {
+      name: 'call',
+      category: CATEGORY,
+    }.merge(args)
+  end
+end

data/lib/fastly_nsq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FastlyNsq
-  VERSION = '1.12.0'
+  VERSION = '1.13.0'
 end

data/spec/new_relic.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe FastlyNsq::NewRelic do
+  let(:agent) { double 'NewRelic::Agent', notice_error: true }
+  let(:tracer) { FastlyNsq::NewRelic.new(agent) }
+
+  describe '#enabled?' do
+    it 'returns false unless NewRelic is loaded' do
+      allow(Object).to receive(:const_defined?).with('NewRelic').and_return(false)
+      expect(tracer.enabled?).to be false
+    end
+
+    it 'returns true id NewRelic is loaded' do
+      expect(tracer.enabled?).to be true
+    end
+  end
+
+  context 'enabled' do
+    before do
+      allow(Object).to receive(:const_defined?).with('NewRelic').and_return(true)
+    end
+
+    describe '#notice_error' do
+      it 'call agent.notice_error' do
+        ex = Exception.new
+
+        tracer.notice_error(ex)
+        expect(agent).to have_received(:notice_error).with(ex)
+      end
+    end
+
+    describe '#trace_with_newrelic' do
+      it 'calls perform_action_with_newrelic_trace and yields' do
+        allow(tracer).to receive(:perform_action_with_newrelic_trace).and_yield
+
+        expect { |b| tracer.trace_with_newrelic({}, &b) }.to yield_control
+        expect(tracer).to have_received(:perform_action_with_newrelic_trace)
+      end
+
+      it 'calls perform_action_with_newrelic_trace with trace_args' do
+        params = { id: 1, vp: 'joe biden' }
+
+        expected = {
+          name: 'call',
+          category: FastlyNsq::NewRelic::CATEGORY,
+          params: params,
+          class_name: 'SomeClass',
+        }
+
+        allow(tracer).to receive(:perform_action_with_newrelic_trace).and_yield
+        expect { |b| tracer.trace_with_newrelic(params: params, class_name: 'SomeClass', &b) }.to yield_control
+
+        expect(tracer).to have_received(:perform_action_with_newrelic_trace).with(expected)
+      end
+
+      it 'always sends the default trace args' do
+        expected = {
+          name: 'call',
+          category: FastlyNsq::NewRelic::CATEGORY,
+        }
+        allow(tracer).to receive(:perform_action_with_newrelic_trace).and_yield
+
+        expect { |b| tracer.trace_with_newrelic(&b) }.to yield_control
+
+        expect(tracer).to have_received(:perform_action_with_newrelic_trace).with(expected)
+      end
+    end
+  end
+
+  context 'disabled' do
+    before do
+      allow(Object).to receive(:const_defined?).with('NewRelic').and_return(false)
+    end
+
+    describe '#notice_error' do
+      it 'returns nil' do
+        expect(tracer.notice_error('ex')).to be nil
+      end
+    end
+
+    describe '#trace_with_newrelic' do
+      it 'yields' do
+        allow(tracer).to receive(:perform_action_with_newrelic_trace)
+
+        expect { |b| tracer.trace_with_newrelic({}, &b) }.to yield_control
+        expect(tracer).not_to have_received(:perform_action_with_newrelic_trace)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastly_nsq
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Tommy O'Neil
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -220,6 +220,7 @@ files:
 - lib/fastly_nsq/manager.rb
 - lib/fastly_nsq/message.rb
 - lib/fastly_nsq/messenger.rb
+- lib/fastly_nsq/new_relic.rb
 - lib/fastly_nsq/priority_queue.rb
 - lib/fastly_nsq/priority_thread_pool.rb
 - lib/fastly_nsq/producer.rb
@@ -241,6 +242,7 @@ files:
 - spec/matchers/delegate.rb
 - spec/message_spec.rb
 - spec/messenger_spec.rb
+- spec/new_relic.rb
 - spec/priority_thread_pool_spec.rb
 - spec/producer_spec.rb
 - spec/spec_helper.rb