heimdall_apm 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ca420677755ff0041326907530a7887a2f8a328
-  data.tar.gz: 6dc9025653e4cf087d16cc94d4c69be7e841879a
+SHA256:
+  metadata.gz: eac3ebfde6ef8035d0178d14eab1923154711c8059df48d5837a85d746dc829e
+  data.tar.gz: 64c57c8f8f47f3ad09f779beb9d5942efbe72695c0803be905563e26b23606bd
 SHA512:
-  metadata.gz: bae5184971387ed286e27d9fd7ed4ef8f988f85853fa50fe6f72a64fa7fbd61fcd9868e405a957c5ca7b40598a25de510fff765a5454e04f949379ec4bf0867e
-  data.tar.gz: cca579bdcd94979119200aaee7ecba688f1e17d26386fefa7635551effdeb54f1180a6a6b46be20dde089b59cc0091067608333d70898225defa3d1baa8dc695
+  metadata.gz: 6b1c593c535eb5019e2ea53ce7f1c4f16526e53ef302ddb6a2a5533549b1413269ccde39ec15da3cdc16ee28966d8eedb6f542892293c674886f9ea92f071495
+  data.tar.gz: 5d676be2b3bb5280440ad64ba33404a972ac4d033ec3a4fa00f09f090d674297fd15f369661aff396277d44b29b54802db4cd56836b1bfa6a67b6701d8c94b6b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.3
+  * Add configure option to completely ignore endpoints
+  * Add Sidekiq support

data/heimdall_apm.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ccocchi/heimdall"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.start_with?('test', 'bin')
+    f.start_with?('test', 'bin', 'config')
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/heimdall_apm.rb

@@ -5,10 +5,5 @@ require 'heimdall_apm/probe'
 require 'heimdall_apm/agent'
 require 'heimdall_apm/railtie' if defined?(Rails)
 
-require 'logger'
-
 module HeimdallApm
-  def self.logger
-    @logger ||= Logger.new('log/heimdall_apm.log')
-  end
 end

data/lib/heimdall_apm/agent.rb

@@ -29,15 +29,15 @@ module HeimdallApm
       context.config = ::HeimdallApm::Config.new
 
       if context.interactive?
-        HeimdallApm.logger.info 'Preventing agent to start in interactive mode'
+        context.logger.info 'Preventing agent to start in interactive mode'
         return
       end
 
-      if defined?(Sidekiq) && Sidekiq.server?
-        # TODO: handle custom instrumentation disabling
-        HeimdallApm.logger.info 'Preventing agent to start in sidekiq server'
-        return
-      end
+      # if defined?(Sidekiq) && Sidekiq.server?
+      #   # TODO: handle custom instrumentation disabling
+      #   HeimdallApm.logger.info 'Preventing agent to start in sidekiq server'
+      #   return
+      # end
 
       start(options)
     end
@@ -46,9 +46,13 @@ module HeimdallApm
       return unless context.config.value('enabled')
 
       # TODO: use instruments manager
-      require 'heimdall_apm/instruments/active_record'      if defined?(ActiveRecord)
-      require 'heimdall_apm/instruments/action_controller'  if defined?(ActionController)
-      require 'heimdall_apm/instruments/elasticsearch'      if defined?(Elasticsearch)
+      if !defined?(Sidekiq) || !Sidekiq.server?
+        require 'heimdall_apm/instruments/active_record'      if defined?(ActiveRecord)
+        require 'heimdall_apm/instruments/action_controller'  if defined?(ActionController)
+        require 'heimdall_apm/instruments/elasticsearch'      if defined?(Elasticsearch)
+      end
+
+      require 'heimdall_apm/instruments/sidekiq' if defined?(Sidekiq) && Sidekiq.server?
 
       if (options[:app])
         require 'heimdall_apm/instruments/middleware'
@@ -64,7 +68,7 @@ module HeimdallApm
     end
 
     def stop
-      HeimdallApm.logger.info 'Stopping agent...'
+      context.logger.info 'Stopping agent...'
       @stopped = true
       context.stopped!
       if @background_thread.alive?
@@ -76,7 +80,7 @@ module HeimdallApm
     private
 
     def background_run
-      HeimdallApm.logger.info "Start background thread"
+      context.logger.info "Start background thread"
       reporting = ::HeimdallApm::Reporting.new(@context)
       next_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) + DEFAULT_PUSH_INTERVAL
 
@@ -91,7 +95,7 @@ module HeimdallApm
 
         if now < next_time
           remaining = next_time - now
-          HeimdallApm.logger.debug "Sleeping for #{remaining}"
+          context.logger.debug { "Sleeping for #{remaining}" }
           sleep(remaining)
           next
         end
@@ -100,7 +104,7 @@ module HeimdallApm
         next_time = now + DEFAULT_PUSH_INTERVAL
       end
     rescue => e
-      HeimdallApm.logger.error e.message
+      context.logger.error e.message
     end
   end
 end

data/lib/heimdall_apm/agent_context.rb

@@ -1,6 +1,10 @@
+require 'set'
+require 'logger'
+
 require 'heimdall_apm/vault'
 require 'heimdall_apm/recorder'
 require 'heimdall_apm/config'
+require 'heimdall_apm/uri_matcher'
 
 module HeimdallApm
   # Global context in which the agent is run. One context is assigned per
@@ -27,6 +31,14 @@ module HeimdallApm
       @config ||= ::HeimdallApm::Config.new
     end
 
+    def logger
+      @logger ||= begin
+        logger = Logger.new('log/heimdall_apm.log')
+        logger.level = config['log_level'].presence || :debug
+        logger
+      end
+    end
+
     def vault
       @vault ||= ::HeimdallApm::Vault.new(self)
     end
