appsignal 2.0.4 → 2.0.5.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aa4703023302308a9af7c3133cbbb347bc03eaa
-  data.tar.gz: 7c262a115fb2abeb53af582af27536b836e60475
+  metadata.gz: 329070b96ca1a7f2e2c9a77c5abc9e267783d83e
+  data.tar.gz: 36fae6abc5f7f03f9b12684adae1df0646adbec5
 SHA512:
-  metadata.gz: 57f347f6c7d8a8fa9729fe7f20679437b737455155c45430c1d0532b1ea8b38aab5d7af35b0b02108110919606af60b33579fdf7c0ce4d3c00cae043dba3ae3c
-  data.tar.gz: 1b74452af063d9299bd1040e98373ddfecae5a0de90a2a365bd7ba24d95fc2f78019b1e1675ff85d3bde8ad215ba10c63bcbbdb5296f91d87ed7f74027b9daf4
+  metadata.gz: cbbafdddb5fe71ee3f9616a19c92dc7c23da7e791a531fec1a636bb2cd2d9bf1e76d1876c44bad7247e3ab26ae5aeee3a2399b82a26db86245ea437ef5d89819
+  data.tar.gz: 71a422533810749f8379340e5760d71b01072ff3370d92ba3ab1de026008a54aebda4e8c28d953ad27bb074d9877b965f5813edc0f13c7a3d9a13496ecf593fb

data/.gitignore

@@ -3,6 +3,7 @@
 .sass-cache
 capybara-*.html
 *.log
