scout_apm 2.1.7 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f40f5bdf9854daba7e00560485c48995eca9ab99
-  data.tar.gz: ad7ee5e02e7c3aeeac40eff374c833ad398899f0
+  metadata.gz: a8c4c269396ae187fe901317425d0c984e2906bb
+  data.tar.gz: 3b2c16163875d6b9dd4fb5b54a3485fa4fc27353
 SHA512:
-  metadata.gz: 441475777c789a538940b14e442a49cddd93ff58fd701b3bff2ecc9e80e217a94460e9d782c11cd5475f6913d5dd05bdc43fdacfc5aecb75d3e044e0dcff8229
-  data.tar.gz: 1b52f6e495117cd132abafef45606f7c7a6e98b6d6a30dc1802a2f51139e8c6638503110c69a25a5b56d0c5a34e1ddebec254cf237254c9fcce7e8e2e14ed5a0
+  metadata.gz: e8793cf1a126e0e8c7294c633a06648352d301a7214f31aa7b863b9f1d3862c0148585eb711ce671312d17d697e92f834886c630e1974b62370dea03aaaf7aab
+  data.tar.gz: 84db938d6d9972e14901a3c7b13095a70de32ad0b9dc8c2b688a302bf96c04bb176a0086783c01cc99e47b8c12906d2d05d6ea1a84940f3e8b01c177deb9dcb5

data/CHANGELOG.markdown

@@ -1,4 +1,6 @@
-# master
+# 2.1.8
+
+* Adds Git revision detection, which is reported on app load and associated with transaction traces
 
 # 2.1.7
 

data/lib/scout_apm.rb

@@ -62,9 +62,6 @@ require 'scout_apm/platform_integrations/server'
 
 require 'scout_apm/histogram'
 
-require 'scout_apm/deploy_integrations/capistrano_3'
-# require 'scout_apm/deploy_integrations/capistrano_2'
-
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
 require 'scout_apm/instruments/moped'
@@ -128,6 +125,7 @@ require 'scout_apm/request_histograms'
 
 require 'scout_apm/capacity'
 require 'scout_apm/attribute_arranger'
+require 'scout_apm/git_revision'
 
 require 'scout_apm/serializers/payload_serializer'
 require 'scout_apm/serializers/payload_serializer_to_json'
@@ -136,7 +134,6 @@ require 'scout_apm/serializers/slow_jobs_serializer_to_json'
 require 'scout_apm/serializers/metrics_to_json_serializer'
 require 'scout_apm/serializers/directive_serializer'
 require 'scout_apm/serializers/app_server_load_serializer'
-require 'scout_apm/serializers/deploy_serializer'
 
 require 'scout_apm/middleware'
 

data/lib/scout_apm/agent.rb

@@ -121,11 +121,6 @@ module ScoutApm
 
       @ignored_uris = ScoutApm::IgnoredUris.new(config.value('ignore'))
 
-      if environment.deploy_integration
-        logger.info "Starting monitoring for [#{environment.deploy_integration.name}]]."
-        return environment.deploy_integration.install
-      end
-
       load_instruments if should_load_instruments?(options)
 
       return false unless preconditions_met?(options)
@@ -324,10 +319,6 @@ module ScoutApm
       instance.install
     end
 
-    def deploy_integration
-      environment.deploy_integration
-    end
-
     def app_server_missing?(options = {})
       !environment.app_server_integration(true).found? && !options[:skip_app_server_check]
     end

data/lib/scout_apm/app_server_load.rb

@@ -38,7 +38,8 @@ module ScoutApm
         :database_adapter   => ScoutApm::Environment.instance.raw_database_adapter, # Raw
         :application_name   => ScoutApm::Environment.instance.application_name,
         :libraries          => ScoutApm::Utils::InstalledGems.new.run,
-        :paas               => ScoutApm::Environment.instance.platform_integration.name
+        :paas               => ScoutApm::Environment.instance.platform_integration.name,
+        :git_sha            => ScoutApm::Environment.instance.git_revision.sha
       }
     end
   end

