elastic-apm 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 329562f592fbece5d73eb15b09d06085abf6f243ff93626b7fed6429b29d7b82
-  data.tar.gz: 269658c639e1459453f953dff804d97de8ed4a18093b4dfca76cedb1282d614f
+  metadata.gz: 98b3dde3453861c6e77db385bea9d0bd54c6d76dd2cb8dd253c046a4f42beb8c
+  data.tar.gz: a1b948919538e6e5c3eecd1db3fc6bcccff95eef8be335c7cc8913183b47f9fc
 SHA512:
-  metadata.gz: ed067d07389e9187e290b2e47000f016e4ff72e4e717a9530d5dac64e73caa1648cd57b35413fffb03ee21780a65402ff7b64bf59ed468085576294e6dd38171
-  data.tar.gz: b7425968e951aa1161812a3a15c9205904984d215081b273cb24ce59132e9a069dc59ac7a88d86d4a50f0d1de9db2aac948ec2037722f5dfdc7f20a0b011bc86
+  metadata.gz: d454b1c732c8acc5b2e5ce5cb1b3d5243f563cd0697ae126a104a9bd1c1be8c9b1adbdcadc50d45e9c9e6e9e31aebb6ed6dfc74e68620d859d591d4b7597e9aa
+  data.tar.gz: 77b6649b0b80b2a1294e1d628cee48b47db707c688766fa517ad2e360ae88ae9ff75645f8b8d9fe50a69afb17dd4f15f94e2c7320c5a5521dd9333dc3360c82d

data/.rubocop.yml

@@ -17,6 +17,9 @@ Layout/EmptyLinesAroundArguments:
 Lint/RescueException:
   Enabled: false
 
+Lint/HandleExceptions:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'

data/Gemfile

@@ -6,6 +6,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
+gem 'elasticsearch'
 gem 'fakeredis', require: nil,
   github: 'guilleiguaran/fakeredis' # needs master right now
 gem 'json-schema'
@@ -15,6 +16,7 @@ gem 'redis', require: nil
 gem 'rspec'
 gem 'rubocop'
 gem 'sequel'
+gem 'sidekiq'
 gem 'timecop'
 gem 'webmock'
 gem 'yard'
@@ -36,3 +38,9 @@ when /.+/
 else
   gem framework
 end
+
+# doesn't work with Rails master, so skip testing
+gem 'delayed_job' unless [framework, version] == %w[rails master]
+
+gem 'rails' if framework == 'sinatra'
+gem 'sinatra' if framework == 'rails'

data/lib/elastic_apm/agent.rb

@@ -23,15 +23,15 @@ module ElasticAPM
       @instance
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def self.start(config)
+    def self.start(config) # rubocop:disable Metrics/MethodLength
       return @instance if @instance
 
-      config = Config.new(config) if config.is_a?(Hash)
+      config = Config.new(config) unless config.is_a?(Config)
 
       unless config.enabled_environments.include?(config.environment)
