newrelic-slack-ruby-bot 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbe6d3164cf6e4048053f40f1b16a86a633ba791
-  data.tar.gz: 541d728290a0449c4e55c5672630549bc13dc2c0
+  metadata.gz: 93eb40878e93b48b07f21362a982459d05b7e676
+  data.tar.gz: 9e3c8a237a1200ffbc76f1aa257800bb671e81e3
 SHA512:
-  metadata.gz: abd4bc708ba4fe1ccc1286a0a1b0057aaa906f7c74ac7000005274f4b5aefe218bcf8f571bd800d88b7ef4155af063a59f84324bebae2ba10adbcd90266c8764
-  data.tar.gz: '0045281a46ba59a104ec4c8a1671d4a1f27f1726f2fa1bc4788fc5dbab03281931b991ed47f80742fcc8f4a15fc3e5a4acf5f2feaec9cee194a34e3b17c7d4dc'
+  metadata.gz: 65c659cd156786c01e79638898ac9695a1a5be8e8348122d52c1b56ff66fd92a9de519bdcbf69d5285a21fde5785aca487504503a403f43fe36f6ca019ea810c
+  data.tar.gz: f090f404c0a52570d5dc4927c470989e62ea11a1966065ef8b16a6cc5fa7718ce41f7a4fd1fe86df76792ae73f34efb6e909ef0411857713fe46da549f3de9a9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.2.1 (11/10/2017)
+
+* [#6](https://github.com/slack-ruby/newrelic-slack-ruby-bot/pull/6): Add team, channel, and user attributes to New Relic traces - [@kstole](https://github.com/kstole).
+* [#8](https://github.com/slack-ruby/newrelic-slack-ruby-bot/pull/8): Name New Relic transactions according to command called - [@kstole](https://github.com/kstole).
+* [#10](https://github.com/slack-ruby/newrelic-slack-ruby-bot/pull/10): Fix occasional infinite loop caused by Instrumentation - [@kstole](https://github.com/kstole).
+
 ### 0.2.0 (9/26/2017)
 
 * [#4](https://github.com/slack-ruby/newrelic-slack-ruby-bot/pull/4): Revise New Relic log messages - [@kstole](https://github.com/kstole).

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Ruby-Enum
+# Contributing to SlackRubyBot NewRelic Instrumentation
 
 This project is work of [many contributors](https://github.com/slack-ruby/newrelic-slack-ruby-bot/graphs/contributors).
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    newrelic-slack-ruby-bot (0.2.0)
+    newrelic-slack-ruby-bot (0.2.1)
       newrelic_rpm
-      slack-ruby-bot (>= 0.8.0)
+      slack-ruby-bot (>= 0.10.5)
 
 GEM
   remote: http://rubygems.org/
@@ -43,14 +43,15 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    gli (2.16.1)
+    gli (2.17.0)
     hashie (3.5.6)
     hitimes (1.2.6)
-    i18n (0.8.6)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
     json (2.1.0)
     minitest (5.10.3)
     multipart-post (2.0.0)
-    newrelic_rpm (4.4.0.336)
+    newrelic_rpm (4.5.0.337)
     nio4r (2.1.0)
     parser (2.4.0.0)
       ast (~> 2.2)
@@ -79,7 +80,7 @@ GEM
       ruby-progressbar (~> 1.7)
       tins (<= 1.6.0)
     ruby-progressbar (1.8.3)
-    slack-ruby-bot (0.10.4)
+    slack-ruby-bot (0.10.5)
       hashie
       slack-ruby-client (>= 0.6.0)
     slack-ruby-client (0.10.0)
@@ -94,7 +95,7 @@ GEM
     timers (4.1.2)
       hitimes
     tins (1.6.0)
-    tzinfo (1.2.3)
+    tzinfo (1.2.4)
       thread_safe (~> 0.1)
     websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)

data/README.md

@@ -7,7 +7,7 @@ NewRelic Instrumentation for SlackRubyBot
 
 NewRelic instrumentation for [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot).
 
-![](screenshots/breakdown.png)
+![NewRelic Transactions](screenshots/newrelic_transactions.png)
 
 ## Install
 
@@ -17,6 +17,33 @@ Add to Gemfile.
 gem 'newrelic-slack-ruby-bot'
 ```
 
+## Usage
+
+This gem adds New Relic tracing to the Slack message hook, which is the start of all messages coming in from Slack.
+New Relic will automatically record any external requests made through supported libraries (such as `Net::HTTP`) and database queries for supported databases (such as `MongoDB` and `Redis`).
+This gem also adds the team, channel, user, and match data from each message, which can be seen in New Relic transaction traces and Insights.
+
+![NewRelic Breakdown of calculate command](screenshots/newrelic_calculate_breakdown.png)
+
+### Renaming transactions
+
+By default, `newrelic-slack-ruby-bot` names New Relic transactions according to the operator, command, match, or scan route that was called.
+To rename a New Relic transaction, make a call directly to the New Relic agent.
+
+```ruby
+::NewRelic::Agent.set_transaction_name('new name')
+```
+
+The typical format for transaction names is `ClassName/method`.
+
+### Adding custom attributes
+
+You can add additional custom attributes via the New Relic agent.
+
+```ruby
+::NewRelic::Agent.add_custom_attributes(key: value)
+```
+
 ## Contributing
 
 You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md) for details.

data/lib/newrelic-slack-ruby-bot/instrumentation.rb

@@ -11,15 +11,17 @@ DependencyDetection.defer do
 
   executes do
     NewRelic::Agent.logger.info 'Installing SlackRubyBot instrumentation'
-    instrument_call
   end
 
-  def instrument_call
+  executes do
     ::SlackRubyBot::Hooks::Message.class_eval do
       include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
 
       def message_with_new_relic(client, data)
         perform_action_with_newrelic_trace(name: 'call', category: 'OtherTransaction/Slack') do
+          ::NewRelic::Agent.add_custom_attributes(team: data.team,
+                                                  channel: data.channel,
+                                                  user: data.user)
           message_without_new_relic(client, data)
         end
       end
@@ -28,4 +30,36 @@ DependencyDetection.defer do
       alias_method :call, :message_with_new_relic
     end
   end
+
+  executes do
+    ::SlackRubyBot::Commands::Base.class_eval do
+      class << self
+        def command_name(match)
+          if match.is_a? MatchData
+            if match.names.include? 'command'
+              match[:command].downcase
+            elsif match.names.include? 'operator'
+              match[:operator].downcase
+            else
+              'match'
+            end
+          else
+            'scan'
+          end
+        end
+
+        def call_command_with_new_relic(client, data, match, block)
+          ::NewRelic::Agent.set_transaction_name("#{self}/#{command_name(match)}")
+          if match.is_a? MatchData
+            ::NewRelic::Agent
+              .add_custom_attributes(Hash[match.names.map(&:to_sym).zip(match.captures)])
+          end
+          call_command_without_new_relic(client, data, match, block)
+        end
+
+        alias_method :call_command_without_new_relic, :call_command
+        alias_method :call_command, :call_command_with_new_relic
+      end
+    end
+  end
 end

data/lib/newrelic-slack-ruby-bot/version.rb

@@ -1,8 +1,9 @@
 module NewRelic
   module Agent
     module Instrumentation
+      # New Relic instrumentation for SlackRubyBot
       module SlackRubyBot
-        VERSION = '0.2.0'.freeze
+        VERSION = '0.2.1'.freeze
       end
     end
   end

data/newrelic-slack-ruby-bot.gemspec

@@ -14,5 +14,5 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
   s.summary = 'NewRelic instrumentation for slack-ruby-bot.'
   s.add_dependency 'newrelic_rpm'
-  s.add_dependency 'slack-ruby-bot', '>= 0.8.0'
+  s.add_dependency 'slack-ruby-bot', '>= 0.10.5'
 end

data/spec/newrelic-slack-ruby-bot/instrumentation_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe NewRelic::Agent::Instrumentation do
   subject { SlackRubyBot::Hooks::Message.new }
   let(:client) { SlackRubyBot::Client.new }
+  before(:all) { SlackRubyBot::Config.user = 'mybot' }
 
   it 'perform_action_with_newrelic_trace' do
     expect(subject)
@@ -10,6 +11,130 @@ describe NewRelic::Agent::Instrumentation do
       .with(hash_including(name: 'call', category: 'OtherTransaction/Slack'))
       .and_yield
 
-    subject.call(client, Hashie::Mash.new(message: 'message', text: 'hi'))
+    subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                      text: 'hi',
+                                                      team: 'TEAM',
+                                                      channel: 'CHANNEL',
+                                                      user: 'USER'))
+  end
+
+  context 'operator' do
+    before(:all) do
+      MyOperatorClass = Class.new(SlackRubyBot::Commands::Base) do
+        operator('+') { |_client, _data, _match| }
+      end
+    end
+    it 'adds team, channel, user, and match attributes' do
+      expect(::NewRelic::Agent)
+        .to receive(:add_custom_attributes)
+        .with(hash_including(team: 'TEAM', channel: 'CHANNEL', user: 'USER'))
+      expect(::NewRelic::Agent)
+        .to receive(:add_custom_attributes)
+        .with(hash_including(operator: '+', expression: '42'))
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: '+42',
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+    it 'sets transaction name' do
+      expect(::NewRelic::Agent).to receive(:set_transaction_name).with('MyOperatorClass/+')
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: '+42',
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+  end
+
+  context 'command' do
+    before(:all) do
+      MyCommandClass = Class.new(SlackRubyBot::Commands::Base) do
+        command('this') { |_client, _data, _match| }
+      end
+    end
+    it 'adds team, channel, user, and match attributes' do
+      expect(::NewRelic::Agent)
+        .to receive(:add_custom_attributes)
+        .with(hash_including(team: 'TEAM', channel: 'CHANNEL', user: 'USER'))
+      expect(::NewRelic::Agent)
+        .to receive(:add_custom_attributes)
+        .with(hash_including(bot: 'mybot', command: 'this', expression: 'is the command'))
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: "#{client.name} this is the command",
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+    it 'sets transaction name' do
+      expect(::NewRelic::Agent).to receive(:set_transaction_name).with('MyCommandClass/this')
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: "#{client.name} this is the command",
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+  end
+
+  context 'match' do
+    before(:all) do
+      MyMatchClass = Class.new(SlackRubyBot::Commands::Base) do
+        match('read this') { |_client, _data, _match| }
+      end
+    end
+    it 'adds team, channel, user, and match attributes' do
+      expect(::NewRelic::Agent)
+        .to receive(:add_custom_attributes)
+        .with(hash_including(team: 'TEAM', channel: 'CHANNEL', user: 'USER'))
+      expect(::NewRelic::Agent).to receive(:add_custom_attributes).with({})
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: 'read this',
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+    it 'sets transaction name' do
+      expect(::NewRelic::Agent).to receive(:set_transaction_name).with('MyMatchClass/match')
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: 'read this',
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+  end
+
+  context 'scan' do
+    before(:all) do
+      MyScanClass = Class.new(SlackRubyBot::Commands::Base) do
+        scan('scanned') { |_client, _data, _match| }
+      end
+    end
+    it 'adds team, channel, user, and match attributes' do
+      expect(::NewRelic::Agent)
+        .to receive(:add_custom_attributes)
+        .with(hash_including(team: 'TEAM', channel: 'CHANNEL', user: 'USER'))
+      expect(::NewRelic::Agent).not_to receive(:add_custom_attributes)
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: 'I scanned this',
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
+    it 'sets transaction name' do
+      expect(::NewRelic::Agent).to receive(:set_transaction_name).with('MyScanClass/scan')
+
+      subject.call(client, Slack::Messages::Message.new(message: 'message',
+                                                        text: 'I scanned this',
+                                                        team: 'TEAM',
+                                                        channel: 'CHANNEL',
+                                                        user: 'USER'))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newrelic-slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newrelic_rpm
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.5
 description: 
 email: dblock@dblock.org
 executables: []
@@ -57,7 +57,9 @@ files:
 - lib/newrelic-slack-ruby-bot/version.rb
 - newrelic-slack-ruby-bot.gemspec
 - pkg/newrelic-slack-ruby-bot-0.1.1.gem
-- screenshots/breakdown.png
+- pkg/newrelic-slack-ruby-bot-0.2.0.gem
+- screenshots/newrelic_calculate_breakdown.png
+- screenshots/newrelic_transactions.png
 - spec/newrelic-slack-ruby-bot/instrumentation_spec.rb
 - spec/newrelic-slack-ruby-bot/version_spec.rb
 - spec/spec_helper.rb