data/lib/scout_apm/environment.rb

@@ -41,13 +41,8 @@ module ScoutApm
       ScoutApm::PlatformIntegrations::Server.new,
     ]
 
-    DEPLOY_INTEGRATIONS = [
-      ScoutApm::DeployIntegrations::Capistrano3.new(STDOUT_LOGGER),
-      # ScoutApm::DeployIntegrations::Capistrano2.new(STDOUT_LOGGER),
-    ]
-
     def env
-      @env ||= deploy_integration? ? deploy_integration.env : framework_integration.env
+      @env ||= framework_integration.env
     end
 
     def framework
@@ -88,7 +83,7 @@ module ScoutApm
     end
 
     def root
-      @root ||= deploy_integration? ? deploy_integration.root : framework_root
+      @root ||= framework_root
     end
 
     def framework_root
@@ -110,6 +105,10 @@ module ScoutApm
       @hostname ||= Agent.instance.config.value("hostname") || platform_integration.hostname
     end
 
+    def git_revision
+      @git_revision ||= ScoutApm::GitRevision.new
+    end
+
     # Returns the whole integration object
     # This needs to be improved. Frequently, multiple app servers gem are present and which
     # ever is checked first becomes the designated app server.
@@ -143,14 +142,6 @@ module ScoutApm
       background_job_integration && background_job_integration.name
     end
 
-    def deploy_integration
-      @deploy_integration ||= DEPLOY_INTEGRATIONS.detect{ |integration| integration.present? }
-    end
-
-    def deploy_integration?
-      !@deploy_integration.nil?
-    end
-
     ### ruby checks
 
     def rubinius?

data/lib/scout_apm/git_revision.rb

@@ -0,0 +1,51 @@
+module ScoutApm
+  class GitRevision
+
+    attr_accessor :sha
+
+    def initialize
+      @sha = detect
+      ScoutApm::Agent.instance.logger.debug "Detected Git Revision [#{@sha}]"
+    end
+
+    private
+
+    def detect
+      detect_from_env_var    ||
+      detect_from_heroku     ||
+      detect_from_capistrano ||
+      detect_from_git
+    end
+
+    def detect_from_heroku
+      ENV['HEROKU_SLUG_COMMIT']
+    end
+
+    def detect_from_env_var
+      ENV['SCOUT_REVISION_SHA']
+    end
+
+    def detect_from_capistrano
+      version = File.read(File.join(app_root, 'REVISION')).strip
+      # Capistrano 3.0 - 3.1.x
+      version || File.open(File.join(app_root, '..', 'revisions.log')).to_a.last.strip.sub(/.*as release ([0-9]+).*/, '\1')
+    rescue
+      ScoutApm::Agent.instance.logger.debug "Unable to detect Git Revision from Capistrano: #{$!.message}"
+      nil
+    end
+
+    def detect_from_git
+      if File.directory?(".git")
+        `git rev-parse --short HEAD`.strip 
+      end
+    rescue
+      ScoutApm::Agent.instance.logger.debug "Unable to detect Git Revision from Git: #{$!.message}"
+      nil
+    end
+
+    def app_root
+      ScoutApm::Environment.instance.root
+    end
+
+  end
+end

data/lib/scout_apm/serializers/slow_jobs_serializer_to_json.rb

@@ -21,6 +21,7 @@ module ScoutApm
             "allocations" => job.allocations,
             "seconds_since_startup" => job.seconds_since_startup,
             "hostname" => job.hostname,
+            "git_sha" => job.git_sha,
             "metrics" => MetricsToJsonSerializer.new(job.metrics).as_json, # New style of metrics
             "allocation_metrics" => MetricsToJsonSerializer.new(job.allocation_metrics).as_json, # New style of metrics
             "context" => job.context.to_hash,

data/lib/scout_apm/slow_job_record.rb

@@ -20,6 +20,7 @@ module ScoutApm
     attr_reader :hostname
     attr_reader :seconds_since_startup
     attr_reader :score