+/doc
 /.bundle
 /vendor/bundle
 /tmp/*

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.0.5
+* Improved logging for agent connection issues
+* Handle nil request/environments in transactions
+
 # 2.0.4
 * Use consistent log format for both file and STDOUT logs. PR #203
 * Fix log path in `appsignal diagnose` for Rails applications. PR #218, #222

data/ext/agent.yml

@@ -1,18 +1,18 @@
 ---
-version: c18d324
+version: a1cb32f
 triples:
   x86_64-linux:
-    checksum: 67a21c8481684466b39a55a6b7418fa838d98e3e4570c9a082ba23e5147d5a64
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-x86_64-linux-all-static.tar.gz
+    checksum: 8905166cbd29ad3038d013438781118bb2fa4ea3fef2e7abfe3a4a4d90d7b40c
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/a1cb32f/appsignal-x86_64-linux-all-static.tar.gz
   i686-linux:
-    checksum: 958cc0a742bea1e411bb6dbe0f7f124fe6ec273b8ae0d9b9317f306d60ee0b5d
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-i686-linux-all-static.tar.gz
+    checksum: 0ae5f06cf9fd516c7a33cbe29a78016b3b419717870d5fba793345fecb696950
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/a1cb32f/appsignal-i686-linux-all-static.tar.gz
   x86-linux:
-    checksum: 958cc0a742bea1e411bb6dbe0f7f124fe6ec273b8ae0d9b9317f306d60ee0b5d
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-i686-linux-all-static.tar.gz
+    checksum: 0ae5f06cf9fd516c7a33cbe29a78016b3b419717870d5fba793345fecb696950
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/a1cb32f/appsignal-i686-linux-all-static.tar.gz
   x86_64-darwin:
-    checksum: 89053389ddf816aaefc1580899eca8bcac9837dfdfabf6f333a853d17f2edec8
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 750e49e56c2024c82adc64471feb855ab7a5caff79cb37978a83e11e31a023ce
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/a1cb32f/appsignal-x86_64-darwin-all-static.tar.gz
   universal-darwin:
-    checksum: 89053389ddf816aaefc1580899eca8bcac9837dfdfabf6f333a853d17f2edec8
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 750e49e56c2024c82adc64471feb855ab7a5caff79cb37978a83e11e31a023ce
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/a1cb32f/appsignal-x86_64-darwin-all-static.tar.gz

data/gemfiles/rails-4.2.gemfile

@@ -4,3 +4,7 @@ gem 'rails', '~> 4.2.0'
 gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
+  gem 'nokogiri', '~> 1.6.0'
+end

data/gemfiles/resque.gemfile

@@ -6,3 +6,7 @@ gem 'sinatra'
 gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
+  gem 'nokogiri', '~> 1.6.0'
+end

data/lib/appsignal/transaction.rb

@@ -238,23 +238,40 @@ module Appsignal
 
     protected
 
+    # Returns calculated background queue start time in milliseconds, based on
+    # environment values.
+    #
+    # @return [nil] if no {#environment} is present.
+    # @return [nil] if there is no `:queue_start` in the {#environment}.
+    # @return [Integer]
     def background_queue_start
-      return unless request.env
-      return unless queue_start = request.env[:queue_start]
+      env = environment
+      return unless env
+      queue_start = env[:queue_start]
+      return unless queue_start
+
       (queue_start.to_f * 1000.0).to_i
     end
 
+    # Returns HTTP queue start time in milliseconds.
+    #
+    # @return [nil] if no queue start time is found.
+    # @return [nil] if begin time is too low to be plausible.
+    # @return [Integer] queue start in milliseconds.
     def http_queue_start
-      return unless request.env
-      return unless env_var = request.env['HTTP_X_QUEUE_START'.freeze] || request.env['HTTP_X_REQUEST_START'.freeze]
-      cleaned_value = env_var.tr('^0-9'.freeze, ''.freeze)
+      env = environment
+      return unless env
+      env_var = env["HTTP_X_QUEUE_START".freeze] || env["HTTP_X_REQUEST_START".freeze]
+      return unless env_var
+      cleaned_value = env_var.tr("^0-9".freeze, "".freeze)
       return if cleaned_value.empty?
+
       value = cleaned_value.to_i
       if value > 4_102_441_200_000
-        # Value is in microseconds
+        # Value is in microseconds. Transform to milliseconds.
         value / 1_000
       elsif value < 946_681_200_000
-        # Value is to low to be plausible
+        # Value is too low to be plausible
         nil
       else
         # Value is in milliseconds
@@ -283,24 +300,62 @@ module Appsignal
       Appsignal::Utils::ParamsSanitizer.sanitize params, options
     end
 
+    # Returns sanitized environment for a transaction.
+    #
+    # The environment of a transaction can contain a lot of information, not
+    # all of it useful for debugging.
+    #
+    # Only the values from the keys specified in `ENV_METHODS` are returned.
+    #
+    # @return [nil] if no environment is present.
+    # @return [Hash<String, Object>]
     def sanitized_environment
-      return unless request.env
+      env = environment
+      return if env.empty?
+
       {}.tap do |out|
         ENV_METHODS.each do |key|
-          out[key] = request.env[key] if request.env[key]
+          out[key] = env[key] if env[key]
         end
       end
     end
 
+    # Returns sanitized session data.
+    #
+    # The session data is sanitized by the {Appsignal::Utils::ParamsSanitizer}.
+    #
+    # @return [nil] if `:skip_session_data` config is set to `true`.
+    # @return [nil] if the {#request} object doesn't respond to `#session`.
+    # @return [nil] if the {#request} session data is `nil`.
+    # @return [Hash<String, Object>]
     def sanitized_session_data
-      return if Appsignal.config[:skip_session_data] || !request.respond_to?(:session)
-      return unless session = request.session
+      return if Appsignal.config[:skip_session_data] ||
+          !request.respond_to?(:session)
+      session = request.session
+      return unless session
+
       Appsignal::Utils::ParamsSanitizer.sanitize(session.to_hash)
     end
 
+    # Returns metadata from the environment.
+    #
+    # @return [nil] if no `:metadata` key is present in the {#environment}.
+    # @return [Hash<String, Object>]
     def metadata
-      return unless request.env
-      request.env[:metadata]
+      environment[:metadata]
+    end
+
+    # Returns the environment for a transaction.
+    #
+    # Returns an empty Hash when the {#request} object doesn't listen to the
+    # `#env` method or the `#env` is nil.
+    #
+    # @return [Hash<String, Object>]
+    def environment
+      return {} unless request.respond_to?(:env)
+      return {} unless request.env
+
+      request.env
     end
 
     # Only keep tags if they meet the following criteria:

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 require 'yaml'
 
 module Appsignal
-  VERSION = '2.0.4'
+  VERSION = '2.0.5.beta.1'
 end

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -338,8 +338,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true do
 
           it "log files fall back on system tmp directory" do
             expect(output).to include \
-              %(log_dir_path: "#{system_tmp_dir}"\n    - Writable?: yes)
-              %(log_file_path: "#{system_tmp_log_file}"\n    - Exist?: false)
+              %(log_dir_path: "#{system_tmp_dir}"\n    - Writable?: yes),
+              %(log_file_path: "#{system_tmp_log_file}"\n    - Exists?: no)
           end
         end
 

data/spec/lib/appsignal/transaction_spec.rb

@@ -22,7 +22,7 @@ describe Appsignal::Transaction do
   before { Timecop.freeze(time) }
   after  { Timecop.return }
 
-  context "class methods" do
+  describe "class methods" do
     describe ".create" do
       it "should add the transaction to thread local" do
         Appsignal::Extension.should_receive(:start_transaction).with('1', 'http_request', 0)
@@ -599,6 +599,18 @@ describe Appsignal::Transaction do
     describe "#background_queue_start" do
       subject { transaction.send(:background_queue_start) }
 
+      context "when request is nil" do
+        let(:request) { nil }
+
+        it { should eq nil }
+      end
+
+      context "when env is nil" do
+        before { expect(transaction.request).to receive(:env).and_return(nil) }
+
+        it { should eq nil }
+      end
+
       context "when queue start is nil" do
         it { should eq nil }
       end
@@ -616,8 +628,14 @@ describe Appsignal::Transaction do
       subject { transaction.send(:http_queue_start) }
 
       shared_examples "http queue start" do
+        context "when request is nil" do
+          let(:request) { nil }
+
+          it { should be_nil }
+        end
+
         context "when env is nil" do
-          before { transaction.request.stub(:env => nil) }
+          before { expect(transaction.request).to receive(:env).and_return(nil) }
 
           it { should be_nil }
         end
@@ -751,8 +769,16 @@ describe Appsignal::Transaction do
 
       subject { transaction.send(:sanitized_environment) }
 
+      context "when request is nil" do
+        let(:request) { nil }
+
+        it "returns nil" do
+          expect(subject).to be_nil
+        end
+      end
+
       context "when env is nil" do
-        before { transaction.request.stub(:env => nil) }
+        before { expect(transaction.request).to receive(:env).and_return(nil) }
 
         it { should be_nil }
       end
@@ -773,14 +799,22 @@ describe Appsignal::Transaction do
     describe '#sanitized_session_data' do
       subject { transaction.send(:sanitized_session_data) }
 
-      context "when env is nil" do
-        before { transaction.request.stub(:session => nil) }
+      context "when request is nil" do
+        let(:request) { nil }
+
+        it "returns nil" do
+          expect(subject).to be_nil
+        end
+      end
+
+      context "when session is nil" do
+        before { expect(transaction.request).to receive(:session).and_return(nil) }
 
         it { should be_nil }
       end
 
-      context "when env is empty" do
-        before { transaction.request.stub(:session => {}) }
+      context "when session is empty" do
+        before { expect(transaction.request).to receive(:session).and_return({}) }
 
         it { should eq({}) }
       end
@@ -844,8 +878,14 @@ describe Appsignal::Transaction do
     describe "#metadata" do
       subject { transaction.send(:metadata) }
 
+      context "when request is nil" do
+        let(:request) { nil }
+
+        it { should be_nil }
+      end
+
       context "when env is nil" do
-        before { transaction.request.stub(:env => nil) }
+        before { expect(transaction.request).to receive(:env).and_return(nil) }
 
         it { should be_nil }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5.beta.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -327,12 +327,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -432,3 +432,4 @@ test_files:
 - spec/support/project_fixture/log/.gitkeep
 - spec/support/rails/my_app.rb
 - spec/support/stubs/delayed_job.rb
+has_rdoc: