elastic-apm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6272279575b41ace4dc7581df1d6ea387f46c260d591c338fceb256f0b46ff2
-  data.tar.gz: f793a0c902a18abfe647e5a3a41c86d96926910dfef21094aa3b1c37deac45eb
+  metadata.gz: c00a8dd4ed640c7c98fa3b32f0a252920237e549a10d6592de58d6d4b281ab48
+  data.tar.gz: 3fc4f34aab25ace89c0b689747316245b667bc77b348c4d9d2b08605681179ff
 SHA512:
-  metadata.gz: 3f16cbdffc10a05005c03ec0d122235c84b56a9bda9f2201fd913e1d3b96925d3f5ef0847cfd2cc369da0b1d1c39c21dccd187579f278d7439218c97b4548a97
-  data.tar.gz: 4daea6a3d579f4fba6435de9277bdd842889b6afeab63c97da9a9424809d6e4721bd873da4edecae1eeb66281ae43989385027099f0c828a38bff94c4ec3addd
+  metadata.gz: 6062baf5ed08855d53781d589ff7266b784af1b231511327b527619229743d570868e319be7cb060770bd436a92df24955807e6c8cfcbdb80151d29ac7e7b9fb
+  data.tar.gz: 9516bd876fbfd8c6061b189b603923bb37f740492904d40c10180603f09b0d86a0f97e198962a66570b59851c1fa8e666066f3e4cf51a469ccaa04dfbf5e6955

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/docs/index.asciidoc

@@ -2,7 +2,7 @@ ifdef::env-github[]
 NOTE: For the best reading experience, please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co]
 endif::[]
 
-= APM Ruby Agent Reference (Alpha)
+= APM Ruby Agent Reference (Beta)
 
 == Introduction
 

data/lib/elastic_apm.rb

@@ -12,7 +12,6 @@ require 'elastic_apm/instrumenter'
 require 'elastic_apm/internal_error'
 require 'elastic_apm/util'
 
-# Metrics
 require 'elastic_apm/middleware'
 
 require 'elastic_apm/railtie' if defined?(::Rails::Railtie)
@@ -63,7 +62,10 @@ module ElasticAPM
   # @yield [Transaction] Optional block encapsulating transaction
   # @return [Transaction] Unless block given
   def self.transaction(name, type = nil, context: nil, &block)
-    return call_through(&block) unless agent
+    unless agent
+      return block_given? ? yield : nil
+    end
+
     agent.transaction(name, type, context: context, &block)
   end
 
@@ -76,7 +78,9 @@ module ElasticAPM
   # @return [Span] Unless block given
   def self.span(name, type = nil, context: nil, include_stacktrace: true,
     &block)