+    attr_reader :git_sha
 
     def initialize(queue_name, job_name, time, total_time, exclusive_time, context, metrics, allocation_metrics, mem_delta, allocations, score)
       @queue_name = queue_name
@@ -34,6 +35,7 @@ module ScoutApm
       @allocations = allocations
       @seconds_since_startup = (Time.now - ScoutApm::Agent.instance.process_start_time)
       @hostname = ScoutApm::Environment.instance.hostname
+      @git_sha = ScoutApm::Environment.instance.git_revision.sha
       @score = score
       ScoutApm::Agent.instance.logger.debug { "Slow Job [#{metric_name}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta}"}
     end

data/lib/scout_apm/slow_transaction.rb

@@ -15,6 +15,7 @@ module ScoutApm
     attr_reader :allocations
     attr_accessor :hostname # hack - we need to reset these server side.
     attr_accessor :seconds_since_startup # hack - we need to reset these server side.
+    attr_accessor :git_sha # hack - we need to reset these server side.
 
     def initialize(uri, metric_name, total_call_time, metrics, allocation_metrics, context, time, raw_stackprof, mem_delta, allocations, score)
       @uri = uri
@@ -30,6 +31,7 @@ module ScoutApm
       @seconds_since_startup = (Time.now - ScoutApm::Agent.instance.process_start_time)
       @hostname = ScoutApm::Environment.instance.hostname
       @score = score
+      @git_sha = ScoutApm::Environment.instance.git_revision.sha
       ScoutApm::Agent.instance.logger.debug { "Slow Request [#{uri}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta} Score: #{score}"}
     end
 
@@ -44,7 +46,7 @@ module ScoutApm
     end
 
     def as_json
-      json_attributes = [:key, :time, :total_call_time, :uri, [:context, :context_hash], :score, :prof, :mem_delta, :allocations, :seconds_since_startup, :hostname]
+      json_attributes = [:key, :time, :total_call_time, :uri, [:context, :context_hash], :score, :prof, :mem_delta, :allocations, :seconds_since_startup, :hostname, :git_sha]
       ScoutApm::AttributeArranger.call(self, json_attributes)
     end
 

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.7"
+  VERSION = "2.1.8"
 end
 

data/test/unit/git_revision_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+require 'scout_apm/git_revision'
+
+class GitRevisionTest < Minitest::Test
+  # TODO - other tests that would be nice:
+  # * ensure we only detect once, on initialize.
+  # * tests for reading cap files
+  
+  def test_sha_from_heroku
+    ENV['HEROKU_SLUG_COMMIT'] = 'heroku_slug'
+    revision = ScoutApm::GitRevision.new
+    assert_equal 'heroku_slug', revision.sha
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.8
 platform: ruby
 authors:
 - Derek Haynes
@@ -131,16 +131,13 @@ files:
 - lib/scout_apm/capacity.rb
 - lib/scout_apm/config.rb
 - lib/scout_apm/context.rb
-- lib/scout_apm/deploy_integrations/capistrano_2.cap
-- lib/scout_apm/deploy_integrations/capistrano_2.rb
-- lib/scout_apm/deploy_integrations/capistrano_3.cap
-- lib/scout_apm/deploy_integrations/capistrano_3.rb
 - lib/scout_apm/environment.rb
 - lib/scout_apm/fake_store.rb
 - lib/scout_apm/framework_integrations/rails_2.rb
 - lib/scout_apm/framework_integrations/rails_3_or_4.rb
 - lib/scout_apm/framework_integrations/ruby.rb
 - lib/scout_apm/framework_integrations/sinatra.rb
+- lib/scout_apm/git_revision.rb
 - lib/scout_apm/histogram.rb
 - lib/scout_apm/ignored_uris.rb
 - lib/scout_apm/instant/assets/xmlhttp_instrumentation.html
