elastic-apm 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0d3d869c607c4a439fb2c19ae77c35572cadf74f34f6bb4c2075e393a00127
-  data.tar.gz: a126c14da9817c69b4b76ba17bd12521d865ea2b791b59ff978d0fa6bbafa256
+  metadata.gz: f6272279575b41ace4dc7581df1d6ea387f46c260d591c338fceb256f0b46ff2
+  data.tar.gz: f793a0c902a18abfe647e5a3a41c86d96926910dfef21094aa3b1c37deac45eb
 SHA512:
-  metadata.gz: c4951d4fce0cb88c5cb45006a24f272156785d2bf9558ce93b84b2756a178957dbb75149bf6a529e018845f626cdf581721750131227f095e09e06ed228ba208
-  data.tar.gz: 66407124c6987fffc19a0340a57cf781dc8655ca7385da04d3ebc08f4c1342195b7dce0b0c0e87ebbc1f79e81ec60697556fe1dfae7630ff9b893d8edd7c3edf
+  metadata.gz: 3f16cbdffc10a05005c03ec0d122235c84b56a9bda9f2201fd913e1d3b96925d3f5ef0847cfd2cc369da0b1d1c39c21dccd187579f278d7439218c97b4548a97
+  data.tar.gz: 4daea6a3d579f4fba6435de9277bdd842889b6afeab63c97da9a9424809d6e4721bd873da4edecae1eeb66281ae43989385027099f0c828a38bff94c4ec3addd

data/.rubocop.yml

@@ -21,6 +21,10 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
 Naming/PredicateName:
   Enabled: false
 

data/README.md

