elastic-apm 1.1.0 → 2.0.0

data/lib/elastic_apm/transport/filters.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/transport/filters/request_body_filter'
+require 'elastic_apm/transport/filters/secrets_filter'
+
+module ElasticAPM
+  module Transport
+    # @api private
+    module Filters
+      def self.new(config)
+        Container.new(config)
+      end
+
+      # @api private
+      class Container
+        def initialize(config)
+          @filters = {
+            request_body: RequestBodyFilter.new(config),
+            secrets: SecretsFilter.new(config)
+          }
+        end
+
+        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)|
+            result = filter.call(result)
+            break if result.nil?
+            result
+          end
+        end
+
+        def length
+          @filters.length
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/filters/request_body_filter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Filters
+      # @api private
+      class RequestBodyFilter
+        FILTERED = '[FILTERED]'
+
+        def initialize(config)
+          @config = config
+        end
+
+        def call(payload)
+          strip_body_from payload[:transaction]
+          strip_body_from payload[:error]
+
+          payload
+        end
+
+        private
+
+        def strip_body_from(payload)
+          return unless payload
+          return unless (request = payload.dig(:context, :request))
+          request[:body] = FILTERED
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/filters/secrets_filter.rb

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

data/lib/elastic_apm/transport/serializers.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ElasticAPM
+  module Transport
+    # @api private
+    module Serializers
+      # @api private
+      class UnrecognizedResource < InternalError; end
+
+      # @api private
+      class Serializer
+        def initialize(config)
+          @config = config
+        end
+
+        private
+
+        def ms(micros)
+          micros.to_f / 1_000
+        end
+      end
+
+      # @api private
+      class Container
+        def initialize(config)
+          @transaction = Serializers::TransactionSerializer.new(config)
+          @span = Serializers::SpanSerializer.new(config)
+          @error = Serializers::ErrorSerializer.new(config)
+        end
+
+        attr_reader :transaction, :span, :error
+
+        def serialize(resource)
+          case resource
+          when Transaction
+            transaction.build(resource)
+          when Span
+            span.build(resource)
+          when Error
+            error.build(resource)
+          else
+            raise UnrecognizedResource, resource.inspect
+          end
+        end
+      end
+
+      def self.new(config)
+        Container.new(config)
+      end
+    end
+  end
+end
+
+require 'elastic_apm/transport/serializers/transaction_serializer'
+require 'elastic_apm/transport/serializers/span_serializer'
+require 'elastic_apm/transport/serializers/error_serializer'

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Serializers
+      # @api private
+      class ErrorSerializer < Serializer
+        # rubocop:disable Metrics/MethodLength
+        def build(error)
+          base = {
+            id: error.id,
+            transaction_id: error.transaction_id,
+            trace_id: error.trace_id,
+            parent_id: error.parent_id,
+
+            culprit: error.culprit,
+            timestamp: error.timestamp,
+            context: error.context.to_h
+          }
+
+          if (exception = error.exception)
+            base[:exception] = build_exception exception
+          end
+
+          if (log = error.log)
+            base[:log] = build_log log
+          end
+
+          { error: base }
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        def build_exception(exception)
+          {
+            message: exception.message,
+            type: exception.type,
+            module: exception.module,
+            code: exception.code,
+            attributes: exception.attributes,
+            stacktrace: exception.stacktrace.to_a,
+            handled: exception.handled
+          }
+        end
+
+        def build_log(log)
+          {
+            message: log.message,
+            level: log.level,
+            logger_name: log.logger_name,
+            param_message: log.param_message,
+            stacktrace: log.stacktrace.to_a
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Serializers
+      # @api private
+      class SpanSerializer < Serializer
+        # rubocop:disable Metrics/MethodLength
+        def build(span)
+          {
+            span: {
+              id: span.id,
+              transaction_id: span.transaction_id,
+              parent_id: span.parent_id,
+              name: span.name,
+              type: span.type,
+              start: ms(span.relative_start),
+              duration: ms(span.duration),
+              context: span.context&.to_h,
+              stacktrace: span.stacktrace.to_a,
+              timestamp: span.timestamp,
+              trace_id: span.trace_id
+            }
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Serializers
+      # @api private
+      class TransactionSerializer < Serializer
+        # rubocop:disable Metrics/MethodLength
+        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,
+              duration: ms(transaction.duration),
+              timestamp: transaction.timestamp,
+              sampled: transaction.sampled?,
+              context: transaction.context.to_h,
+              span_count: {
+                started: transaction.started_spans,
+                dropped: transaction.dropped_spans
+              }
+            }
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/worker.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    # @api private
+    class Worker
+      include Logging
+
+      # @api private
+      class StopMessage; end
+
+      # @api private
+      class FlushMessage; end
+
+      def initialize(
+        config,
+        queue,
+        serializers:,
+        filters:,
+        conn_adapter: Connection
+      )
+        @config = config
+        @queue = queue
+
+        @stopping = false
+
+        @connection = conn_adapter.new(config)
+        @serializers = serializers
+        @filters = filters
+      end
+
+      attr_reader :queue, :filters, :name, :connection, :serializers
+
+      def stop
+        @stopping = true
+      end
+
+      def stopping?
+        @stopping
+      end
+
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def work_forever
+        while (msg = queue.pop)
+          case msg
+          when StopMessage
+            stop
+          else
+            process msg
+          end
+
+          next unless stopping?
+
+          debug 'Stopping worker -- %s', self
+          @connection.flush
+          break
+        end
+      rescue Exception => e
+        warn 'Worker died with exception: %s', e.inspect
+        debug e.backtrace.join("\n")
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+      private
+
+      def process(resource)
+        serialized = serializers.serialize(resource)
+        @filters.apply!(serialized)
+        @connection.write(serialized.to_json)
+      end
+    end
+  end
+end

data/lib/elastic_apm/util.rb

@@ -7,19 +7,22 @@ module ElasticAPM
       target - target.to_i % 60
     end
 
-    def self.micros(target = Time.now.utc)
-      target.to_i * 1_000_000 + target.usec
-    end
-
-    def self.inspect_transaction(transaction)
-      Inspector.new.transaction transaction
+    def self.micros(target = Time.now)
+      utc = target.utc
+      utc.to_i * 1_000_000 + utc.usec
     end
 
     def self.git_sha
       sha = `git rev-parse --verify HEAD 2>&1`.chomp
       $? && $?.success? ? sha : nil # rubocop:disable Style/SpecialGlobalVars
     end
+
+    def self.hex_to_bits(str)
+      str.hex.to_s(2).rjust(str.size * 4, '0')
+    end
+
+    def self.reverse_merge!(first, second)
+      first.merge!(second) { |_, old, _| old }
+    end
   end
 end
-
-require 'elastic_apm/util/inspector'

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - mikkel@elastic.co
@@ -35,7 +49,6 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -60,12 +73,14 @@ files:
 - docs/getting-started-rack.asciidoc
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
-- docs/troubleshooting.asciidoc
+- docs/supported-technologies.asciidoc
 - elastic-apm.gemspec
 - lib/elastic-apm.rb
 - lib/elastic_apm.rb
 - lib/elastic_apm/agent.rb
 - lib/elastic_apm/config.rb
+- lib/elastic_apm/config/duration.rb
+- lib/elastic_apm/config/size.rb
 - lib/elastic_apm/context.rb
 - lib/elastic_apm/context/request.rb
 - lib/elastic_apm/context/request/socket.rb
@@ -73,17 +88,18 @@ files:
 - lib/elastic_apm/context/response.rb
 - lib/elastic_apm/context/user.rb
 - lib/elastic_apm/context_builder.rb
+- lib/elastic_apm/deprecations.rb
 - lib/elastic_apm/error.rb
 - 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/instrumenter.rb
 - lib/elastic_apm/internal_error.rb
-- lib/elastic_apm/log.rb
+- lib/elastic_apm/logging.rb
+- lib/elastic_apm/metadata.rb
+- lib/elastic_apm/metadata/process_info.rb
+- lib/elastic_apm/metadata/service_info.rb
+- lib/elastic_apm/metadata/system_info.rb
 - lib/elastic_apm/middleware.rb
 - lib/elastic_apm/naively_hashable.rb
 - lib/elastic_apm/normalizers.rb
@@ -91,12 +107,7 @@ files:
 - lib/elastic_apm/normalizers/action_mailer.rb
 - lib/elastic_apm/normalizers/action_view.rb
 - lib/elastic_apm/normalizers/active_record.rb
-- lib/elastic_apm/process_info.rb
 - lib/elastic_apm/railtie.rb
-- lib/elastic_apm/serializers.rb
-- lib/elastic_apm/serializers/errors.rb
-- lib/elastic_apm/serializers/transactions.rb
-- lib/elastic_apm/service_info.rb
 - lib/elastic_apm/span.rb
 - lib/elastic_apm/span/context.rb
 - lib/elastic_apm/span_helpers.rb
@@ -104,6 +115,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/http.rb
 - lib/elastic_apm/spies/json.rb
 - lib/elastic_apm/spies/mongo.rb
 - lib/elastic_apm/spies/net_http.rb
@@ -118,15 +130,22 @@ files:
 - lib/elastic_apm/stacktrace/frame.rb
 - lib/elastic_apm/stacktrace_builder.rb
 - lib/elastic_apm/subscriber.rb
-- lib/elastic_apm/system_info.rb
+- lib/elastic_apm/traceparent.rb
 - lib/elastic_apm/transaction.rb
+- lib/elastic_apm/transport/base.rb
+- lib/elastic_apm/transport/connection.rb
+- lib/elastic_apm/transport/filters.rb
+- 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/error_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/dig.rb
 - lib/elastic_apm/util/inflector.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
 homepage: https://github.com/elastic/apm-agent-ruby
 licenses:
@@ -141,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="