@@ -191,7 +188,6 @@ files:
 - lib/scout_apm/request_manager.rb
 - lib/scout_apm/scored_item_set.rb
 - lib/scout_apm/serializers/app_server_load_serializer.rb
-- lib/scout_apm/serializers/deploy_serializer.rb
 - lib/scout_apm/serializers/directive_serializer.rb
 - lib/scout_apm/serializers/jobs_serializer_to_json.rb
 - lib/scout_apm/serializers/metrics_to_json_serializer.rb
@@ -232,6 +228,7 @@ files:
 - test/unit/config_test.rb
 - test/unit/context_test.rb
 - test/unit/environment_test.rb
+- test/unit/git_revision_test.rb
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
@@ -266,8 +263,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files: []
+test_files:
+- test/data/config_test_1.yml
+- test/test_helper.rb
+- test/unit/agent_test.rb
+- test/unit/background_job_integrations/sidekiq_test.rb
+- test/unit/config_test.rb
+- test/unit/context_test.rb
+- test/unit/environment_test.rb
+- test/unit/git_revision_test.rb
+- test/unit/histogram_test.rb
+- test/unit/ignored_uris_test.rb
+- test/unit/instruments/active_record_instruments_test.rb
+- test/unit/layaway_test.rb
+- test/unit/metric_set_test.rb
+- test/unit/scored_item_set_test.rb
+- test/unit/serializers/payload_serializer_test.rb
+- test/unit/slow_job_policy_test.rb
+- test/unit/slow_request_policy_test.rb
+- test/unit/sql_sanitizer_test.rb
+- test/unit/store_test.rb
+- test/unit/utils/active_record_metric_name_test.rb
+- test/unit/utils/backtrace_parser_test.rb
+has_rdoc: 

data/lib/scout_apm/deploy_integrations/capistrano_2.cap

@@ -1,12 +0,0 @@
-namespace :scout_apm do
-  namespace :deploy do
-    task :starting do
-      # Warn if missing scout apm deploy creds?
-    end
-    task :finished do
-      ScoutApm::Agent.instance.deploy_integration.report
-    end
-  end
-end
-
-after 'deploy:finished', 'scout_apm:deploy:finished'

data/lib/scout_apm/deploy_integrations/capistrano_2.rb

@@ -1,83 +0,0 @@
-require 'scout_apm'
-
-module ScoutApm
-  module DeployIntegrations
-    class Capistrano2
-      attr_reader :logger
-
-      def initialize(logger)
-        @logger = logger
-        @cap = defined?(Capistrano::Configuration) ? ObjectSpace.each_object(Capistrano::Configuration).map.first : nil rescue nil
-      end
-
-      def name
-        :capistrano_2
-      end
-
-      def version
-        present? ? Capistrano::VERSION : nil
-      end
-
-      def present?
-        if !@cap.nil? && @cap.is_a?(Capistrano::Configuration)
-          require 'capistrano/version'
-          defined?(Capistrano::VERSION) && Gem::Dependency.new('', '~> 2.0').match?('', Capistrano::VERSION.to_s)
-        else
-          return false
-        end
-        return true
-      rescue
-        return false
-      end
-
-      def install
-        logger.debug "Initializing Capistrano2 Deploy Integration."
-        @cap.load File.expand_path("../capistrano_2.cap", __FILE__)
-      end
-
-      def root
-        '.'
-      end
-
-      def env
-        @cap.fetch(:stage)
-      end
-
-      def found?
-        true
-      end
-
-      def report
-        if reporter.can_report?
-          data = deploy_data
-          logger.debug "Sending deploy hook data: #{data}"
-          payload = ScoutApm::Serializers::DeploySerializer.serialize(data)
-          reporter.report(payload, ScoutApm::Serializers::DeploySerializer::HTTP_HEADERS)
-        else
-          logger.warn "Unable to post deploy hook data"
-        end
-      end
-
-      def reporter
-        @reporter ||= ScoutApm::Reporter.new(:deploy_hook, ScoutApm::Agent.instance.config, @logger)
-      end
-
-      def deploy_data
-        {:revision => current_revision, :branch => branch, :deployed_by => deployed_by}
-      end
-
-      def branch
-        @cap.fetch(:branch)
-      end
-
-      def current_revision
-        @cap.fetch(:current_revision) || `git rev-list --max-count=1 --abbrev-commit --abbrev=12 #{branch}`.chomp
-      end
-
-      def deployed_by
-        ScoutApm::Agent.instance.config.value('deployed_by')
-      end
-
-    end
-  end
-end