@@ -1,57 +1,25 @@
-# elastic-apm – Elastic APM agent for Ruby (ALPHA)
+# elastic-apm – Elastic APM agent for Ruby (BETA)
 
 [![Jenkins](https://img.shields.io/jenkins/s/https/apm-ci.elastic.co/job/elastic+apm-agent-ruby+master.svg)](https://apm-ci.elastic.co/job/elastic+apm-agent-ruby+master/) [![Gem](https://img.shields.io/gem/v/formatador.svg?style=flat-square)](https://rubygems.org/gems/elastic-apm)
 
 This is the official Rubygem for adding [Elastic][]'s [APM][] to your Ruby app.
 
-## Setup
-
-Add the gem to your `Gemfile`:
-
-```ruby
-gem 'elastic-apm'
-```
-
-## Getting started with Rails
-
-If you're using Rails the gem automatically inserts itself where it needs to be.
-
-_Describe configuration using yaml, config, etc_
-
-### Optional: Configure the agent
-
-The suggested way to configure is to create a file `config/elastic_apm.yml` with your config:
-
-```yaml
-# config/elastic_apm.yml
-
-server_url: http://localhost:8200
-secret_token: YOUR_SECRET
-```
-
-## Getting started with Sinatra
-
-```ruby
-# config.ru
-
-require 'sinatra/base'
-
-class MySinatraApp < Sinatra::Base
-  use ElasticAPM::Middleware
-  
-  # ...
-end
-
-# Takes optional ElasticAPM::Config values
-ElasticAPM.start(
-  app: MySinatraApp, # required
-  server_url: 'http://localhost:8200'
-)
-
-run MySinatraApp
-
-at_exit { ElasticAPM.stop }
-```
+<div>
+<ul>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/_introduction.html">Introduction</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/getting-started-rails.html">Getting started with Rails</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/getting-started-rack.html">Getting started with Rack</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/configuration.html">Configuration</a></li>
+<li class="collapsible">
+<a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/advanced.html">Advanced Topics</a>
+<ul>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/custom-instrumentation.html">Custom instrumentation</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/injectors.html">Injectors — automatic integrations with third-party libraries</a></li>
+</ul>
+</li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/api.html">Public API</a></li>
+</ul>
+</div>
 
 # License
 

data/docs/api.asciidoc

@@ -44,6 +44,7 @@ Returns whether the ElasticAPM Agent is currently running.
 
 Returns the currently running agent or nil.
 
+[float]
 === Instrumentation
 
 [float]
@@ -119,6 +120,7 @@ Arguments:
 
 Returns the built context.
 
+[float]
 === Errors
 
 [float]
@@ -165,6 +167,7 @@ Arguments:
 
 Returns `[ElasticAPM::Error]`.
 
+[float]
 === Context
 
 [float]
@@ -208,3 +211,15 @@ Arguments:
 
 Returns current custom context.
 
+[float]
+[[api-set-user]]
+==== `ElasticAPM.set_user`
+
+Add the current user to the current transaction's context.
+
+Arguments:
+
+  * `user`: An object representing the user
+
+Returns the given user
+

data/docs/configuration.asciidoc

@@ -3,6 +3,7 @@
 
 There are several ways to shape how Elastic APM behaves.
 
+[float]
 === Rails
 
 The recommended way to configure Elastic APM for Rails is to create a file `config/elastic_apm.yml` and specify options in there:
@@ -14,6 +15,7 @@ server_url: 'http://localhost:8200'
 secret_token: 'very_very_secret'
 ----
 
+[float]
 === Sinatra and Rack
 
 When using APM with Sinatra and Rack, you should configure it when starting the agent:

data/docs/context.asciidoc

@@ -1,6 +1,8 @@
+[float]
 [[context]]
 === Adding additional context
 
+[float]
 ==== Adding custom context
 
 You can add your own custom, nested JSON-compatible data to the current transaction using `ElasticAPM.add_custom_context(hash)` eg.:
@@ -16,6 +18,7 @@ class ThingsController < ApplicationController
 end
 ----
 
+[float]
 ==== Adding tags
 
 Tags are special in that they are indexed in your Elasticsearch database and therefore searchable.
@@ -25,3 +28,16 @@ Tags are special in that they are indexed in your Elasticsearch database and the
 ElasticAPM.set_tag(:company_name, 'Acme, Inc.')
 ----
 
+[float]
+==== Providing info about the user
+
+You can provide ElasticAPM with info about the current user.
+
+[source,ruby]
+----
+class ApplicationController < ActionController::Base
+  before_action do
+    current_user && ElasticAPM.set_user(current_user)
+  end
+end
+----

data/docs/getting-started-rails.asciidoc

@@ -1,6 +1,7 @@
 [[getting-started-rails]]
 == Getting started with Rails
 
+[float]
 === Setup
 
 Add the gem to your `Gemfile`:

data/lib/elastic_apm.rb

@@ -2,6 +2,7 @@
 
 require 'elastic_apm/version'
 require 'elastic_apm/log'
+require 'elastic_apm/util/dig'
 
 # Core
 require 'elastic_apm/agent'
@@ -73,9 +74,17 @@ module ElasticAPM
   # @param context [Span::Context] Context information about the span
   # @yield [Span] Optional block encapsulating span
   # @return [Span] Unless block given
-  def self.span(name, type = nil, context: nil, &block)
+  def self.span(name, type = nil, context: nil, include_stacktrace: true,
+    &block)
     return call_through(&block) unless agent
-    agent.span(name, type, context: context, &block)
+
+    agent.span(
+      name,
+      type,
+      context: context,
+      backtrace: include_stacktrace ? caller : nil,
+      &block
+    )
   end
 
   # Build a [Context] from a Rack `env`. The context may include information
@@ -125,6 +134,28 @@ module ElasticAPM
     agent && agent.set_custom_context(custom)
   end
 
+  # Provide a user to the current transaction
+  #
+  # @param user [Object] An object representing a user
+  # @return [Object] Given user
+  def self.set_user(user)
+    agent && agent.set_user(user)
+  end
+
+  # Provide a filter to transform payloads before sending them off
+  #
+  # @param key [Symbol] Unique filter key
+  # @param callback [Object, Proc] A filter that responds to #call(payload)
+  # @yield [Hash] A filter. Will be used if provided. Otherwise using `callback`
+  # @return [Bool] true
+  def self.add_filter(key, callback = nil, &block)
+    if callback.nil? && !block_given?
+      raise ArgumentError, '#add_filter needs either `callback\' or a block'
+    end
+
+    agent && agent.add_filter(key, block || callback)
+  end
+
   class << self
     private
 

data/lib/elastic_apm/agent.rb

@@ -28,7 +28,8 @@ module ElasticAPM
 
       LOCK.synchronize do
         return @instance if @instance
-        @instance = new(config).start
+
+        @instance = new(config.freeze).start
       end
     end
 
@@ -45,11 +46,13 @@ module ElasticAPM
       !!@instance
     end
 
+    # rubocop:disable Metrics/MethodLength
     def initialize(config)
       config = Config.new(config) if config.is_a?(Hash)
 
       @config = config
 
+      @http = Http.new(config)
       @queue = Queue.new
 
       @instrumenter = Instrumenter.new(config, self)
@@ -61,8 +64,9 @@ module ElasticAPM
         Serializers::Errors.new(config)
       )
     end
+    # rubocop:enable Metrics/MethodLength
 
-    attr_reader :config, :queue, :instrumenter, :context_builder
+    attr_reader :config, :queue, :instrumenter, :context_builder, :http
 
     def start
       debug 'Starting agent reporting to %s', config.server_url
@@ -150,6 +154,14 @@ module ElasticAPM
       instrumenter.set_custom_context(*args)
     end
 
+    def set_user(*args)
+      instrumenter.set_user(*args)
+    end
+
+    def add_filter(key, callback)
+      @http.filters.add(key, callback)
+    end
+
     def inspect
       '<ElasticAPM::Agent>'
     end
@@ -160,7 +172,7 @@ module ElasticAPM
       debug 'Booting worker in thread'
 
       @worker_thread = Thread.new do
-        Worker.new(@config, @queue).run_forever
+        Worker.new(@config, @queue, @http).run_forever
       end
     end
 

data/lib/elastic_apm/config.rb

@@ -3,6 +3,7 @@
 require 'logger'
 
 module ElasticAPM
+  # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
     DEFAULTS = {
@@ -16,50 +17,67 @@ module ElasticAPM
 
       log_path: '-',
       log_level: Logger::INFO,
+      logger: nil,
 
-      timeout: 10,
-      open_timeout: 10,
+      http_timeout: 10,
+      http_open_timeout: 10,
       transaction_send_interval: 10,
       debug_transactions: false,
       debug_http: false,
 
-      enabled_injectors: %w[net_http],
+      enabled_injectors: %w[net_http json],
 
-      current_user_method: :current_user,
       current_user_id_method: :id,
       current_user_email_method: :email,
       current_user_username_method: :username,
 
-      view_paths: []
+      view_paths: [],
+      root_path: Dir.pwd
     }.freeze
 
-    LOCK = Mutex.new
+    ENV_TO_KEY = {
+      'ELASTIC_APM_APP_NAME' => 'app_name',
+      'ELASTIC_APM_SERVER_URL' => 'server_url',
+      'ELASTIC_APM_SECRET_TOKEN' => 'secret_token'
+    }.freeze
 
+    # rubocop:disable Metrics/MethodLength
     def initialize(options = nil)
       options = {} if options.nil?
 
-      DEFAULTS.merge(options).each do |key, value|
+      # Start with the defaults
+      DEFAULTS.each do |key, value|
         send("#{key}=", value)
       end
 
-      return unless block_given?
+      # 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
 
-      yield self
+      yield self if block_given?
     end
+    # rubocop:enable Metrics/MethodLength
 
     attr_accessor :server_url
     attr_accessor :secret_token
 
     attr_accessor :app_name
-    attr_writer :environment
+    attr_reader   :environment
     attr_accessor :framework_name
     attr_accessor :framework_version
 
     attr_accessor :log_path
     attr_accessor :log_level
 
-    attr_accessor :timeout
-    attr_accessor :open_timeout
+    attr_accessor :http_timeout
+    attr_accessor :http_open_timeout
     attr_accessor :transaction_send_interval
     attr_accessor :debug_transactions
     attr_accessor :debug_http
@@ -67,13 +85,14 @@ module ElasticAPM
     attr_accessor :enabled_injectors
 
     attr_accessor :view_paths
+    attr_accessor :root_path
 
     attr_accessor :current_user_method
     attr_accessor :current_user_id_method
     attr_accessor :current_user_email_method
     attr_accessor :current_user_username_method
 
-    attr_writer :logger
+    attr_reader   :logger
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def app=(app)
@@ -82,11 +101,14 @@ module ElasticAPM
         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
       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
       else
         # TODO: define custom?
@@ -107,19 +129,16 @@ module ElasticAPM
       nil
     end
 
-    def environment
-      @environment ||= ENV['RAILS_ENV'] || ENV['RACK_ENV']
+    def use_ssl?
+      server_url.start_with?('https')
     end
 
-    def logger
-      @logger ||=
-        LOCK.synchronize do
-          build_logger(log_path, log_level)
-        end
+    def environment=(env)
+      @environment = env || ENV['RAILS_ENV'] || ENV['RACK_ENV']
     end
 
-    def use_ssl?
-      server_url.start_with?('https')
+    def logger=(logger)
+      @logger = logger || build_logger(log_path, log_level)
     end
 
     private
@@ -134,4 +153,5 @@ module ElasticAPM
       str.gsub('::', '_')
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/elastic_apm/context_builder.rb

@@ -3,20 +3,11 @@
 module ElasticAPM
   # @api private
   class ContextBuilder
-    CONTROLLER_KEY = 'action_controller.instance'.freeze
-
-    def initialize(config)
-      @config = config
-    end
-
-    attr_reader :config
+    def initialize(_config); end
 
     def build(rack_env)
       context = Context.new
-
       apply_to_request(context, rack_env)
-      apply_to_user(context, rack_env)
-
       context
     end
 
@@ -40,18 +31,6 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/AbcSize
 
-    def apply_to_user(context, rack_env)
-      return unless (controller = rack_env[CONTROLLER_KEY])
-
-      method = config.current_user_method.to_sym
-      return unless controller.respond_to?(method)
-
-      return unless (record = controller.send method)
-
-      context.user = Context::User.new(config, record)
-      context
-    end
-
     def get_body(req)
       return req.POST if req.form_data?
 

data/lib/elastic_apm/error_builder.rb

@@ -7,8 +7,6 @@ module ElasticAPM
       @config = config
     end
 
-    attr_reader :config
-
     def build_exception(exception, handled: true)
       error = Error.new
       error.exception = Error::Exception.new(exception, handled: handled)
@@ -36,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))
 
       case kind
       when :exception