@@ -35,6 +47,10 @@ module HeimdallApm
       @recorder ||= ::HeimdallApm::Recorder.new
     end
 
+    def ignored_uris
+      @ignored_uris ||= ::HeimdallApm::UriMatcher.new(config.value('ignore'))
+    end
+
     def interactive?
       defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
     end

data/lib/heimdall_apm/instruments/action_controller.rb

@@ -6,7 +6,13 @@ module HeimdallApm
         scope   = -"#{payload[:controller]}##{payload[:action]}"
         segment = ::HeimdallApm::Segment.new('Controller'.freeze, scope)
 
+        # Don't override scope if already set. Should never happen in practice
+        # unless a controller calls another action.
         txn.scope = scope unless txn.scope
+
+        # Rails gives us Request#fullpath
+        txn.annotate({ uri: extract_path(payload[:path]) })
+
         txn.start_segment(segment)
       end
 
@@ -14,6 +20,13 @@ module HeimdallApm
         txn = ::HeimdallApm::TransactionManager.current
         txn.stop_segment
       end
+
+      private
+
+      def extract_path(fullpath)
+        i = fullpath.index('?'.freeze)
+        i ? fullpath.slice(0, i) : fullpath
+      end
     end
   end
 end

data/lib/heimdall_apm/instruments/sidekiq.rb

@@ -0,0 +1,41 @@
+module HeimdallApm
+  module Instruments
+    class SidekiqMiddleware
+      def call(_worker, item, queue, redis_pool = nil)
+        txn     = ::HeimdallApm::TransactionManager.current
+        txn.annotate(latency: latency(item))
+        txn.scope = unwrapped_worker_name(item)
+
+        segment = ::HeimdallApm::Segment.new('Job'.freeze, 'all'.freeze)
+        txn.start_segment(segment)
+
+        yield
+      ensure
+        txn.stop_segment
+      end
+
+      private
+
+      def unwrapped_worker_name(item)
+        item['wrapped'] || item['class']
+      end
+
+      def latency(item)
+        created_at = item['enqueued_at'] || item['created_at']
+        if created_at
+          (Time.now.to_f - created_at)
+        else
+          0.0
+        end
+      rescue
+        0.0
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add HeimdallApm::Instruments::SidekiqMiddleware
+  end
+end

data/lib/heimdall_apm/points_collection.rb

@@ -27,6 +27,8 @@ module HeimdallApm
       @points
     end
 
+    # TODO: this looks very custom, need to find a way to better map a txn and
+    # its segment into InfluxDB.
     def append(txn, metrics)
       timestamp   = txn.root_segment.stop_time
       series_name = txn.custom_series_name || (txn.web? ? 'app' : 'job')
@@ -48,6 +50,8 @@ module HeimdallApm
         values['total_time'] += stat.total_exclusive_time
       end
 
+      values['latency'] = txn.annotations[:latency] if txn.annotations[:latency]
+
       # Segment time are in seconds, store them in milliseconds
       values.transform_values! { |v| v.is_a?(Integer) ? v : v * 1000 }
 

data/lib/heimdall_apm/reporting.rb

@@ -4,6 +4,7 @@ module HeimdallApm
       @context = context
     end
 
+    # TODO: make this configurable
     def influx
       @client ||= InfluxDB::Client.new("#{Rails.env}_metrics", time_precision: 'ms', retry: 0)
     end
@@ -13,10 +14,10 @@ module HeimdallApm
       if span && !span.points_collection.empty?
         influx.write_points(span.points_collection.to_a)
       else
-        HeimdallApm.logger.debug "Nothing to report"
+        @context.logger.debug "Nothing to report"
       end
     rescue => e
-      HeimdallApm.logger.error "#{e.message} during reporting to InfluxDB"
+      @context.logger.error "#{e.message} during reporting to InfluxDB"
     end
   end
 end

data/lib/heimdall_apm/tracked_transaction.rb

@@ -72,7 +72,10 @@ module HeimdallApm
     }
 
     def record
-      return unless root_segment
+      # TODO: investigate on why mode can be nil sometimes
+      return unless root_segment && @mode
+      # TODO: doesn't feel like it should be done here
+      return if annotations[:uri] && @context.ignored_uris.match?(annotations[:uri])
 
       VISITORS.each do |_, klass|
         visitor = klass.new(@vault, self)

data/lib/heimdall_apm/uri_matcher.rb

@@ -0,0 +1,11 @@
+module HeimdallApm
+  class UriMatcher
+    def initialize(prefixes)
+      @prefixes = Array(prefixes)
+    end
+
+    def match?(uri)
+      @prefixes.empty? ? false : uri.start_with?(*@prefixes)
+    end
+  end
+end

data/lib/heimdall_apm/version.rb

@@ -1,3 +1,3 @@
 module HeimdallApm
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heimdall_apm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Christopher Cocchi-Perrier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -75,6 +76,7 @@ files:
 - lib/heimdall_apm/instruments/active_record.rb
 - lib/heimdall_apm/instruments/elasticsearch.rb
 - lib/heimdall_apm/instruments/middleware.rb
+- lib/heimdall_apm/instruments/sidekiq.rb
 - lib/heimdall_apm/metric_name.rb
 - lib/heimdall_apm/metric_stats.rb
 - lib/heimdall_apm/points_collection.rb
@@ -85,6 +87,7 @@ files:
 - lib/heimdall_apm/segment.rb
 - lib/heimdall_apm/tracked_transaction.rb
 - lib/heimdall_apm/transaction_manager.rb
+- lib/heimdall_apm/uri_matcher.rb
 - lib/heimdall_apm/vault.rb
 - lib/heimdall_apm/version.rb
 - lib/heimdall_apm/visitors/pretty_print_visitor.rb
@@ -109,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Open source monitoring for Rails applications