data/lib/scout_apm/deploy_integrations/capistrano_3.cap

@@ -1,12 +0,0 @@
-namespace :scout_apm do
-  namespace :deploy do
-    task :starting do
-      # Warn if missing scout apm deploy creds?
-    end
-    task :finished do
-      ScoutApm::Agent.instance.deploy_integration.report
-    end
-  end
-end
-
-after 'deploy:finished', 'scout_apm:deploy:finished'

data/lib/scout_apm/deploy_integrations/capistrano_3.rb

@@ -1,88 +0,0 @@
-require 'scout_apm'
-
-module ScoutApm
-  module DeployIntegrations
-    class Capistrano3
-      attr_reader :logger
-
-      def initialize(logger)
-        @logger = logger
-        @cap = Rake.application rescue nil
-      end
-
-      def name
-        :capistrano_3
-      end
-
-      def version
-        present? ? Capistrano::VERSION : nil
-      end
-
-      def present?
-        if !@cap.nil? && @cap.is_a?(Capistrano::Application)
-          require 'capistrano/version'
-          defined?(Capistrano::VERSION) && Gem::Dependency.new('', '~> 3.0').match?('', Capistrano::VERSION.to_s)
-        else
-          return false
-        end
-      rescue
-        return false
-      end
-
-      def install
-        logger.debug "Initializing Capistrano3 Deploy Integration."
-        load File.expand_path("../capistrano_3.cap", __FILE__)
-      end
-
-      def root
-        '.'
-      end
-
-      def env
-        @cap.fetch(:stage).to_s
-      end
-
-      def found?
-        true
-      end
-
-      def report
-        if reporter.can_report?
-          data = deploy_data
-          logger.debug "Sending deploy hook data: #{data}"
-          payload = ScoutApm::Serializers::DeploySerializer.serialize(data)
-          reporter.report(payload, ScoutApm::Serializers::DeploySerializer::HTTP_HEADERS)
-        else
-          logger.warn "Unable to post deploy hook data"
-        end
-      end
-
-      def reporter
-        config =  if env == '' 
-                    ScoutApm::Agent.instance.config
-                  else
-                    ScoutApm::Config.with_file(nil, {:file => { :environment => env }}) # instantiate our own config, with an overridden environment for the deploy-to app name instead of deploy-from app name)
-                  end
-
-        @reporter ||= ScoutApm::Reporter.new(:deploy_hook, config, @logger)
-      end
-
-      def deploy_data
-        {:revision => current_revision, :branch => branch, :deployed_by => deployed_by}
-      end
-
-      def branch
-        @cap.fetch(:branch)
-      end
-
-      def current_revision
-        @cap.fetch(:current_revision) || `git rev-list --max-count=1 --abbrev-commit --abbrev=12 #{branch}`.chomp
-      end
-
-      def deployed_by
-        ScoutApm::Agent.instance.config.value('deployed_by')
-      end
-
-    end
-  end
-end

data/lib/scout_apm/serializers/deploy_serializer.rb

@@ -1,16 +0,0 @@
-# Serialize & deserialize deploy data up to the APM server
-module ScoutApm
-  module Serializers
-    class DeploySerializer
-      HTTP_HEADERS = {'Content-Type' => 'application/x-www-form-urlencoded'}
-
-      def self.serialize(data)
-        URI.encode_www_form(data)
-      end
-
-      def self.deserialize(data)
-        Marshal.load(data)
-      end
-    end
-  end
-end