@@ -45,7 +43,7 @@ module ElasticAPM
         error.log.stacktrace = stacktrace
       end
 
-      error.culprit = stacktrace.frames.last.function
+      error.culprit = stacktrace.frames.first.function
     end
 
     def add_transaction_id(error)

data/lib/elastic_apm/filters.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/filters/request_body_filter'
+require 'elastic_apm/filters/secrets_filter'
+
+module ElasticAPM
+  # @api private
+  module Filters
+    def self.new(config)
+      Container.new(config)
+    end
+
+    # @api private
+    class Container
+      def initialize(config)
+        @config = config
+        @filters = {
+          request_body: RequestBodyFilter.new(config),
+          secrets: SecretsFilter.new(config)
+        }
+      end
+
+      attr_reader :config
+
+      def add(key, filter)
+        @filters[key] = filter
+      end
+
+      def remove(key)
+        @filters.delete(key)
+      end
+
+      def apply(payload)
+        @filters.reduce(payload) do |result, (_key, filter)|
+          filter.call(result)
+        end
+      end
+
+      def length
+        @filters.length
+      end
+    end
+  end
+end

data/lib/elastic_apm/filters/request_body_filter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Filters
+    # @api private
+    class RequestBodyFilter
+      FILTERED = '[FILTERED]'.freeze
+
+      def initialize(config)
+        @config = config
+      end
+
+      def call(payload)
+        strip_body_from payload[:transactions]
+        strip_body_from payload[:errors]
+
+        payload
+      end
+
+      private
+
+      def strip_body_from(arr)
+        return unless arr
+
+        arr.each do |entity|
+          next unless (request = entity.dig(:context, :request))
+
+          request[:body] = FILTERED
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/filters/secrets_filter.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Filters
+    # @api private
+    class SecretsFilter
+      FILTERED = '[FILTERED]'.freeze
+
+      KEY_FILTERS = [
+        /passw(or)?d/i,
+        /^pw$/,
+        /secret/i,
+        /token/i,
+        /api[-._]?key/i,
+        /session[-._]?id/i
+      ].freeze
+
+      VALUE_FILTERS = [
+        /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/ # (probably) credit card number
+      ].freeze
+
+      def initialize(config)
+        @config = config
+      end
+
+      def call(payload)
+        strip_from payload[:transactions], :context, :request, :headers
+        strip_from payload[:transactions], :context, :response, :headers
+        strip_from payload[:errors], :context, :request, :headers
+        strip_from payload[:errors], :context, :response, :headers
+
+        payload
+      end
+
+      def strip_from(events, *path)
+        return unless events
+
+        events.each do |event|
+          next unless (headers = event.dig(*path))
+
+          headers.each do |k, v|
+            if filter_key?(k) || filter_value?(v)
+              headers[k] = FILTERED
+            end
+          end
+        end
+      end
+
+      def filter_key?(key)
+        KEY_FILTERS.any? { |regex| key =~ regex }
+      end
+
+      def filter_value?(value)
+        VALUE_FILTERS.any? { |regex| value =~ regex }
+      end
+    end
+  end
+end