-        config.logger && config.logger.info(
-          format('Not tracking anything in "%s" env', config.environment)
+        puts format(
+          '%sNot tracking anything in "%s" env',
+          Log::PREFIX, config.environment
         )
         return
       end
@@ -39,10 +39,9 @@ module ElasticAPM
       LOCK.synchronize do
         return @instance if @instance
 
-        @instance = new(config.freeze).start
+        @instance = new(config).start
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def self.stop
       LOCK.synchronize do

data/lib/elastic_apm/config.rb

@@ -7,6 +7,9 @@ module ElasticAPM
   # @api private
   class Config
     DEFAULTS = {
+      config_file: 'config/elastic_apm.yml',
+      worker_process: false,
+
       server_url: 'http://localhost:8200',
       secret_token: nil,
 
@@ -78,16 +81,19 @@ module ElasticAPM
       'ELASTIC_APM_TRANSACTION_MAX_SPANS' => [:int, 'transaction_max_spans']
     }.freeze
 
-    def initialize(options = nil)
-      options = {} if options.nil?
-
+    def initialize(options = {})
       set_defaults
-      set_from_env
+
       set_from_args(options)
+      set_from_config_file
+      set_from_env
 
       yield self if block_given?
     end
 
+    attr_accessor :config_file
+    attr_accessor :worker_process
+
     attr_accessor :server_url
     attr_accessor :secret_token
 
@@ -167,12 +173,16 @@ module ElasticAPM
 
     private
 
-    def set_defaults
-      DEFAULTS.each do |key, value|
+    def assign(options)
+      options.each do |key, value|
         send("#{key}=", value)
       end
     end
 
+    def set_defaults
+      assign(DEFAULTS)
+    end
+
     # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
     def set_from_env
       ENV_TO_KEY.each do |env_key, key|
@@ -195,9 +205,12 @@ module ElasticAPM
     # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
 
     def set_from_args(options)
-      options.each do |key, value|
-        send("#{key}=", value)
-      end
+      assign(options)
+    end
+
+    def set_from_config_file
+      return unless File.exist?(config_file)
+      assign(YAML.load_file(config_file) || {})
     end
 
     def set_sinatra(app)
@@ -208,11 +221,12 @@ module ElasticAPM
       self.root_path = Dir.pwd
     end
 
-    def set_rails(app)
-      self.service_name = format_name(service_name || app.class.parent_name)
-      self.framework_name = 'Ruby on Rails'
-      self.framework_version = Rails::VERSION::STRING
-      self.logger = Rails.logger
+    def set_rails(app) # rubocop:disable Metrics/AbcSize
+      self.service_name ||= format_name(service_name || app.class.parent_name)
+      self.framework_name ||= 'Ruby on Rails'
+      self.framework_version ||= Rails::VERSION::STRING
+      self.logger ||= Rails.logger
+
       self.root_path = Rails.root.to_s
       self.view_paths = app.config.paths['app/views'].existent
     end

data/lib/elastic_apm/http.rb

@@ -39,7 +39,7 @@ module ElasticAPM
       return response if status >= 200 && status <= 299
 
       error "POST returned an unsuccessful status code (#{response.code})"
-      debug response.body
+      error response.body
 
       response
     end

data/lib/elastic_apm/injectors.rb

@@ -75,7 +75,7 @@ module Kernel
 
     begin
       ElasticAPM::Injectors.hook_into(path)
-    rescue ::Exception # rubocop:disable Lint/HandleExceptions
+    rescue ::Exception
     end
 
     res

data/lib/elastic_apm/injectors/delayed_job.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module Injectors
+    # @api private
+    class DelayedJobInjector
+      CLASS_SEPARATOR = '.'.freeze
+      METHOD_SEPARATOR = '#'.freeze
+      TYPE = 'Delayed::Job'.freeze
+
+      def install
+        ::Delayed::Backend::Base.class_eval do
+          alias invoke_job_without_apm invoke_job
+
+          def invoke_job(*args, &block)
+            ::ElasticAPM::Injectors::DelayedJobInjector
+              .invoke_job(self, *args, &block)
+          end
+        end
+      end
+
+      def self.invoke_job(job, *args, &block)
+        job_name = name_from_payload(job.payload_object)
+        transaction = ElasticAPM.transaction(job_name, TYPE)
+        job.invoke_job_without_apm(*args, &block)
+        transaction.submit 'success'
+      rescue ::Exception => e
+        ElasticAPM.report(e, handled: false)
+        transaction.submit 'error'
+        raise
+      ensure
+        transaction.release if transaction
+      end
+
+      def self.name_from_payload(payload_object)
+        if payload_object.is_a?(::Delayed::PerformableMethod)
+          performable_method_name(payload_object)
+        else
+          payload_object.class.name
+        end
+      end
+
+      def self.performable_method_name(payload_object)
+        class_name = object_name(payload_object)
+        separator = name_separator(payload_object)
+        method_name = payload_object.method_name
+        "#{class_name}#{separator}#{method_name}"
+      end
+
+      def self.object_name(payload_object)
+        object = payload_object.object
+        klass = object.is_a?(Class) ? object : object.class
+        klass.name
+      end
+
+      def self.name_separator(payload_object)
+        payload_object.object.is_a?(Class) ? CLASS_SEPARATOR : METHOD_SEPARATOR
+      end
+    end
+
+    register(
+      'Delayed::Backend::Base',
+      'delayed/backend/base',
+      DelayedJobInjector.new
+    )
+  end
+end

data/lib/elastic_apm/injectors/elasticsearch.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module Injectors
+    # @api private
+    class ElasticsearchInjector
+      NAME_FORMAT = '%s %s'.freeze
+      TYPE = 'db.elasticsearch'.freeze
+
+      def install
+        ::Elasticsearch::Transport::Client.class_eval do
+          alias perform_request_without_apm perform_request
+
+          def perform_request(method, path, *args, &block)
+            name = format(NAME_FORMAT, method, path)
+            context = Span::Context.new(statement: args[0])
+
+            ElasticAPM.span name, TYPE, context: context do
+              perform_request_without_apm(method, path, *args, &block)
+            end
+          end
+        end
+      end
+    end
+
+    register(
+      'Elasticsearch::Transport::Client',
+      'elasticsearch-transport',
+      ElasticsearchInjector.new
+    )
+  end
+end

data/lib/elastic_apm/injectors/sidekiq.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module Injectors
+    # @api private
+    class SidekiqInjector
+      ACTIVE_JOB_WRAPPER =
+        'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
+
+      # @api private
+      class Middleware
+        # rubocop:disable Metrics/MethodLength
+        def call(_worker, job, queue)
+          name = SidekiqInjector.name_for(job)
+          transaction = ElasticAPM.transaction(name, 'Sidekiq')
+          ElasticAPM.set_tag(:queue, queue)
+
+          yield
+
+          transaction.submit('success') if transaction
+        rescue ::Exception => e
+          ElasticAPM.report(e, handled: false)
+          transaction.submit(:error) if transaction
+          raise
+        ensure
+          transaction.release if transaction
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+
+      def self.name_for(job)
+        klass = job['class']
+
+        case klass
+        when ACTIVE_JOB_WRAPPER
+          job['wrapped']
+        else
+          klass
+        end
+      end
+
+      def install_middleware
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add Middleware
+          end
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def install_processor
+        require 'sidekiq/processor'
+
+        Sidekiq::Processor.class_eval do
+          alias start_without_apm start
+          alias terminate_without_apm terminate
+
+          def start
+            result = start_without_apm
+            ElasticAPM.start # might already be running from railtie
+
+            return result unless ElasticAPM.running?
+            ElasticAPM.agent.config.logger = Sidekiq.logger
+
+            result
+          end
+
+          def terminate
+            terminate_without_apm
+
+            ElasticAPM.stop
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def install
+        install_processor
+        install_middleware
+      end
+    end
+
+    register 'Sidekiq', 'sidekiq', SidekiqInjector.new
+  end
+end

data/lib/elastic_apm/instrumenter.rb

@@ -89,19 +89,27 @@ module ElasticAPM
     # rubocop:enable Metrics/MethodLength
 
     def span(*args, &block)
-      transaction.span(*args, &block)
+      unless current_transaction
+        return yield if block_given?
+        return
+      end
+
+      current_transaction.span(*args, &block)
     end
 
     def set_tag(key, value)
-      transaction.context.tags[key] = value.to_s
+      return unless current_transaction
+      current_transaction.context.tags[key] = value.to_s
     end
 
     def set_custom_context(context)
-      transaction.context.custom.merge!(context)
+      return unless current_transaction
+      current_transaction.context.custom.merge!(context)
     end
 
     def set_user(user)
-      transaction.context.user = Context::User.new(config, user)
+      return unless current_transaction
+      current_transaction.context.user = Context::User.new(config, user)
     end
 
     def submit_transaction(transaction)

data/lib/elastic_apm/middleware.rb

@@ -14,13 +14,16 @@ module ElasticAPM
           context: ElasticAPM.build_context(env)
 
         resp = @app.call env
+        status, headers, = resp
 
-        transaction.submit(resp[0], headers: resp[1]) if transaction
+        if transaction
+          transaction.submit(status, status: status, headers: headers)
+        end
       rescue InternalError
         raise # Don't report ElasticAPM errors
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.submit(500) if transaction
+        transaction.submit(500, status: 500) if transaction
         raise
       ensure
         transaction.release if transaction

data/lib/elastic_apm/railtie.rb

@@ -7,14 +7,7 @@ module ElasticAPM
     Config::DEFAULTS.each { |option, value| config.elastic_apm[option] = value }
 
     initializer 'elastic_apm.initialize' do |app|
-      config = Config.new app.config.elastic_apm do |c|
-        c.app = app
-      end
-
-      file_config = load_config(app)
-      file_config.each do |option, value|
-        config.send(:"#{option}=", value)
-      end
+      config = app.config.elastic_apm.merge(app: app)
 
       begin
         ElasticAPM.start config
@@ -29,14 +22,5 @@ module ElasticAPM
     config.after_initialize do
       require 'elastic_apm/injectors/action_dispatch'
     end
-
-    private
-
-    def load_config(app)
-      config_path = app.root.join('config', 'elastic_apm.yml')
-      return {} unless File.exist?(config_path)
-
-      YAML.load_file(config_path) || {}
-    end
   end
 end

data/lib/elastic_apm/span.rb

@@ -5,21 +5,21 @@ require 'elastic_apm/span/context'
 module ElasticAPM
   # @api private
   class Span
-    DEFAULT_KIND = 'custom'.freeze
+    DEFAULT_TYPE = 'custom'.freeze
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
       transaction,
       id,
       name,
-      type = DEFAULT_KIND,
+      type = nil,
       parent: nil,
       context: nil
     )
       @transaction = transaction
       @id = id
       @name = name
