elastic-apm 1.1.0 → 2.0.0

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0

data/docs/troubleshooting.asciidoc

@@ -1,28 +0,0 @@
-[[debugging]]
-=== Debugging APM
-
-The agent not working for you? There are a few settings that might help:
-
-[float]
-[[debugging-debug-transactions]]
-==== `debug_transactions`
-
-[options="header"]
-|============
-| Environment                      | `Config` key         | Default
-| `ELASTIC_APM_DEBUG_TRANSACTIONS` | `debug_transactions` | `false`
-|============
-
-When on, Elastic APM will log a summary of each transaction when submitted.
-
-[float]
-[[debugging-debug-http]]
-==== `debug_http`
-
-[options="header"]
-|============
-| Environment              | `Config` key | Default
-| `ELASTIC_APM_DEBUG_HTTP` | `debug_http` | `false`
-|============
-
-When on, Elastic APM will log debug information from all the requests it makes to APM Server.

data/lib/elastic_apm/filters.rb

@@ -1,46 +0,0 @@
-# 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)|
-          result = filter.call(result)
-          break if result.nil?
-          result
-        end
-      end
-
-      def length
-        @filters.length
-      end
-    end
-  end
-end

data/lib/elastic_apm/filters/request_body_filter.rb

@@ -1,33 +0,0 @@
-# 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

@@ -1,59 +0,0 @@
-# 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
-        @key_filters = KEY_FILTERS + config.custom_key_filters
-      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.match regex }
-      end
-
-      def filter_value?(value)
-        VALUE_FILTERS.any? { |regex| value.match regex }
-      end
-    end
-  end
-end

data/lib/elastic_apm/http.rb

@@ -1,139 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'openssl'
-require 'zlib'
-
-require 'elastic_apm/service_info'
-require 'elastic_apm/system_info'
-require 'elastic_apm/process_info'
-require 'elastic_apm/filters'
-
-module ElasticAPM
-  # @api private
-  class Http
-    include Log
-
-    USER_AGENT = "elastic-apm/ruby #{VERSION}".freeze
-    ACCEPT = 'application/json'.freeze
-    CONTENT_TYPE = 'application/json'.freeze
-
-    def initialize(config, adapter: HttpAdapter)
-      @config = config
-      @adapter = adapter.new(config)
-      @base_payload = {
-        service: ServiceInfo.build(config),
-        process: ProcessInfo.build(config),
-        system: SystemInfo.build(config)
-      }
-      @filters = Filters.new(config)
-    end
-
-    attr_reader :filters
-
-    def post(path, payload = {})
-      payload.merge! @base_payload
-
-      payload = filters.apply(payload)
-      return if payload.nil?
-
-      request = prepare_request path, payload.to_json
-      response = @adapter.perform request
-
-      return nil if response == HttpAdapter::DISABLED
-      return response if response.is_a?(Net::HTTPSuccess)
-
-      error 'POST returned an unsuccessful status code (%d)', response.code
-      error "apm-server's response: %s", response.body
-
-      response
-    end
-
-    private
-
-    def prepare_request(path, data)
-      @adapter.post url_for(path) do |req|
-        req['Accept'] = ACCEPT
-        req['Content-Type'] = CONTENT_TYPE
-        req['User-Agent'] = USER_AGENT
-
-        if (token = @config.secret_token)
-          req['Authorization'] = "Bearer #{token}"
-        end
-
-        prepare_request_body! req, data
-      end
-    end
-
-    def prepare_request_body!(req, data)
-      if @config.http_compression &&
-         data.bytesize > @config.compression_minimum_size
-        deflated = Zlib.deflate data, @config.compression_level
-
-        req['Content-Encoding'] = 'deflate'
-        req['Content-Length'] = deflated.bytesize.to_s
-        req.body = deflated
-      else
-        req['Content-Length'] = data.bytesize.to_s
-        req.body = data
-      end
-    end
-
-    def url_for(path)
-      "#{@config.server_url}#{path}"
-    end
-  end
-
-  # @api private
-  class HttpAdapter
-    DISABLED = 'disabled'.freeze
-
-    def initialize(conf)
-      @config = conf
-    end
-
-    def post(path)
-      req = Net::HTTP::Post.new path
-      yield req if block_given?
-      req
-    end
-
-    def perform(req)
-      return DISABLED if @config.disable_send?
-
-      http.start do |http|
-        http.request req
-      end
-    end
-
-    private
-
-    def http
-      return @http if @http
-
-      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_read_timeout
-      http.open_timeout = @config.http_open_timeout
-
-      if @config.debug_http
-        http.set_debug_output(@config.logger)
-      end
-
-      @http = http
-    end
-
-    def server_uri
-      @server_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/process_info.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module ElasticAPM
-  # @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
-      }
-    end
-
-    def self.build(config)
-      new(config).build
-    end
-  end
-end

data/lib/elastic_apm/serializers.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module ElasticAPM
-  # @api private
-  module Serializers
-    # @api private
-    class Serializer
-      def initialize(config)
-        @config = config
-      end
-
-      private
-
-      def micros_to_time(micros)
-        Time.at(ms(micros) / 1_000)
-      end
-
-      def ms(micros)
-        micros.to_f / 1_000
-      end
-    end
-  end
-end
-
-require 'elastic_apm/serializers/transactions'
-require 'elastic_apm/serializers/errors'

data/lib/elastic_apm/serializers/errors.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module ElasticAPM
-  module Serializers
-    # @api private
-    class Errors < Serializer
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def build(error)
-        base = {
-          id: error.id,
-          culprit: error.culprit,
-          timestamp: micros_to_time(error.timestamp).utc.iso8601(3),
-          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
-
-        if (transaction_id = error.transaction_id)
-          base[:transaction] = { id: transaction_id }
-        end
-
-        base
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-      def build_all(errors)
-        { errors: Array(errors).map { |e| build(e) } }
-      end
-
-      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

data/lib/elastic_apm/serializers/transactions.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module ElasticAPM
-  module Serializers
-    # @api private
-    class Transactions < Serializer
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def build(transaction)
-        base = {
-          id: transaction.id,
-          name: transaction.name,
-          type: transaction.type,
-          result: transaction.result.to_s,
-          duration: ms(transaction.duration),
-          timestamp: micros_to_time(transaction.timestamp).utc.iso8601(3),
-          spans: transaction.spans.map { |s| build_span(s) },
-          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
-
-      def build_all(transactions)
-        { transactions: Array(transactions).map { |t| build(t) } }
-      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