data/lib/elastic_apm/http.rb

@@ -5,6 +5,7 @@ require 'net/http'
 require 'elastic_apm/service_info'
 require 'elastic_apm/system_info'
 require 'elastic_apm/process_info'
+require 'elastic_apm/filters'
 
 module ElasticAPM
   # @api private
@@ -23,12 +24,14 @@ module ElasticAPM
         process: ProcessInfo.build(config),
         system: SystemInfo.build(config)
       }
+      @filters = Filters.new(config)
     end
 
-    attr_reader :config
+    attr_reader :filters
 
     def post(path, payload = {})
       payload.merge! @base_payload
+      filters.apply(payload)
       request = prepare_request path, payload.to_json
       response = @adapter.perform request
 
@@ -50,7 +53,7 @@ module ElasticAPM
         req['User-Agent'] = USER_AGENT
         req['Content-Length'] = data.bytesize.to_s
 
-        if (token = config.secret_token)
+        if (token = @config.secret_token)
           req['Authorization'] = "Bearer #{token}"
         end
 
@@ -88,8 +91,8 @@ module ElasticAPM
 
       http = Net::HTTP.new server_uri.host, server_uri.port
       http.use_ssl = @config.use_ssl?
-      http.read_timeout = @config.timeout
-      http.open_timeout = @config.open_timeout
+      http.read_timeout = @config.http_timeout
+      http.open_timeout = @config.http_open_timeout
 
       if @config.debug_http
         http.set_debug_output(@config.logger)