-    return call_through(&block) unless agent
+    unless agent
+      return block_given? ? yield : nil
+    end
 
     agent.span(
       name,
@@ -155,16 +159,4 @@ module ElasticAPM
 
     agent && agent.add_filter(key, block || callback)
   end
-
-  class << self
-    private
-
-    def call_through
-      unless agent
-        return yield if block_given?
-      end
-
-      nil
-    end
-  end
 end

data/lib/elastic_apm/agent.rb

@@ -99,6 +99,7 @@ module ElasticAPM
     def enqueue_transactions(transactions)
       data = @serializers.transactions.build_all(transactions)
       @queue << Worker::Request.new('/v1/transactions', data)
+      transactions
     end
 
     def enqueue_errors(errors)

data/lib/elastic_apm/config.rb

@@ -10,20 +10,32 @@ module ElasticAPM
       server_url: 'http://localhost:8200',
       secret_token: nil,
 
-      app_name: nil,
-      environment: nil,
+      service_name: nil,
+      service_version: nil,
+      environment: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       framework_name: nil,
       framework_version: nil,
+      hostname: nil,
 
       log_path: '-',
       log_level: Logger::INFO,
       logger: nil,
 
+      max_queue_size: 500,
+      flush_interval: 10,
+      transaction_sample_rate: 1.0,
+      transaction_max_spans: 500,
+
       http_timeout: 10,
       http_open_timeout: 10,
-      transaction_send_interval: 10,
       debug_transactions: false,
       debug_http: false,
+      verify_server_cert: true,
+
+      source_lines_error_app_frames: 5,
+      source_lines_span_app_frames: 5,
+      source_lines_error_library_frames: 0,
+      source_lines_span_library_frames: 0,
 
       enabled_injectors: %w[net_http json],
 
@@ -36,52 +48,72 @@ module ElasticAPM
     }.freeze
 
     ENV_TO_KEY = {
-      'ELASTIC_APM_APP_NAME' => 'app_name',
       'ELASTIC_APM_SERVER_URL' => 'server_url',
-      'ELASTIC_APM_SECRET_TOKEN' => 'secret_token'
+      'ELASTIC_APM_SECRET_TOKEN' => 'secret_token',
+
+      'ELASTIC_APM_SERVICE_NAME' => 'service_name',
+      'ELASTIC_APM_SERVICE_VERSION' => 'service_version',
+      'ELASTIC_APM_ENVIRONMENT' => 'environment',
+      'ELASTIC_APM_FRAMEWORK_NAME' => 'framework_name',
+      'ELASTIC_APM_FRAMEWORK_VERSION' => 'framework_version',
+      'ELASTIC_APM_HOSTNAME' => 'hostname',
+
+      'ELASTIC_APM_SOURCE_LINES_ERROR_APP_FRAMES' =>
+        [:int, 'source_lines_error_app_frames'],
+      'ELASTIC_APM_SOURCE_LINES_SPAN_APP_FRAMES' =>
+        [:int, 'source_lines_span_app_frames'],
+      'ELASTIC_APM_SOURCE_LINES_ERROR_LIBRARY_FRAMES' =>
+        [:int, 'source_lines_error_library_frames'],
+      'ELASTIC_APM_SOURCE_LINES_SPAN_LIBRARY_FRAMES' =>
+        [:int, 'source_lines_span_library_frames'],
+
+      'ELASTIC_APM_MAX_QUEUE_SIZE' => [:int, 'max_queue_size'],
+      'ELASTIC_APM_FLUSH_INTERVAL' => 'flush_interval',
+      'ELASTIC_APM_TRANSACTION_SAMPLE_RATE' =>
+        [:float, 'transaction_sample_rate'],
+      'ELASTIC_APM_VERIFY_SERVER_CERT' => [:bool, 'verify_server_cert'],
+      'ELASTIC_APM_TRANSACTION_MAX_SPANS' => [:int, 'transaction_max_spans']
     }.freeze
 
-    # rubocop:disable Metrics/MethodLength
     def initialize(options = nil)
       options = {} if options.nil?
 
-      # Start with the defaults
-      DEFAULTS.each do |key, value|
-        send("#{key}=", value)
-      end
-
-      # Set options from ENV
-      ENV_TO_KEY.each do |env_key, key|
-        next unless (value = ENV[env_key])
-        send("#{key}=", value)
-      end
-
-      # Set options from arguments
-      options.each do |key, value|
-        send("#{key}=", value)
-      end
+      set_defaults
+      set_from_env
+      set_from_args(options)
 
       yield self if block_given?
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_accessor :server_url
     attr_accessor :secret_token
 
-    attr_accessor :app_name
-    attr_reader   :environment
+    attr_accessor :service_name
+    attr_accessor :service_version
+    attr_accessor :environment
     attr_accessor :framework_name
     attr_accessor :framework_version
+    attr_accessor :hostname
 
     attr_accessor :log_path
     attr_accessor :log_level
 
+    attr_accessor :max_queue_size
+    attr_accessor :flush_interval
+    attr_accessor :transaction_sample_rate
+    attr_accessor :transaction_max_spans
+    attr_accessor :verify_server_cert
+
     attr_accessor :http_timeout
     attr_accessor :http_open_timeout
-    attr_accessor :transaction_send_interval
     attr_accessor :debug_transactions
     attr_accessor :debug_http
 