-      @type = type
+      @type = type || DEFAULT_TYPE
       @parent = parent
       @context = context
       @stacktrace = nil

data/lib/elastic_apm/transaction.rb

@@ -3,18 +3,14 @@
 module ElasticAPM
   # @api private
   class Transaction
+    DEFAULT_TYPE = 'custom'.freeze
+
     # rubocop:disable Metrics/MethodLength
-    def initialize(
-      instrumenter,
-      name,
-      type = 'custom',
-      context: nil,
-      sampled: true
-    )
+    def initialize(instrumenter, name, type = nil, context: nil, sampled: true)
       @id = SecureRandom.uuid
       @instrumenter = instrumenter
       @name = name
-      @type = type
+      @type = type || DEFAULT_TYPE
 
       @timestamp = Util.micros
 
@@ -51,10 +47,12 @@ module ElasticAPM
       !!(@result && @duration)
     end
 
-    def submit(status = nil, headers: {})
-      done status
+    def submit(result = nil, status: nil, headers: {})
+      done result
 
-      context.response = Context::Response.new(status, headers: headers)
+      if status
+        context.response = Context::Response.new(status, headers: headers)
+      end
 
       release
 

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '0.4.5'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,10 +73,13 @@ files:
 - lib/elastic_apm/http.rb
 - lib/elastic_apm/injectors.rb
 - lib/elastic_apm/injectors/action_dispatch.rb
+- lib/elastic_apm/injectors/delayed_job.rb
+- lib/elastic_apm/injectors/elasticsearch.rb
 - lib/elastic_apm/injectors/json.rb
 - lib/elastic_apm/injectors/net_http.rb
 - lib/elastic_apm/injectors/redis.rb
 - lib/elastic_apm/injectors/sequel.rb
+- lib/elastic_apm/injectors/sidekiq.rb
 - lib/elastic_apm/injectors/sinatra.rb
 - lib/elastic_apm/injectors/tilt.rb
 - lib/elastic_apm/instrumenter.rb