data/lib/elastic_apm/instrumenter.rb

@@ -32,7 +32,7 @@ module ElasticAPM
 
       @transaction_info = TransactionInfo.new
 
-      @subscriber = subscriber_class.new(self)
+      @subscriber = subscriber_class.new(config)
 
       @pending_transactions = []
       @last_sent_transactions = Time.now.utc
@@ -92,6 +92,10 @@ module ElasticAPM
       transaction.context.custom.merge!(context)
     end
 
+    def set_user(user)
+      transaction.context.user = Context::User.new(config, user)
+    end
+
     def submit_transaction(transaction)
       @pending_transactions << transaction
 

data/lib/elastic_apm/log.rb

@@ -26,12 +26,14 @@ module ElasticAPM
     end
 
     def log(lvl, msg, *args)
+      return unless logger
+
       formatted_msg = prepend_prefix(format(msg.to_s, *args))
 
-      return config.logger.send(lvl, formatted_msg) unless block_given?
+      return logger.send(lvl, formatted_msg) unless block_given?
 
       # TODO: dont evaluate block if level is higher
-      config.logger.send(lvl, "#{formatted_msg}\n#{yield}")
+      logger.send(lvl, "#{formatted_msg}\n#{yield}")
     end
 
     private
@@ -40,8 +42,9 @@ module ElasticAPM
       "#{PREFIX}#{str}"
     end
 
-    def has_logger?
-      respond_to?(:config) && config.logger
+    def logger
+      return false unless (config = instance_variable_get(:@config))
+      config.logger
     end
   end
 end

data/lib/elastic_apm/middleware.rb

@@ -10,7 +10,7 @@ module ElasticAPM
     # rubocop:disable Metrics/MethodLength
     def call(env)
       begin
-        transaction = ElasticAPM.transaction 'Rack', type_for(env),
+        transaction = ElasticAPM.transaction 'Rack', 'app',
           context: ElasticAPM.build_context(env)
 
         resp = @app.call env
@@ -29,14 +29,5 @@ module ElasticAPM
       resp
     end
     # rubocop:enable Metrics/MethodLength
-
-    private
-
-    def type_for(env)
-      format(
-        'request.%s'.freeze,
-        env.fetch('REQUEST_METHOD'.freeze, 'unknown'.freeze)
-      )
-    end
   end
 end

data/lib/elastic_apm/serializers/transactions.rb

@@ -13,17 +13,7 @@ module ElasticAPM
           result: transaction.result.to_s,
           duration: ms(transaction.duration),
           timestamp: micros_to_time(transaction.timestamp).utc.iso8601,
-          spans: transaction.spans.map do |span|
-            {
-              id: span.id,
-              parent: span.parent && span.parent.id,
-              name: span.name,
-              type: span.type,
-              start: ms(span.relative_start),
-              duration: ms(span.duration),
-              context: span.context && { db: span.context.to_h }
-            }
-          end,
+          spans: transaction.spans.map(&method(:build_span)),
           sampled: transaction.sampled,
           context: transaction.context.to_h
         }
@@ -33,6 +23,23 @@ module ElasticAPM
       def build_all(transactions)
         { transactions: Array(transactions).map(&method(:build)) }
       end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      def build_span(span)
+        {
+          id: span.id,
+          parent: span.parent && span.parent.id,
+          name: span.name,
+          type: span.type,
+          start: ms(span.relative_start),
+          duration: ms(span.duration),
+          context: span.context && { db: span.context.to_h },
+          stacktrace: span.stacktrace.to_a
+        }
+      end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/elastic_apm/service_info.rb

@@ -7,13 +7,11 @@ module ElasticAPM
       @config = config
     end
 
-    attr_reader :config
-
     # rubocop:disable Metrics/MethodLength
     def build
       base = {
-        name: config.app_name,
-        environment: config.environment,
+        name: @config.app_name,
+        environment: @config.environment,
         agent: {
           name: 'ruby',
           version: VERSION
@@ -27,10 +25,10 @@ module ElasticAPM
         version: git_sha
       }
 
-      if config.framework_name
+      if @config.framework_name
         base[:framework] = {
-          name: config.framework_name,
-          version: config.framework_version
+          name: @config.framework_name,
+          version: @config.framework_version
         }
       end
 

data/lib/elastic_apm/span.rb

@@ -22,10 +22,11 @@ module ElasticAPM
       @type = type
       @parent = parent
       @context = context
+      @stacktrace = nil
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :context, :type
+    attr_accessor :name, :context, :type, :stacktrace
     attr_reader :id, :duration, :parent, :relative_start
 
     def start

data/lib/elastic_apm/sql_summarizer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'elastic_apm/util/lru_cache'
+
 module ElasticAPM
   # @api private
   class SqlSummarizer
@@ -10,15 +12,17 @@ module ElasticAPM
       /^DELETE FROM ([^ ]+)/i => 'DELETE FROM '
     }.freeze
 
+    FORMAT = '%s%s'.freeze
+
     def self.cache
-      @cache ||= {}
+      @cache ||= Util::LruCache.new
     end
 
     def summarize(sql)
       self.class.cache[sql] ||=
         REGEXES.find do |regex, sig|
           if (match = sql.match(regex))