+    attr_accessor :source_lines_error_app_frames
+    attr_accessor :source_lines_span_app_frames
+    attr_accessor :source_lines_error_library_frames
+    attr_accessor :source_lines_span_library_frames
+
     attr_accessor :enabled_injectors
 
     attr_accessor :view_paths
@@ -94,28 +126,19 @@ module ElasticAPM
 
     attr_reader   :logger
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    alias :verify_server_cert? :verify_server_cert
+
     def app=(app)
       case app_type?(app)
       when :sinatra
-        self.app_name = format_name(app_name || app.to_s)
-        self.framework_name = 'Sinatra'
-        self.framework_version = Sinatra::VERSION
-        self.enabled_injectors += %w[sinatra]
-        self.root_path = Dir.pwd
+        set_sinatra(app)
       when :rails
-        self.app_name = format_name(app_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
+        set_rails(app)
       else
         # TODO: define custom?
-        self.app_name = 'ruby'
+        self.service_name = 'ruby'
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def app_type?(app)
       if defined?(::Rails) && app.is_a?(Rails::Application)
@@ -133,16 +156,61 @@ module ElasticAPM
       server_url.start_with?('https')
     end
 
-    def environment=(env)
-      @environment = env || ENV['RAILS_ENV'] || ENV['RACK_ENV']
-    end
-
     def logger=(logger)
       @logger = logger || build_logger(log_path, log_level)
     end
 
     private
 
+    def set_defaults
+      DEFAULTS.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def set_from_env
+      ENV_TO_KEY.each do |env_key, key|
+        next unless (value = ENV[env_key])
+
+        type, key = key if key.is_a? Array
+
+        value =
+          case type
+          when :int then value.to_i
+          when :float then value.to_f
+          when :bool then !%w[0 false].include?(value.strip.downcase)
+          else value
+          end
+
+        send("#{key}=", value)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def set_from_args(options)
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def set_sinatra(app)
+      self.service_name = format_name(service_name || app.to_s)
+      self.framework_name = framework_name || 'Sinatra'
+      self.framework_version = framework_version || Sinatra::VERSION
+      self.enabled_injectors += %w[sinatra]
+      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
+      self.root_path = Rails.root.to_s
+      self.view_paths = app.config.paths['app/views'].existent
+    end
+
     def build_logger(path, level)
       logger = Logger.new(path == '-' ? STDOUT : path)
       logger.level = level

data/lib/elastic_apm/error_builder.rb

@@ -34,7 +34,7 @@ module ElasticAPM
     private
 
     def add_stacktrace(error, kind, backtrace)
-      return unless (stacktrace = Stacktrace.build(@config, backtrace))
+      return unless (stacktrace = Stacktrace.build(@config, backtrace, :error))
 
       case kind
       when :exception

data/lib/elastic_apm/http.rb

@@ -91,6 +91,7 @@ module ElasticAPM
 
       http = Net::HTTP.new server_uri.host, server_uri.port
       http.use_ssl = @config.use_ssl?
+      http.verify_mode = verify_mode
       http.read_timeout = @config.http_timeout
       http.open_timeout = @config.http_open_timeout
 
@@ -104,5 +105,13 @@ module ElasticAPM
     def server_uri
       @uri ||= URI(@config.server_url)
     end
+
+    def verify_mode
+      if @config.use_ssl? && @config.verify_server_cert?
+        OpenSSL::SSL::VERIFY_PEER
+      else
+        OpenSSL::SSL::VERIFY_NONE
+      end
+    end
   end
 end

data/lib/elastic_apm/instrumenter.rb

@@ -64,6 +64,14 @@ module ElasticAPM
         return transaction
       end
 
+      sample = rand <= config.transaction_sample_rate
+
+      if args.last.is_a? Hash
+        args.last[:sampled] = sample
+      else
+        args.push(sampled: sample)
+      end
+
       transaction = Transaction.new self, *args
 
       self.current_transaction = transaction
@@ -108,7 +116,11 @@ module ElasticAPM
     end
 
     def should_flush_transactions?
-      return true unless (interval = config.transaction_send_interval)
+      interval = config.flush_interval
+
+      return true if interval.nil?
+      return true if @pending_transactions.length >= config.max_queue_size
+
       Time.now.utc - @last_sent_transactions >= interval
     end
 

data/lib/elastic_apm/process_info.rb

@@ -8,9 +8,11 @@ module ElasticAPM
     end
 
     def build
+      pid = $PID || Process.pid
+      return unless pid
       {
         argv: ARGV,
-        pid: $PID,
+        pid: pid,
         title: $PROGRAM_NAME
       }
     end

data/lib/elastic_apm/serializers/transactions.rb

@@ -6,7 +6,7 @@ module ElasticAPM
     class Transactions < Serializer
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def build(transaction)
-        {
+        base = {
           id: transaction.id,
           name: transaction.name,
           type: transaction.type,
@@ -17,6 +17,12 @@ module ElasticAPM
           sampled: transaction.sampled,
           context: transaction.context.to_h
         }
+
+        if transaction.dropped_spans > 0
+          base[:span_count] = { dropped: { total: transaction.dropped_spans } }
+        end
+
+        base
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 

data/lib/elastic_apm/service_info.rb

@@ -10,7 +10,7 @@ module ElasticAPM
     # rubocop:disable Metrics/MethodLength
     def build
       base = {
-        name: @config.app_name,
+        name: @config.service_name,
         environment: @config.environment,
         agent: {
           name: 'ruby',
@@ -22,7 +22,7 @@ module ElasticAPM
           version: RUBY_VERSION
         },
         runtime: runtime,
-        version: git_sha
+        version: @config.service_version || Util.git_sha
       }
 
       if @config.framework_name
@@ -42,13 +42,6 @@ module ElasticAPM
 
     private
 
-    def git_sha
-      sha = `git rev-parse --verify HEAD 2>&1`.chomp
-      return sha if $?.success? # rubocop:disable Style/SpecialGlobalVars
-
-      nil
-    end
-
     def runtime
       case RUBY_ENGINE
       when 'ruby'

data/lib/elastic_apm/stacktrace.rb

@@ -14,17 +14,17 @@ module ElasticAPM
 
     attr_reader :frames
 
-    def self.build(config, backtrace)
+    def self.build(config, backtrace, type)
       return nil unless backtrace
 
       stack = new(backtrace)
-      stack.build_frames(config)
+      stack.build_frames(config, type)
       stack
     end
 
-    def build_frames(config)
+    def build_frames(config, type)
       @frames = @backtrace.map do |line|
-        build_frame(config, line)
+        build_frame(config, line, type)
       end
     end
 
@@ -56,20 +56,24 @@ module ElasticAPM
       [file, number, method, module_name]
     end
 
-    def build_frame(config, line)
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def build_frame(config, line, type)
       abs_path, lineno, function, _module_name = parse_line(line)
+      library_frame = !(abs_path && abs_path.start_with?(config.root_path))
 
       frame = Frame.new
       frame.abs_path = abs_path
       frame.filename = strip_load_path(abs_path)
       frame.function = function
       frame.lineno = lineno.to_i
-      frame.build_context 3
-      frame.library_frame =
-        !(abs_path && abs_path.start_with?(config.root_path))
+      frame.library_frame = library_frame
+
+      line_count = context_lines_for(config, type, library_frame: library_frame)
+      frame.build_context line_count
 
       frame
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def strip_load_path(path)
       return nil unless path
@@ -85,5 +89,10 @@ module ElasticAPM
 
       path[prefix.chomp(File::SEPARATOR).length + 1..-1]
     end
+
+    def context_lines_for(config, type, library_frame:)
+      key = "source_lines_#{type}_#{library_frame ? 'library' : 'app'}_frames"
+      config.send(key.to_sym)
+    end
   end
 end

data/lib/elastic_apm/stacktrace/frame.rb

@@ -20,17 +20,20 @@ module ElasticAPM
         :colno
       )
 
+      # rubocop:disable Metrics/AbcSize
       def build_context(context_line_count)
-        return unless abs_path
+        return unless abs_path && context_line_count > 0
 
-        from = (lineno - context_line_count - 1)
-        to = (lineno + context_line_count)
+        padding = (context_line_count - 1) / 2
+        from = lineno - padding - 1
+        to = lineno + padding - 1
         file_lines = read_lines(abs_path, from..to)
 
-        self.context_line = file_lines[context_line_count]
-        self.pre_context  = file_lines.first(context_line_count)
-        self.post_context = file_lines.last(context_line_count)
+        self.context_line = file_lines[padding]
+        self.pre_context  = file_lines.first(padding)
+        self.post_context = file_lines.last(padding)
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 

data/lib/elastic_apm/system_info.rb

@@ -3,11 +3,13 @@
 module ElasticAPM
   # @api private
   class SystemInfo
-    def initialize(_config); end
+    def initialize(config)
+      @config = config
+    end
 
     def build
       {
-        hostname: `hostname`,
+        hostname: @config.hostname || `hostname`,
         architecture: platform.cpu,
         platform: platform.os
       }

data/lib/elastic_apm/transaction.rb

@@ -4,7 +4,13 @@ module ElasticAPM
   # @api private
   class Transaction
     # rubocop:disable Metrics/MethodLength
-    def initialize(instrumenter, name, type = 'custom', context: nil)
+    def initialize(
+      instrumenter,
+      name,
+      type = 'custom',
+      context: nil,
+      sampled: true
+    )
       @id = SecureRandom.uuid
       @instrumenter = instrumenter
       @name = name
@@ -13,22 +19,22 @@ module ElasticAPM
       @timestamp = Util.micros
 
       @spans = []
-      @notifications = []
       @span_id_ticker = -1
+      @dropped_spans = 0
 
       @notifications = [] # for AS::Notifications
 
       @context = context || Context.new
 
-      @sampled = true
+      @sampled = sampled
 
       yield self if block_given?
     end
     # rubocop:enable Metrics/MethodLength
 
     attr_accessor :id, :name, :result, :type
-    attr_reader :context, :duration, :root_span, :timestamp, :spans,
-      :notifications, :sampled, :instrumenter
+    attr_reader :context, :duration, :dropped_spans, :root_span, :timestamp,
+      :spans, :notifications, :sampled, :instrumenter
 
     def release
       @instrumenter.current_transaction = nil
@@ -63,13 +69,19 @@ module ElasticAPM
 
     # rubocop:disable Metrics/MethodLength
     def span(name, type = nil, backtrace: nil, context: nil)
-      span = next_span(name, type, context)
-      spans << span
+      unless sampled?
+        return yield if block_given?
+        return
+      end
 
-      span.stacktrace =
-        backtrace && Stacktrace.build(@instrumenter.config, backtrace)
+      if spans.length >= instrumenter.config.transaction_max_spans
+        @dropped_spans += 1
 
-      span.start
+        return yield if block_given?
+        return
+      end
+
+      span = build_and_start_span(name, type, context, backtrace)
 
       return span unless block_given?
 
@@ -83,10 +95,24 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
+    def build_and_start_span(name, type, context, backtrace)
+      span = next_span(name, type, context)
+      spans << span
+
+      span.stacktrace =
+        backtrace && Stacktrace.build(@instrumenter.config, backtrace, :span)
+
+      span.start
+    end
+
     def current_span
       spans.reverse.lazy.find(&:running?)
     end
 
+    def sampled?
+      !!sampled
+    end
+
     def inspect
       "<ElasticAPM::Transaction id:#{id}>"
     end

data/lib/elastic_apm/util.rb

@@ -14,6 +14,11 @@ module ElasticAPM
     def self.inspect_transaction(transaction)
       Inspector.new.transaction transaction
     end
+
+    def self.git_sha
+      sha = `git rev-parse --verify HEAD 2>&1`.chomp
+      $? && $?.success? ? sha : nil # rubocop:disable Style/SpecialGlobalVars
+    end
   end
 end
 

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"