opbeat 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd866037f5cf5ec4da1eff94c29ea67160e00a85
-  data.tar.gz: 708b72d84b7b7697d0c8a8d77eeb50f19dae413a
+  metadata.gz: 62406440d5386dfb4cab59dcb5db22534d83c8c2
+  data.tar.gz: bfc8e55c4b8e34a4cd3093106ce8857f00f1b4b2
 SHA512:
-  metadata.gz: 1e7a83cf2c9326970bc635ee1ea941c8f6368448218716fa8a8a67bbbb1eaf252ac5cc0eb16fa8a650c40813dd9a2d6e4bad816010b74f50a8df201d78a3daea
-  data.tar.gz: e1c271dd9fa6942685b9fa28ab3ad4efcde20987e4942c8383d6907a8d05f9e9a55f370e81bd992c7ecd6cab6f84c63ff5c8e53d6c11dd33ac2b5f3ca330b4cf
+  metadata.gz: 702781cb7e485aa2b9539775be5beb0bb0710085d05aa1eedc76b4fe0247ecc21ef47e68ffd736e718f7c53a665a189a7041940d4912696c84196e1108df29c6
+  data.tar.gz: 4cfad284c0cfb8d8a9b1a1c1c5d02850efda47e7e5de5da47403af1c9513f87221e957e24e8eecbc526bfd2f6aa65080e8e21107e2ffd101904746c1fc4ec7a7

data/HISTORY.md

@@ -1,3 +1,13 @@
+# 3.0.4
+
+**Features**
+
+- Added `Opbeat.set_context`.
+
+**Fixes**
+
+- Make the SQL descriptions fall back to just `SQL` ([@jensnockert](https://github.com/jensnockert))
+
 # 3.0.3
 
 **Features**

data/README.md

@@ -87,10 +87,22 @@ config.opbeat.filter_parameters += [/regex(p)?/, "string", :symbol]
 
 Opbeat can automatically add user information to errors. By default it looks for at method called `current_user` on the current controller. To change the method use `current_user_method`.
 
-```
+```ruby
 config.opbeat.current_user_method = :current_employee
 ```
 
+### Error context
+
+You may specify extra context for errors ahead of time by using `Opbeat.set_context` eg:
+
+```ruby
+class DashboardController < ApplicationController
+  before_filter do
+    Opbeat.set_context(timezone: current_user.timezone)
+  end
+end
+```
+
 ## Background processing
 
 Opbeat automatically catches exceptions in [delayed_job](https://github.com/collectiveidea/delayed_job) or [sidekiq](http://sidekiq.org/).

data/lib/opbeat/client.rb

@@ -169,6 +169,10 @@ module Opbeat
 
     # errors
 
+    def set_context context
+      @context = context
+    end
+
     def report exception, opts = {}
       return if config.disable_errors
       return unless exception
@@ -180,6 +184,7 @@ module Opbeat
       end
 
       error_message = ErrorMessage.from_exception(config, exception, opts)
+      error_message.add_extra(@context) if @context
       data = @data_builders.error_message.build error_message
       enqueue Worker::PostRequest.new('/errors/', data)
     end
@@ -188,6 +193,7 @@ module Opbeat
       return if config.disable_errors
 
       error_message = ErrorMessage.new(config, message, opts)
+      error_message.add_extra(@context) if @context
       data = @data_builders.error_message.build error_message
       enqueue Worker::PostRequest.new('/errors/', data)
     end

data/lib/opbeat/error_message.rb

@@ -71,5 +71,10 @@ module Opbeat
 
       error_message
     end
+
+    def add_extra info
+      @extra ||= {}
+      @extra.merge! info
+    end
   end
 end

data/lib/opbeat/sql_summarizer.rb

@@ -17,11 +17,13 @@ module Opbeat
     def signature_for sql
       return CACHE[sql] if CACHE[sql]
 
-      REGEXES.find do |regex, sig|
+      result = REGEXES.find do |regex, sig|
         if match = sql.match(regex)
           break sig + match[1]
         end
       end
+
+      result || "SQL"
     end
   end
 end

data/lib/opbeat/version.rb

@@ -1,3 +1,3 @@
 module Opbeat
-  VERSION = "3.0.3"
+  VERSION = "3.0.4"
 end

data/spec/opbeat/client_spec.rb

@@ -102,6 +102,18 @@ module Opbeat
         end
       end
 
+      describe "#set_context" do
+        it "sets context for future errors" do
+          subject.set_context(additional_information: 'remember me')
+
+          exception = Exception.new('BOOM')
+          subject.report exception
+
+          expect(subject.queue.length).to be 1
+          expect(subject.queue.pop.data[:extra]).to eq(additional_information: 'remember me')
+        end
+      end
+
       describe "#report" do
         it "builds and posts an exception" do
           exception = Exception.new('BOOM')

data/spec/opbeat/error_message_spec.rb

@@ -80,5 +80,19 @@ module Opbeat
       end
     end
 
+    describe "#add_extra" do
+      it "adds extra info from hash" do
+        error_message = ErrorMessage.new config, "Message"
+        error_message.add_extra(thing: 1)
+        expect(error_message.extra).to eq(thing: 1)
+      end
+      it "merges with current" do
+        error_message = ErrorMessage.new config, "Message"
+        error_message.extra = { other_thing: 2 }
+        error_message.add_extra(thing: 1)
+        expect(error_message.extra).to eq(thing: 1, other_thing: 2)
+      end
+    end
+
   end
 end

data/spec/opbeat/sql_summarizer_spec.rb

@@ -2,5 +2,32 @@ require 'spec_helper'
 
 module Opbeat
   RSpec.describe SqlSummarizer do
+    let(:config) { Configuration.new }
+
+    subject { SqlSummarizer.new(config) }
+
+    it 'summarizes selects' do
+      expect(subject.signature_for("SELECT CAST(SERVERPROPERTY('ProductVersion') AS varchar)")).to eq('SQL')
+    end
+
+    it 'summarizes selects from table' do
+      expect(subject.signature_for("SELECT * FROM table")).to eq('SELECT FROM table')
+    end
+
+    it 'summarizes selects from table with columns' do
+      expect(subject.signature_for("SELECT a, b FROM table")).to eq('SELECT FROM table')
+    end
+
+    it 'summarizes inserts' do
+      expect(subject.signature_for("INSERT INTO table (a, b) VALUES ('A','B')")).to eq('INSERT INTO table')
+    end
+
+    it 'summarizes updates' do
+      expect(subject.signature_for("UPDATE table SET a = 'B' WHERE b = 'B'")).to eq('UPDATE table')
+    end
+
+    it 'summarizes deletes' do
+      expect(subject.signature_for("DELETE FROM table WHERE b = 'B'")).to eq('DELETE FROM table')
+    end
   end
 end

data/spec/opbeat_spec.rb

@@ -20,6 +20,7 @@ RSpec.describe Opbeat do
     it { should delegate :transaction, to: Opbeat::Client.inst, args: ['Test', nil, nil] }
     it { should delegate :trace, to: Opbeat::Client.inst, args: ['test', nil, {}] }
     it { should delegate :report, to: Opbeat::Client.inst, args: [Exception.new, nil] }
+    it { should delegate :set_context, to: Opbeat::Client.inst, args: [{}] }
     it { should delegate :report_message, to: Opbeat::Client.inst, args: ["My message", nil] }
     it { should delegate :release, to: Opbeat::Client.inst, args: [{}, {}] }
     it { should delegate :capture, to: Opbeat::Client.inst }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opbeat
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport