elastic-apm 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cefd73acad31a9561dbfb964d2654d8f702c8db1783df2fe7dee9849a87609f
-  data.tar.gz: 8e4be6f5ee71a5972bc964f736d1cfaf652d307e2c080f7c9439273d966fc4d5
+  metadata.gz: df3dedd32ff6829fff4db353e0f6990d378d57313112cba444f717cb958565bd
+  data.tar.gz: 9e822ce49bc71ebf13ab70e0bf67e8c156a19f0f5c68e5dcca895fcebbf64edb
 SHA512:
-  metadata.gz: d73c89eb559553948b4eb628d321e0aee6aeb9d754ba6b8737e628fd2858290b761800a1da761d65d3d83126e0a6cab634ead3a3a763174064d8a16d3ae8dda9
-  data.tar.gz: 3b8b33c2083e82a433d650bf7708fe5686e47c3a4af71f233bbd52bafb202aa36ca1917e1f676deaeb587ad960b37286ac13e341e65e66c4d39246df99ac342f
+  metadata.gz: 9cd54124d6b4278d5cef85347eacc071a1a9d6511dc31c30fa551d9e9827d5288e1f91fad7c89cec32b4642897f13f92c16ed8a61b494f9e3b9bb4a60c8eacfc
+  data.tar.gz: ff0c2bff7f2d9f5d1a920a54a9dd120938c8a91e02cc024e3ecb9e420a50673f75b8ec2535643b794f34319ac2f2eb005a9a907dcc0e1b79869178fc3278305c

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.1.0 (2018-12-04)
+
+### Added
+
+- Support for Faraday ([#249](https://github.com/elastic/apm-agent-ruby/pull/249))
+
+### Fixed
+
+- Truncate keyword fields to 1024 chars ([#240](https://github.com/elastic/apm-agent-ruby/pull/240))
+- Lazy boot worker threads on first event. Fixes apps using Puma's `preload_app!` ([#239](https://github.com/elastic/apm-agent-ruby/pull/239))
+- Fix missing `disable_send` implementation ([#257](https://github.com/elastic/apm-agent-ruby/pull/257))
+- Add warnings for invalid config options ([#254](https://github.com/elastic/apm-agent-ruby/pull/254))
+
 ## 2.0.1 (2018-11-15)
 
 ### Fixed

data/README.md

@@ -11,21 +11,21 @@ The official Rubygem for [Elastic][] [APM][].
 
 ## Documentation
 
-[Full documentation at Elasti.co](https://www.elastic.co/guide/en/apm/agent/ruby/index.html).
+[Full documentation at Elasti.co](https://www.elastic.co/guide/en/apm/agent/ruby/2.x/index.html).
 
 <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><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/introduction.html">Introduction</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/getting-started-rails.html">Getting started with Rails</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/getting-started-rack.html">Getting started with Rack</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/configuration.html">Configuration</a></li>
 <li>
-<a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/advanced.html">Advanced Topics</a>
+<a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.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/spies.html">Spies — instrumented libraries</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/custom-instrumentation.html">Custom instrumentation</a></li>
 </ul>
 </li>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/1.x/api.html">Public API</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/supported-technologies.html">Supported Technologies</a></li>
+<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/api.html">Public API</a></li>
 </ul>
 
 ---

data/docs/advanced.asciidoc

@@ -0,0 +1,8 @@
+[[advanced]]
+== Advanced Topics
+
+* <<context>>
+* <<custom-instrumentation>>
+
+include::./context.asciidoc[]
+include::./custom-instrumentation.asciidoc[]

data/docs/api.asciidoc

@@ -98,7 +98,7 @@ Wrap a block in a Transaction, starting and ending around the block
 
 [source,ruby]
 ----
-ElasticAPM.transaction 'Do things' do |transaction|
+ElasticAPM.with_transaction 'Do things' do |transaction|
   do_work # ...
 
   transaction.result = 'success'

data/docs/configuration.asciidoc

@@ -319,7 +319,7 @@ Elastic APM can instrument your Rake tasks but given that they are used for a mu
 [options="header"]
 |============
 | Environment             | `Config` key | Default
-| `ELASTIC_APM_LOG_LEVEL` | `log_level`  | `Logger::DEBUG # => 0`
+| `ELASTIC_APM_LOG_LEVEL` | `log_level`  | `Logger::INFO # => 1`
 |============
 
 By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.

data/docs/context.asciidoc

@@ -1,4 +1,3 @@
-[float]
 [[context]]
 === Adding additional context
 

data/docs/index.asciidoc

@@ -2,42 +2,24 @@
 include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 
 ifdef::env-github[]
-NOTE: For the best reading experience, please view this documentation at
+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
 
-[[introduction]]
-== Introduction
-
-The Elastic APM Ruby Agent sends performance metrics and error logs to an
-Elastic APM Server.
-
-It has built-in support for <<getting-started-rails,Ruby on Rails>> and other
-<<getting-started-rack,Rack-compatible>> applications.
-
-This agent is one of several components you need to get started collecting APM
-data. See also:
-
- * {apm-server-ref}[APM Server]
-
-[[framework-support]]
-The Elastic APM Ruby Agent officially supports Ruby on Rails versions 4.x on
-onwards, see <<getting-started-rails,Getting started with Ruby on Rails>>.
-
-For Sinatra and other Rack compatible frameworks, see
-<<getting-started-rack,Getting started with Rack>>.
+include::./introduction.asciidoc[]
 
 include::./getting-started-rails.asciidoc[]
+
 include::./getting-started-rack.asciidoc[]
+
 include::./configuration.asciidoc[]
 
-[[advanced]]
-== Advanced Topics
-include::./context.asciidoc[]
-include::./custom-instrumentation.asciidoc[]
+include::./advanced.asciidoc[]
 
 include::./supported-technologies.asciidoc[]
+
 include::./api.asciidoc[]
 

data/docs/introduction.asciidoc

@@ -0,0 +1,33 @@
+[[introduction]]
+
+ifdef::env-github[]
+NOTE: For the best reading experience,
+please view this documentation at
+https://www.elastic.co/guide/en/apm/agent/ruby/current/introduction.html[elastic.co]
+endif::[]
+
+== Introduction
+
+Welcome to the APM Ruby Agent documentation.
+
+The Elastic APM Ruby Agent sends performance metrics and error logs to an
+Elastic APM Server.
+It has built-in support for <<getting-started-rails,Ruby on Rails>> and other
+<<getting-started-rack,Rack-compatible>> applications.
+
+[float]
+[[additional-components]]
+=== Additional Components
+
+APM Agents work in conjunction with the {apm-server-ref}/index.html[APM Server], {ref}/index.html[Elasticsearch], and {kibana-ref}/index.html[Kibana].
+Please view the {apm-get-started-ref}/index.html[APM Overview] for details on how these components work together. 
+
+[float]
+[[framework-support]]
+=== Framework Support
+
+The Elastic APM Ruby Agent officially supports Ruby on Rails versions 4.x on
+onwards, see <<getting-started-rails,Getting started with Ruby on Rails>>.
+
+For Sinatra and other Rack compatible frameworks, see
+<<getting-started-rack,Getting started with Rack>>.

data/lib/elastic_apm/agent.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/naively_hashable'
 require 'elastic_apm/context_builder'
 require 'elastic_apm/error_builder'
 require 'elastic_apm/stacktrace_builder'

data/lib/elastic_apm/config.rb

@@ -3,10 +3,13 @@
 require 'logger'
 require 'yaml'
 
+require 'elastic_apm/util/prefixed_logger'
 require 'elastic_apm/config/duration'
 require 'elastic_apm/config/size'
 
 module ElasticAPM
+  class ConfigError < StandardError; end
+
   # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
@@ -144,10 +147,10 @@ module ElasticAPM
     attr_accessor :transaction_sample_rate
     attr_accessor :verify_server_cert
 
-    attr_reader   :custom_key_filters
-    attr_reader   :ignore_url_patterns
-    attr_reader   :span_frames_min_duration
-    attr_reader   :span_frames_min_duration_us
+    attr_reader :custom_key_filters
+    attr_reader :ignore_url_patterns
+    attr_reader :span_frames_min_duration
+    attr_reader :span_frames_min_duration_us
 
     attr_accessor :view_paths
     attr_accessor :root_path
@@ -157,6 +160,10 @@ module ElasticAPM
     alias :instrument? :instrument
     alias :verify_server_cert? :verify_server_cert
 
+    def alert_logger
+      @alert_logger ||= PrefixedLogger.new($stdout, prefix: Logging::PREFIX)
+    end
+
     def app=(app)
       case app_type?(app)
       when :sinatra
@@ -198,6 +205,7 @@ module ElasticAPM
         action_dispatch
         delayed_job
         elasticsearch
+        faraday
         http
         json
         mongo
@@ -234,12 +242,22 @@ module ElasticAPM
     ].freeze
 
     def respond_to_missing?(name)
-      DEPRECATED_OPTIONS.include? name
+      return true if DEPRECATED_OPTIONS.include? name
+      return true if name.to_s.end_with?('=')
+      false
     end
 
     def method_missing(name, *args)
-      return super unless DEPRECATED_OPTIONS.include?(name)
-      warn "The option `#{name}' has been removed."
+      if DEPRECATED_OPTIONS.include?(name)
+        alert_logger.warn "The option `#{name}' has been removed."
+        return
+      end
+
+      if name.to_s.end_with?('=')
+        raise ConfigError, "No such option `#{name.to_s.delete('=')}'"
+      end
+
+      super
     end
 
     private
@@ -280,11 +298,21 @@ module ElasticAPM
 
     def set_from_args(options)
       assign(options)
+    rescue ConfigError => e
+      alert_logger.warn format(
+        'Failed to configure from arguments: %s',
+        e.message
+      )
     end
 
     def set_from_config_file
       return unless File.exist?(config_file)
       assign(YAML.load_file(config_file) || {})
+    rescue ConfigError => e
+      alert_logger.warn format(
+        'Failed to configure from config file: %s',
+        e.message
+      )
     end
 
     def set_sinatra(app)

data/lib/elastic_apm/context.rb

@@ -9,8 +9,6 @@ require 'elastic_apm/context/user'
 module ElasticAPM
   # @api private
   class Context
-    include NaivelyHashable
-
     attr_accessor :request, :response, :user
     attr_reader :custom, :tags
 

data/lib/elastic_apm/context/request.rb

@@ -4,8 +4,6 @@ module ElasticAPM
   class Context
     # @api private
     class Request
-      include NaivelyHashable
-
       attr_accessor :body, :cookies, :env, :headers, :http_version, :method,
         :socket, :url
     end

data/lib/elastic_apm/context/request/socket.rb

@@ -7,8 +7,6 @@ module ElasticAPM
     class Request
       # @api private
       class Socket
-        include NaivelyHashable
-
         def initialize(req)
           @remote_addr = req.ip
           @encrypted = req.scheme == 'https'

data/lib/elastic_apm/context/request/url.rb

@@ -7,8 +7,6 @@ module ElasticAPM
     class Request
       # @api private
       class Url
-        include NaivelyHashable
-
         SKIPPED_PORTS = {
           'http' => 80,
           'https' => 443

data/lib/elastic_apm/context/response.rb

@@ -4,8 +4,6 @@ module ElasticAPM
   class Context
     # @api private
     class Response
-      include NaivelyHashable
-
       def initialize(
         status_code,
         headers: {},

data/lib/elastic_apm/context/user.rb

@@ -4,12 +4,10 @@ module ElasticAPM
   class Context
     # @api private
     class User
-      include NaivelyHashable
-
       def initialize(config, record)
         return unless record
 
-        @id = safe_get(record, config.current_user_id_method)
+        @id = safe_get(record, config.current_user_id_method)&.to_s
         @email = safe_get(record, config.current_user_email_method)
         @username = safe_get(record, config.current_user_username_method)
       end

data/lib/elastic_apm/context_builder.rb

@@ -21,10 +21,10 @@ module ElasticAPM
       context.request = Context::Request.new unless context.request
       request = context.request
 
-      request.socket = Context::Request::Socket.new(req).to_h
+      request.socket = Context::Request::Socket.new(req)
       request.http_version = build_http_version rack_env
       request.method = req.request_method
-      request.url = Context::Request::Url.new(req).to_h
+      request.url = Context::Request::Url.new(req)
       request.headers, request.env = get_headers_and_env(rack_env)
       request.body = get_body(req)
 

data/lib/elastic_apm/metadata.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/metadata/service_info'
-require 'elastic_apm/metadata/system_info'
-require 'elastic_apm/metadata/process_info'
-
 module ElasticAPM
   # @api private
-  module Metadata
-    def self.build(config)
-      {
-        metadata: {
-          service: Metadata::ServiceInfo.build(config),
-          process: Metadata::ProcessInfo.build(config),
-          system: Metadata::SystemInfo.build(config)
-        }
-      }.to_json
+  class Metadata
+    def initialize(config)
+      @service = ServiceInfo.new(config)
+      @process = ProcessInfo.new(config)
+      @system = SystemInfo.new(config)
     end
+
+    attr_reader :service, :process, :system
   end
 end
+
+require 'elastic_apm/metadata/service_info'
+require 'elastic_apm/metadata/system_info'
+require 'elastic_apm/metadata/process_info'

data/lib/elastic_apm/metadata/process_info.rb

@@ -1,26 +1,18 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  module Metadata
+  class Metadata
     # @api private
     class ProcessInfo
       def initialize(config)
         @config = config
-      end
 
-      def build
-        pid = $PID || Process.pid
-        return unless pid
-        {
-          argv: ARGV,
-          pid: pid,
-          title: $PROGRAM_NAME
-        }
+        @argv = ARGV
+        @pid = $PID || Process.pid
+        @title = $PROGRAM_NAME
       end
 
-      def self.build(config)
-        new(config).build
-      end
+      attr_reader :argv, :pid, :title
     end
   end
 end

data/lib/elastic_apm/metadata/service_info.rb

@@ -1,56 +1,61 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  module Metadata
+  class Metadata
     # @api private
     class ServiceInfo
-      def initialize(config)
-        @config = config
+      # @api private
+      class Versioned
+        def initialize(name: nil, version: nil)
+          @name = name
+          @version = version
+        end
+
+        attr_reader :name, :version
       end
+      class Agent < Versioned; end
+      class Framework < Versioned; end
+      class Language < Versioned; end
+      class Runtime < Versioned; end
 
       # rubocop:disable Metrics/MethodLength
-      def build
-        base = {
-          name: @config.service_name,
-          environment: @config.environment,
-          agent: {
-            name: 'ruby',
-            version: VERSION
-          },
-          framework: nil,
-          language: {
-            name: 'ruby',
-            version: RUBY_VERSION
-          },
-          runtime: runtime,
-          version: @config.service_version || Util.git_sha
-        }
-
-        if @config.framework_name
-          base[:framework] = {
-            name: @config.framework_name,
-            version: @config.framework_version
-          }
-        end
+      def initialize(config)
+        @config = config
 
-        base
+        @name = @config.service_name
+        @environment = @config.environment
+        @agent = Agent.new(name: 'ruby', version: VERSION)
+        @framework = Framework.new(
+          name: @config.framework_name,
+          version: @config.framework_version
+        )
+        @language = Language.new(name: 'ruby', version: RUBY_VERSION)
+        @runtime = lookup_runtime
+        @version = @config.service_version || Util.git_sha
       end
       # rubocop:enable Metrics/MethodLength
 
-      def self.build(config)
-        new(config).build
-      end
+      attr_reader :name, :environment, :agent, :framework, :language, :runtime,
+        :version
 
       private
 
-      def runtime
+      # rubocop:disable Metrics/MethodLength
+      def lookup_runtime
         case RUBY_ENGINE
         when 'ruby'
-          { name: RUBY_ENGINE, version: RUBY_VERSION || RUBY_ENGINE_VERSION }
+          Runtime.new(
+            name: RUBY_ENGINE,
+            version: RUBY_VERSION || RUBY_ENGINE_VERSION
+          )
         when 'jruby'
-          { name: RUBY_ENGINE, version: JRUBY_VERSION || RUBY_ENGINE_VERSION }
+          Runtime.new(
+            name: RUBY_ENGINE,
+            version: JRUBY_VERSION || RUBY_ENGINE_VERSION
+          )
         end
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/elastic_apm/metadata/system_info.rb

@@ -1,29 +1,23 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  module Metadata
+  class Metadata
     # @api private
     class SystemInfo
       def initialize(config)
         @config = config
-      end
 
-      def build
-        {
-          hostname: @config.hostname || `hostname`.chomp,
-          architecture: platform.cpu,
-          platform: platform.os
-        }
+        @hostname = @config.hostname || `hostname`.chomp
+        @architecture = gem_platform.cpu
+        @platform = gem_platform.os
       end
 
-      def self.build(config)
-        new(config).build
-      end
+      attr_reader :hostname, :architecture, :platform
 
       private
 
-      def platform
-        @platform ||= Gem::Platform.local
+      def gem_platform
+        @gem_platform ||= Gem::Platform.local
       end
     end
   end

data/lib/elastic_apm/railtie.rb

@@ -26,8 +26,8 @@ module ElasticAPM
           app.middleware.insert 0, Middleware
         end
       rescue StandardError => e
-        Rails.logger.error "#{Logging::PREFIX}Failed to start: #{e.message}"
-        Rails.logger.debug e.backtrace.join("\n")
+        config.alert_logger.error format('Failed to start: %s', e.message)
+        config.alert_logger.debug e.backtrace.join("\n")
       end
     end
 

data/lib/elastic_apm/span/context.rb

@@ -4,8 +4,6 @@ module ElasticAPM
   class Span
     # @api private
     class Context
-      include NaivelyHashable
-
       def initialize(db: nil, http: nil)
         @db = db && Db.new(db)
         @http = http && Http.new(http)
@@ -15,8 +13,6 @@ module ElasticAPM
 
       # @api private
       class Db
-        include NaivelyHashable
-
         def initialize(instance: nil, statement: nil, type: nil, user: nil)
           @instance = instance
           @statement = statement
@@ -29,8 +25,6 @@ module ElasticAPM
 
       # @api private
       class Http
-        include NaivelyHashable
-
         def initialize(url: nil, status_code: nil, method: nil)
           @url = url
           @status_code = status_code

data/lib/elastic_apm/spies/faraday.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module Spies
+    # @api private
+    class FaradaySpy
+      # rubocop:disable Metrics/MethodLength
+      def install
+        ::Faraday::Connection.class_eval do
+          alias run_request_without_apm run_request
+
+          def run_request(method, url, body, headers, &block)
+            unless (transaction = ElasticAPM.current_transaction)
+              return run_request_without_apm(method, url, body, headers, &block)
+            end
+
+            host = URI(url).host
+
+            name = "#{method.upcase} #{host}"
+            type = "ext.faraday.#{method}"
+
+            ElasticAPM.with_span name, type do |span|
+              ElasticAPM::Spies::NetHTTPSpy.disable_in do
+                run_request_without_apm(method, url, body, headers) do |req|
+                  req['Elastic-Apm-Traceparent'] =
+                    transaction.traceparent.to_header(span_id: span.id)
+
+                  yield req if block_given?
+                end
+              end
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+
+    register 'Faraday', 'faraday', FaradaySpy.new
+  end
+end

data/lib/elastic_apm/spies/net_http.rb

@@ -5,7 +5,29 @@ module ElasticAPM
   module Spies
     # @api private
     class NetHTTPSpy
+      KEY = :__elastic_apm_net_http_disabled
+
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      class << self
+        def disabled=(disabled)
+          Thread.current[KEY] = disabled
+        end
+
+        def disabled?
+          Thread.current[KEY] ||= false
+        end
+
+        def disable_in
+          self.disabled = true
+
+          begin
+            yield
+          ensure
+            self.disabled = false
+          end
+        end
+      end
+
       def install
         Net::HTTP.class_eval do
           alias request_without_apm request
@@ -14,6 +36,9 @@ module ElasticAPM
             unless (transaction = ElasticAPM.current_transaction)
               return request_without_apm(req, body, &block)
             end
+            if ElasticAPM::Spies::NetHTTPSpy.disabled?
+              return request_without_apm(req, body, &block)
+            end
 
             host, = req['host'] && req['host'].split(':')
             method = req.method

data/lib/elastic_apm/stacktrace/frame.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'elastic_apm/naively_hashable'
+
 module ElasticAPM
   class Stacktrace
     # @api private

data/lib/elastic_apm/transport/base.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
+require 'elastic_apm/metadata'
 require 'elastic_apm/transport/connection'
 require 'elastic_apm/transport/worker'
-
 require 'elastic_apm/transport/serializers'
 require 'elastic_apm/transport/filters'
 
@@ -25,7 +25,6 @@ module ElasticAPM
       attr_reader :config, :queue, :workers, :filters
 
       def start
-        ensure_worker_count
       end
 
       def stop

data/lib/elastic_apm/transport/connection.rb

@@ -4,8 +4,6 @@ require 'http'
 require 'concurrent'
 require 'zlib'
 
-require 'elastic_apm/metadata'
-
 module ElasticAPM
   module Transport
     # @api private
@@ -30,8 +28,9 @@ module ElasticAPM
       }.freeze
       GZIP_HEADERS = HEADERS.merge('Content-Encoding' => 'gzip').freeze
 
-      def initialize(config)
+      def initialize(config, metadata)
         @config = config
+        @metadata = metadata.to_json
 
         @url = config.server_url + '/intake/v2/events'
 
@@ -44,12 +43,12 @@ module ElasticAPM
 
         @client = HTTP.headers(headers).persistent(@url)
 
-        @metadata = Metadata.build(config)
-
         @mutex = Mutex.new
       end
 
       def write(str)
+        return if @config.disable_send
+
         connect_unless_connected
 
         @mutex.synchronize { append(str) }

data/lib/elastic_apm/transport/serializers.rb

@@ -15,11 +15,23 @@ module ElasticAPM
           @config = config
         end
 
+        attr_reader :config
+
         private
 
         def ms(micros)
           micros.to_f / 1_000
         end
+
+        def keyword_field(value)
+          Util.truncate(value)
+        end
+
+        def keyword_object(hash)
+          hash.tap do |h|
+            h.each { |k, v| hash[k] = keyword_field(v) }
+          end
+        end
       end
 
       # @api private
@@ -28,10 +40,12 @@ module ElasticAPM
           @transaction = Serializers::TransactionSerializer.new(config)
           @span = Serializers::SpanSerializer.new(config)
           @error = Serializers::ErrorSerializer.new(config)
+          @metadata = Serializers::MetadataSerializer.new(config)
         end
 
-        attr_reader :transaction, :span, :error
+        attr_reader :transaction, :span, :error, :metadata
 
+        # rubocop:disable Metrics/MethodLength
         def serialize(resource)
           case resource
           when Transaction
@@ -40,10 +54,13 @@ module ElasticAPM
             span.build(resource)
           when Error
             error.build(resource)
+          when Metadata
+            metadata.build(resource)
           else
             raise UnrecognizedResource, resource.inspect
           end
         end
+        # rubocop:enable Metrics/MethodLength
       end
 
       def self.new(config)
@@ -53,6 +70,8 @@ module ElasticAPM
   end
 end
 
-require 'elastic_apm/transport/serializers/transaction_serializer'
-require 'elastic_apm/transport/serializers/span_serializer'
+require 'elastic_apm/transport/serializers/context_serializer'
 require 'elastic_apm/transport/serializers/error_serializer'
+require 'elastic_apm/transport/serializers/metadata_serializer'
+require 'elastic_apm/transport/serializers/span_serializer'
+require 'elastic_apm/transport/serializers/transaction_serializer'

data/lib/elastic_apm/transport/serializers/context_serializer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Serializers
+      # @api private
+      class ContextSerializer < Serializer
+        def build(context)
+          {
+            custom: context.custom,
+            tags: keyword_object(context.tags),
+            request: build_request(context.request),
+            response: build_response(context.response),
+            user: build_user(context.user)
+          }
+        end
+
+        private
+
+        # rubocop:disable Metrics/MethodLength
+        def build_request(request)
+          return unless request
+
+          {
+            body: request.body,
+            cookies: request.cookies,
+            env: request.env,
+            headers: request.headers,
+            http_version: keyword_field(request.http_version),
+            method: keyword_field(request.method),
+            socket: build_socket(request.socket),
+            url: request.url
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def build_response(response)
+          return unless response
+
+          {
+            status_code: response.status_code,
+            headers: response.headers,
+            headers_sent: response.headers_sent,
+            finished: response.finished
+          }
+        end
+
+        def build_user(user)
+          return unless user
+
+          {
+            id: keyword_field(user.id),
+            email: keyword_field(user.email),
+            username: keyword_field(user.username)
+          }
+        end
+
+        def build_socket(socket)
+          return unless socket
+
+          {
+            remote_addr: socket.remote_addr,
+            encrypted: socket.encrypted
+          }
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/serializers/error_serializer.rb

@@ -5,6 +5,10 @@ module ElasticAPM
     module Serializers
       # @api private
       class ErrorSerializer < Serializer
+        def context_serializer
+          @context_serializer ||= ContextSerializer.new(config)
+        end
+
         # rubocop:disable Metrics/MethodLength
         def build(error)
           base = {
@@ -15,7 +19,7 @@ module ElasticAPM
 
             culprit: error.culprit,
             timestamp: error.timestamp,
-            context: error.context.to_h
+            context: context_serializer.build(error.context)
           }
 
           if (exception = error.exception)
@@ -35,9 +39,9 @@ module ElasticAPM
         def build_exception(exception)
           {
             message: exception.message,
-            type: exception.type,
-            module: exception.module,
-            code: exception.code,
+            type: keyword_field(exception.type),
+            module: keyword_field(exception.module),
+            code: keyword_field(exception.code),
             attributes: exception.attributes,
             stacktrace: exception.stacktrace.to_a,
             handled: exception.handled
@@ -47,9 +51,9 @@ module ElasticAPM
         def build_log(log)
           {
             message: log.message,
-            level: log.level,
-            logger_name: log.logger_name,
-            param_message: log.param_message,
+            level: keyword_field(log.level),
+            logger_name: keyword_field(log.logger_name),
+            param_message: keyword_field(log.param_message),
             stacktrace: log.stacktrace.to_a
           }
         end

data/lib/elastic_apm/transport/serializers/metadata_serializer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Serializers
+      # @api private
+      class MetadataSerializer < Serializer
+        def build(metadata)
+          {
+            metadata: {
+              service: build_service(metadata.service),
+              process: build_process(metadata.process),
+              system: build_system(metadata.system)
+            }
+          }
+        end
+
+        private
+
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def build_service(service)
+          {
+            name: keyword_field(service.name),
+            environment: keyword_field(service.environment),
+            version: keyword_field(service.version),
+            agent: {
+              name: keyword_field(service.agent.name),
+              version: keyword_field(service.agent.version)
+            },
+            framework: {
+              name: keyword_field(service.framework.name),
+              version: keyword_field(service.framework.version)
+            },
+            language: {
+              name: keyword_field(service.language.name),
+              version: keyword_field(service.language.version)
+            },
+            runtime: {
+              name: keyword_field(service.runtime.name),
+              version: keyword_field(service.runtime.version)
+            }
+          }
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+        def build_process(process)
+          {
+            pid: process.pid,
+            title: keyword_field(process.title),
+            argv: process.argv
+          }
+        end
+
+        def build_system(system)
+          {
+            hostname: keyword_field(system.hostname),
+            architecture: keyword_field(system.architecture),
+            platform: keyword_field(system.platform)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/serializers/span_serializer.rb

@@ -5,24 +5,68 @@ module ElasticAPM
     module Serializers
       # @api private
       class SpanSerializer < Serializer
-        # rubocop:disable Metrics/MethodLength
+        def initialize(config)
+          super
+
+          @context_serializer = ContextSerializer.new(config)
+        end
+
+        attr_reader :context_serializer
+
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def build(span)
           {
             span: {
               id: span.id,
               transaction_id: span.transaction_id,
               parent_id: span.parent_id,
-              name: span.name,
-              type: span.type,
+              name: keyword_field(span.name),
+              type: keyword_field(span.type),
               duration: ms(span.duration),
-              context: span.context&.to_h,
+              context: context_serializer.build(span.context),
               stacktrace: span.stacktrace.to_a,
               timestamp: span.timestamp,
               trace_id: span.trace_id
             }
           }
         end
-        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+        # @api private
+        class ContextSerializer < Serializer
+          def build(context)
+            return unless context
+
+            {
+              sync: context.sync,
+              db: build_db(context.db),
+              http: build_http(context.http)
+            }
+          end
+
+          private
+
+          def build_db(db)
+            return unless db
+
+            {
+              instance: db.instance,
+              statement: db.statement,
+              type: db.type,
+              user: db.user
+            }
+          end
+
+          def build_http(http)
+            return unless http
+
+            {
+              url: http.url,
+              status_code: http.status_code,
+              method: keyword_field(http.method)
+            }
+          end
+        end
       end
     end
   end

data/lib/elastic_apm/transport/serializers/transaction_serializer.rb

@@ -5,20 +5,24 @@ module ElasticAPM
     module Serializers
       # @api private
       class TransactionSerializer < Serializer
-        # rubocop:disable Metrics/MethodLength
+        def context_serializer
+          @context_serializer ||= ContextSerializer.new(config)
+        end
+
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def build(transaction)
           {
             transaction: {
               id: transaction.id,
               trace_id: transaction.trace_id,
               parent_id: transaction.parent_id,
-              name: transaction.name,
-              type: transaction.type,
-              result: transaction.result.to_s,
+              name: keyword_field(transaction.name),
+              type: keyword_field(transaction.type),
+              result: keyword_field(transaction.result.to_s),
               duration: ms(transaction.duration),
               timestamp: transaction.timestamp,
               sampled: transaction.sampled?,
-              context: transaction.context.to_h,
+              context: context_serializer.build(transaction.context),
               span_count: {
                 started: transaction.started_spans,
                 dropped: transaction.dropped_spans
@@ -26,7 +30,7 @@ module ElasticAPM
             }
           }
         end
-        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
       end
     end
   end

data/lib/elastic_apm/transport/worker.rb

@@ -24,9 +24,11 @@ module ElasticAPM
 
         @stopping = false
 
-        @connection = conn_adapter.new(config)
         @serializers = serializers
         @filters = filters
+
+        metadata = serializers.serialize(Metadata.new(config))
+        @connection = conn_adapter.new(config, metadata)
       end
 
       attr_reader :queue, :filters, :name, :connection, :serializers
@@ -39,7 +41,7 @@ module ElasticAPM
         @stopping
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
       def work_forever
         while (msg = queue.pop)
           case msg
@@ -59,7 +61,7 @@ module ElasticAPM
         warn 'Worker died with exception: %s', e.inspect
         debug e.backtrace.join("\n")
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/elastic_apm/util.rb

@@ -24,5 +24,12 @@ module ElasticAPM
     def self.reverse_merge!(first, second)
       first.merge!(second) { |_, old, _| old }
     end
+
+    def self.truncate(value, max_length: 1024)
+      return unless value
+      return value if value.length <= max_length
+
+      value[0...(max_length - 1)] + '…'
+    end
   end
 end

data/lib/elastic_apm/util/prefixed_logger.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  class PrefixedLogger < Logger
+    def initialize(logdev, prefix: '', **args)
+      super(logdev, **args)
+
+      @prefix = prefix
+    end
+
+    attr_reader :prefix
+
+    def add(severity, message = nil, progname = nil)
+      super(severity, format('%s%s', prefix, message), progname)
+    end
+  end
+end

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -66,6 +66,7 @@ files:
 - bin/console
 - bin/setup
 - bin/with_framework
+- docs/advanced.asciidoc
 - docs/api.asciidoc
 - docs/configuration.asciidoc
 - docs/context.asciidoc
@@ -73,6 +74,7 @@ files:
 - docs/getting-started-rack.asciidoc
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
+- docs/introduction.asciidoc
 - docs/supported-technologies.asciidoc
 - elastic-apm.gemspec
 - lib/elastic-apm.rb
@@ -115,6 +117,7 @@ files:
 - lib/elastic_apm/spies/action_dispatch.rb
 - lib/elastic_apm/spies/delayed_job.rb
 - lib/elastic_apm/spies/elasticsearch.rb
+- lib/elastic_apm/spies/faraday.rb
 - lib/elastic_apm/spies/http.rb
 - lib/elastic_apm/spies/json.rb
 - lib/elastic_apm/spies/mongo.rb
@@ -138,13 +141,16 @@ files:
 - lib/elastic_apm/transport/filters/request_body_filter.rb
 - lib/elastic_apm/transport/filters/secrets_filter.rb
 - lib/elastic_apm/transport/serializers.rb
+- lib/elastic_apm/transport/serializers/context_serializer.rb
 - lib/elastic_apm/transport/serializers/error_serializer.rb
+- lib/elastic_apm/transport/serializers/metadata_serializer.rb
 - lib/elastic_apm/transport/serializers/span_serializer.rb
 - lib/elastic_apm/transport/serializers/transaction_serializer.rb
 - lib/elastic_apm/transport/worker.rb
 - lib/elastic_apm/util.rb
 - lib/elastic_apm/util/inflector.rb
 - lib/elastic_apm/util/lru_cache.rb
+- lib/elastic_apm/util/prefixed_logger.rb
 - lib/elastic_apm/version.rb
 - vendor/.gitkeep
 homepage: https://github.com/elastic/apm-agent-ruby