-            break format("#{sig}#{match[1]}")
+            break format(FORMAT, sig, match[1].gsub(/["']/, ''))
           end
         end
     end

data/lib/elastic_apm/stacktrace.rb

@@ -1,27 +1,30 @@
 # frozen_string_literal: true
 
 require 'elastic_apm/stacktrace/frame'
+require 'elastic_apm/stacktrace/line_cache'
 
 module ElasticAPM
   # @api private
   class Stacktrace
+    GEMS_REGEX = %r{/gems/}
+
     def initialize(backtrace)
       @backtrace = backtrace
     end
 
     attr_reader :frames
 
-    def self.build(builder, backtrace)
+    def self.build(config, backtrace)
       return nil unless backtrace
 
       stack = new(backtrace)
-      stack.build_frames(builder)
+      stack.build_frames(config)
       stack
     end
 
-    def build_frames(builder)
-      @frames = @backtrace.reverse.map do |line|
-        build_frame(builder, line)
+    def build_frames(config)
+      @frames = @backtrace.map do |line|
+        build_frame(config, line)
       end
     end
 
@@ -53,7 +56,7 @@ module ElasticAPM
       [file, number, method, module_name]
     end
 
-    def build_frame(_builder, line)
+    def build_frame(config, line)
       abs_path, lineno, function, _module_name = parse_line(line)
 
       frame = Frame.new
@@ -62,6 +65,8 @@ module ElasticAPM
       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
     end

data/lib/elastic_apm/stacktrace/frame.rb

@@ -14,30 +14,32 @@ module ElasticAPM
         :pre_context,
         :context_line,
         :post_context,
-        :in_app,
+        :library_frame,
         :lineno,
         :module,
         :colno
       )
 
-      # rubocop:disable Metrics/AbcSize
       def build_context(context_line_count)
         return unless abs_path
 
-        file_lines = [nil] + read_lines(abs_path)
+        from = (lineno - context_line_count - 1)
+        to = (lineno + context_line_count)
+        file_lines = read_lines(abs_path, from..to)
 
-        self.context_line = file_lines[lineno]
-        self.pre_context =
-          file_lines[(lineno - context_line_count - 1)...lineno]
-        self.post_context =
-          file_lines[(lineno + 1)..(lineno + context_line_count)]
+        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)
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 
-      def read_lines(path)
-        File.readlines(path)
+      def read_lines(path, range)
+        if (cached = LineCache.get(path, range))
+          return cached
+        end
+
+        LineCache.set(path, range, File.readlines(path)[range])
       rescue Errno::ENOENT
         []
       end

data/lib/elastic_apm/stacktrace/line_cache.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/util/lru_cache'
+
+module ElasticAPM
+  class Stacktrace
+    # A basic LRU Cache
+    # @api private
+    class LineCache
+      class << self
+        def cache
+          @cache ||= Util::LruCache.new
+        end
+
+        def get(*key)
+          cache[key]
+        end
+
+        def set(*key, value)
+          cache[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/subscriber.rb

@@ -8,14 +8,12 @@ module ElasticAPM
   class Subscriber
     include Log
 
-    def initialize(agent)
+    def initialize(config, agent: ElasticAPM)
+      @config = config
       @agent = agent
-      @config = agent.config
       @normalizers = Normalizers.build(config)
     end
 
-    attr_reader :config
-
     def register!
       unregister! if @subscription
 
@@ -43,7 +41,7 @@ module ElasticAPM
           nil
         else
           name, type, context = normalized
-          transaction.span(name, type, context: context)
+          @agent.span(name, type, context: context)
         end
 
       transaction.notifications << Notification.new(id, span)

data/lib/elastic_apm/system_info.rb

@@ -3,11 +3,7 @@
 module ElasticAPM
   # @api private
   class SystemInfo
-    def initialize(config)
-      @config = config
-    end
-
-    attr_reader :config
+    def initialize(_config); end
 
     def build
       {

data/lib/elastic_apm/transaction.rb

@@ -28,7 +28,7 @@ module ElasticAPM
 
     attr_accessor :id, :name, :result, :type
     attr_reader :context, :duration, :root_span, :timestamp, :spans,
-      :notifications, :sampled
+      :notifications, :sampled, :instrumenter
 
     def release
       @instrumenter.current_transaction = nil
@@ -61,9 +61,14 @@ module ElasticAPM
       spans.select(&:running?)
     end
 
-    def span(name, type = nil, context: nil)
+    # rubocop:disable Metrics/MethodLength
+    def span(name, type = nil, backtrace: nil, context: nil)
       span = next_span(name, type, context)
       spans << span
+
+      span.stacktrace =
+        backtrace && Stacktrace.build(@instrumenter.config, backtrace)
+
       span.start
 
       return span unless block_given?
@@ -76,6 +81,7 @@ module ElasticAPM
 
       result
     end
+    # rubocop:enable Metrics/MethodLength
 
     def current_span
       spans.reverse.lazy.find(&:running?)

data/lib/elastic_apm/util/dig.rb

@@ -0,0 +1,31 @@
+# Monkeypatch/backport/polyfill Enumerable#dig to Ruby < 2.3
+#
+# Implementation from
+#   https://github.com/Invoca/ruby_dig/blob/master/lib/ruby_dig.rb
+
+# @api private
+module RubyDig
+  def dig(key, *rest)
+    value = self[key]
+
+    if value.nil? || rest.empty?
+      value
+    elsif value.respond_to?(:dig)
+      value.dig(*rest)
+    else
+      raise TypeError, "#{value.class} does not respond to `#dig'"
+    end
+  end
+end
+
+if RUBY_VERSION < '2.3'
+  # @api private
+  class Array
+    include RubyDig
+  end
+
+  # @api private
+  class Hash
+    include RubyDig
+  end
+end

data/lib/elastic_apm/util/lru_cache.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Util
+    # @api private
+    class LruCache
+      def initialize(max_size = 512)
+        @max_size = max_size
+        @data = {}
+      end
+
+      def [](key)
+        found = true
+        value = @data.delete(key) { found = false }
+
+        found ? @data[key] = value : nil
+      end
+
+      def []=(key, val)
+        @data.delete(key)
+        @data[key] = val
+
+        return unless @data.length > @max_size
+
+        @data.delete(@data.first[0])
+      end
+
+      def length
+        @data.length
+      end
+
+      def to_a
+        @data.to_a
+      end
+    end
+  end
+end

data/lib/elastic_apm/version.rb

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

data/lib/elastic_apm/worker.rb

@@ -16,14 +16,12 @@ module ElasticAPM
       end
     end
 
-    def initialize(config, queue, http: Http)
+    def initialize(config, queue, adapter)
       @config = config
-      @adapter = http.new(config)
+      @adapter = adapter
       @queue = queue
     end
 
-    attr_reader :config
-
     def run_forever
       loop do
         while (item = @queue.pop)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,9 @@ files:
 - lib/elastic_apm/error/exception.rb
 - lib/elastic_apm/error/log.rb
 - lib/elastic_apm/error_builder.rb
+- lib/elastic_apm/filters.rb
+- lib/elastic_apm/filters/request_body_filter.rb
+- lib/elastic_apm/filters/secrets_filter.rb
 - lib/elastic_apm/http.rb
 - lib/elastic_apm/injectors.rb
 - lib/elastic_apm/injectors/action_dispatch.rb
@@ -96,11 +99,14 @@ files:
 - lib/elastic_apm/sql_summarizer.rb
 - lib/elastic_apm/stacktrace.rb
 - lib/elastic_apm/stacktrace/frame.rb
+- lib/elastic_apm/stacktrace/line_cache.rb
 - lib/elastic_apm/subscriber.rb
 - lib/elastic_apm/system_info.rb
 - lib/elastic_apm/transaction.rb
 - lib/elastic_apm/util.rb
+- lib/elastic_apm/util/dig.rb
 - lib/elastic_apm/util/inspector.rb
+- lib/elastic_apm/util/lru_cache.rb
 - lib/elastic_apm/version.rb
 - lib/elastic_apm/worker.rb
 - vendor/.gitkeep