atatus 1.3.0 → 1.6.1

data/lib/atatus/collector/transport.rb

@@ -8,6 +8,7 @@ module Atatus
     include Logging
 
     TXN_ENDPOINT = '/track/apm/txn'.freeze
+    TXN_HIST_ENDPOINT = '/track/apm/txn/histogram'.freeze
     TRACE_ENDPOINT = '/track/apm/trace'.freeze
     HOSTINFO_ENDPOINT = "/track/apm/hostinfo".freeze
     ERROR_ENDPOINT = "/track/apm/error".freeze
@@ -18,15 +19,17 @@ module Atatus
       @config = config
 
       @notify_host = @config.notify_host
-      @uri = URI(@notify_host)
-      if not @uri.kind_of?(URI::HTTPS) and not @uri.kind_of?(URI::HTTP)
+      uri = URI(@notify_host)
+      if not uri.kind_of?(URI::HTTPS) and not uri.kind_of?(URI::HTTP)
         @notify_host = "https://apm-rx.atatus.com"
-        @uri = URI(@notify_host)
       end
 
       @builder = Atatus::Builder.new(config)
       @headers = {}
       @headers['Content-Type'] = "application/json"
+
+      @blocked = false
+      @capture_percentiles = false
     end
 
     def hostinfo(start_time)
@@ -39,6 +42,13 @@ module Atatus
       post(TXN_ENDPOINT, payload)
     end
 
+    def txn_hist(start_time, end_time, data)
+      if @capture_percentiles == true
+        payload = @builder.txn_hist(start_time, end_time, data)
+        post(TXN_HIST_ENDPOINT, payload)
+      end
+    end
+
     def traces(start_time, end_time, data)
       payload = @builder.traces(start_time, end_time, data)
       post(TRACE_ENDPOINT, payload)
@@ -68,14 +78,18 @@ module Atatus
       end
 
       begin
-        request = Net::HTTP::Post.new(endpoint, @headers)
+        uri = URI(@notify_host + endpoint)
+        uri.query = URI.encode_www_form({"license_key": @config.license_key, "agent_name": AGENT_NAME, "agent_version": VERSION})
+
+        request = Net::HTTP::Post.new(uri.request_uri, @headers)
         request.body = ::JSON.dump(data)
-        http = Net::HTTP.new(@uri.host, @uri.port)
+        http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         response = http.start { |http| http.request(request) }
       rescue SystemCallError, Timeout::Error, EOFError, SocketError => e
-        puts "Atatus transport [#{@notify_host}#{endpoint}] failed with exception: #{e}"
+        error format('Atatus transport [%s%s] failed with exception: %s', @notify_host, endpoint, e.message)
+        return
       end
 
       if @blocked == true
@@ -84,10 +98,25 @@ module Atatus
 
       case response
       when Net::HTTPSuccess
-        true
+        if endpoint == HOSTINFO_ENDPOINT
+          @capture_percentiles = false
+
+          if not response.body
+            return
+          end
+
+          resp = JSON.parse response.body
+          if resp
+            if resp.key?("capturePercentiles")
+              @capture_percentiles = resp["capturePercentiles"]
+            end
+          end
+        else
+          true
+        end
       when Net::HTTPBadRequest
         if not response.body
-          error format('Atatus transport status 400, failed without content')
+          error format('Transport status 400, failed without content')
           return
         end
 
@@ -97,7 +126,7 @@ module Atatus
             @blocked = resp[:blocked]
             if @blocked == true
               if resp.key?(:errorMessage)
-                error format('Atatus blocked from sending data as: %s', resp[:errorMessage])
+                error format('Blocked from sending data as: %s', resp[:errorMessage])
                 return
               end
             end
@@ -105,11 +134,12 @@ module Atatus
         end
 
         if !resp
-          error format('Atatus transport status 400, failed with parsed content: %s', resp)
+          error format('Transport status 400, failed with parsed content: %s', resp)
         else
-          error format('Atatus transport status 400, failed with content: %s', response.body)
+          error format('Transport status 400, failed with content: %s', response.body)
         end
       else
+        error format('Transport unexpected failure: [%s] [%s]', response.code, endpoint)
       end
     end
   end

data/lib/atatus/config/bytes.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/config/duration.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/config/options.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus
@@ -33,9 +50,9 @@ module Atatus
 
         private
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
         def normalize(val)
-          return unless val
+          return if val.nil?
 
           if @converter
             return @converter.call(val)
@@ -48,12 +65,13 @@ module Atatus
           when :bool then normalize_bool(val)
           when :list then normalize_list(val)
           when :dict then normalize_dict(val)
+          when :url then normalize_url(val)
           else
             # raise "Unknown options type '#{type.inspect}'"
             val
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def normalize_bool(val)
           return val unless val.is_a?(String)
@@ -69,6 +87,11 @@ module Atatus
           return val unless val.is_a?(String)
           Hash[val.split(/[&,]/).map { |kv| kv.split('=') }]
         end
+
+        def normalize_url(val)
+          val = val.to_s
+          val.end_with?('/') ? val.chomp('/') : val
+        end
       end
 
       # @api private
@@ -77,9 +100,8 @@ module Atatus
           @schema ||= {}
         end
 
-        def option(*args)
-          key = args.shift
-          schema[key] = *args
+        def option(key, **args)
+          schema[key] = args
         end
       end
 
@@ -87,11 +109,10 @@ module Atatus
       module InstanceMethods
         def load_schema
           Hash[self.class.schema.map do |key, args|
-            [key, Option.new(key, *args)]
+            [key, Option.new(key, **args)]
           end]
         end
 
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def method_missing(name, *value)
           name_str = name.to_s
 
@@ -110,7 +131,6 @@ module Atatus
             super
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
         def [](key)
           options[key]

data/lib/atatus/config/regexp_list.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/config/wildcard_pattern_list.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  class Config
+    # @api private
+    class WildcardPatternList
+      # @api private
+      class WildcardPattern
+        def initialize(str)
+          @pattern = convert(str)
+        end
+
+        def match?(other)
+          !!@pattern.match(other)
+        end
+
+        alias :match :match?
+
+        private
+
+        def convert(str)
+          case_sensitive = false
+
+          if str.start_with?('(?-i)')
+            str = str.gsub(/^\(\?-\i\)/, '')
+            case_sensitive = true
+          end
+
+          parts =
+            str.chars.each_with_object([]) do |char, arr|
+              arr << (char == '*' ? '.*' : Regexp.escape(char))
+            end
+
+          Regexp.new(
+            '\A' + parts.join + '\Z',
+            case_sensitive ? nil : Regexp::IGNORECASE
+          )
+        end
+      end
+
+      def call(value)
+        value = value.is_a?(String) ? value.split(',') : Array(value)
+        value.map(&WildcardPattern.method(:new))
+      end
+    end
+  end
+end

data/lib/atatus/config.rb

@@ -1,18 +1,29 @@
-# frozen_string_literal: true
-
-require 'logger'
-require 'yaml'
-require 'erb'
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
 
-require 'atatus/util/prefixed_logger'
+# frozen_string_literal: true
 
 require 'atatus/config/options'
 require 'atatus/config/duration'
 require 'atatus/config/bytes'
 require 'atatus/config/regexp_list'
+require 'atatus/config/wildcard_pattern_list'
 
 module Atatus
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
     extend Options
@@ -25,27 +36,30 @@ module Atatus
     option :notify_host,                       type: :string, default: 'https://apm-rx.atatus.com'
     option :trace_threshold,                   type: :int,    default: 2000
     option :config_file,                       type: :string, default: 'config/atatus.yml'
-    option :server_url,                        type: :string, default: ''
+    option :server_url,                        type: :url,    default: ''
     option :secret_token,                      type: :string
+    option :api_key,                           type: :string
 
-    option :active,                            type: :bool,   default: true
     option :api_buffer_size,                   type: :int,    default: 256
     option :api_request_size,                  type: :bytes,  default: '750kb', converter: Bytes.new
     option :api_request_time,                  type: :float,  default: '10s',   converter: Duration.new
+    option :breakdown_metrics,                 type: :bool,   default: true
     option :capture_body,                      type: :string, default: 'off'
     option :capture_headers,                   type: :bool,   default: true
+    option :capture_elasticsearch_queries,     type: :bool,   default: false
     option :capture_env,                       type: :bool,   default: true
     option :central_config,                    type: :bool,   default: true
     option :current_user_email_method,         type: :string, default: 'email'
     option :current_user_id_method,            type: :string, default: 'id'
     option :current_user_username_method,      type: :string, default: 'username'
     option :custom_key_filters,                type: :list,   default: [],      converter: RegexpList.new
-    option :default_tags,                      type: :dict,   default: {}
     option :default_labels,                    type: :dict,   default: {}
+    option :disable_metrics,                   type: :list,   default: [],      converter: WildcardPatternList.new
     option :disable_send,                      type: :bool,   default: false
     option :disable_start_message,             type: :bool,   default: false
-    option :disabled_instrumentations,         type: :list,   default: %w[json]
+    option :disable_instrumentations,          type: :list,   default: %w[json]
     option :disabled_spies,                    type: :list,   default: []
+    option :enabled,                           type: :bool,   default: true
     option :environment,                       type: :string, default: ENV['RAILS_ENV'] || ENV['RACK_ENV']
     option :framework_name,                    type: :string
     option :framework_version,                 type: :string
@@ -65,8 +79,11 @@ module Atatus
     option :proxy_password,                    type: :string
     option :proxy_port,                        type: :int
     option :proxy_username,                    type: :string
+    option :recording,                         type: :bool,   default: true
+    option :sanitize_field_names,              type: :list,   default: [],      converter: WildcardPatternList.new
     option :server_ca_cert,                    type: :string
     option :service_name,                      type: :string
+    option :service_node_name,                 type: :string
     option :service_version,                   type: :string
     option :source_lines_error_app_frames,     type: :int,    default: 5
     option :source_lines_error_library_frames, type: :int,    default: 0
@@ -74,17 +91,17 @@ module Atatus
     option :source_lines_span_library_frames,  type: :int,    default: 0
     option :span_frames_min_duration,          type: :float,  default: '5ms',   converter: Duration.new(default_unit: 'ms')
     option :stack_trace_limit,                 type: :int,    default: 999_999
+    option :transaction_ignore_urls,           type: :list,   default: [],      converter: WildcardPatternList.new
     option :transaction_max_spans,             type: :int,    default: 500
     option :transaction_sample_rate,           type: :float,  default: 1.0
+    option :use_atatus_traceparent_header,    type: :bool,   default: true
+    option :use_legacy_sql_parser,             type: :bool,   default: false
     option :verify_server_cert,                type: :bool,   default: true
-    # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
 
-      custom_logger = options.delete(:logger)
-
       assign(options)
 
       # Pick out config_file specifically as we need it now to load it,
@@ -99,12 +116,11 @@ module Atatus
 
       yield self if block_given?
 
-      @logger = custom_logger || build_logger
+      self.logger ||= build_logger
 
-      @__view_paths = []
-      @__root_path = Dir.pwd
+      @__view_paths ||= []
+      @__root_path ||= Dir.pwd
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_accessor :__view_paths, :__root_path
     attr_accessor :logger
@@ -116,28 +132,32 @@ module Atatus
       update.each { |key, value| send(:"#{key}=", value) }
     end
 
-    # rubocop:disable Metrics/MethodLength
     def available_instrumentations
       %w[
+        action_dispatch
         delayed_job
+        dynamo_db
         elasticsearch
         faraday
         http
         json
         mongo
         net_http
+        rake
         redis
+        resque
         sequel
+        shoryuken
         sidekiq
         sinatra
+        sneakers
+        sucker_punch
         tilt
-        rake
       ]
     end
-    # rubocop:enable Metrics/MethodLength
 
     def enabled_instrumentations
-      available_instrumentations - disabled_instrumentations
+      available_instrumentations - disable_instrumentations
     end
 
     def method_missing(name, *args)
@@ -145,6 +165,15 @@ module Atatus
       warn "The option `#{name}' has been removed."
     end
 
+    def replace_options(new_options)
+      return if new_options.nil? || new_options.empty?
+      options_copy = @options.dup
+      new_options.each do |key, value|
+        options_copy.fetch(key.to_sym).set(value)
+      end
+      @options = options_copy
+    end
+
     def app=(app)
       case app_type?(app)
       when :sinatra
@@ -177,10 +206,83 @@ module Atatus
       @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
     end
 
+    def ssl_context
+      return unless use_ssl?
+
+      @ssl_context ||=
+        OpenSSL::SSL::SSLContext.new.tap do |context|
+          if server_ca_cert
+            context.ca_file = server_ca_cert
+          else
+            context.cert_store =
+              OpenSSL::X509::Store.new.tap(&:set_default_paths)
+          end
+
+          context.verify_mode =
+            if verify_server_cert
+              OpenSSL::SSL::VERIFY_PEER
+            else
+              OpenSSL::SSL::VERIFY_NONE
+            end
+        end
+    end
+
     def inspect
       super.split.first + '>'
     end
 
+    # Deprecations
+
+    def default_tags=(value)
+      warn '[DEPRECATED] The option default_tags has been renamed to ' \
+        'default_labels.'
+      self.default_labels = value
+    end
+
+    def ignore_url_patterns=(value)
+      unless value == self.class.schema[:ignore_url_patterns][:default]
+        warn '[DEPRECATED] The option ignore_url_patterns is being removed. ' \
+          'Consider using transaction_ignore_urls instead.'
+      end
+
+      set(:ignore_url_patterns, value)
+    end
+
+    def custom_key_filters=(value)
+      unless value == self.class.schema[:custom_key_filters][:default]
+        warn '[DEPRECATED] The option custom_key_filters is being removed. ' \
+          'See sanitize_field_names for an alternative.'
+      end
+
+      set(:custom_key_filters, value)
+    end
+
+    def disabled_instrumentations
+      disable_instrumentations
+    end
+
+    def active
+      enabled
+    end
+    alias active? active
+
+    def disabled_instrumentations=(value)
+      warn '[DEPRECATED] The option disabled_instrumentations has been ' \
+        'renamed to disable_instrumentations to align with other agents.'
+      self.disable_instrumentations = value
+    end
+
+    def use_experimental_sql_parser=(value)
+      warn '[DEPRECATED] The new SQL parser is now the default. To use the old one, '
+        'use use_legacy_sql_parser and please report why you wish to do so.'
+    end
+
+    def active=(value)
+      warn '[DEPRECATED] The option active has been renamed to enabled ' \
+        'to align with other agents and with the remote config.'
+      self.enabled = value
+    end
+
     private
 
     def load_config_file
@@ -219,18 +321,18 @@ module Atatus
     def set_sinatra(app)
       self.service_name = format_name(service_name || app.to_s)
       self.framework_name = framework_name || 'Sinatra'
-      self.framework_version = framework_version || Sinatra::VERSION
+      self.framework_version = framework_version || ::Sinatra::VERSION
       self.__root_path = Dir.pwd
     end
 
-    def set_rails(app) # rubocop:disable Metrics/AbcSize
+    def set_rails(app)
       self.service_name ||= format_name(service_name || rails_app_name(app))
       self.framework_name ||= '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
+      self.__view_paths = app.config.paths['app/views'].existent + [::Rails.root.to_s]
     end
 
     def rails_app_name(app)
@@ -242,8 +344,7 @@ module Atatus
     end
 
     def format_name(str)
-      str && str.gsub('::', '_')
+      str&.gsub('::', '_')
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

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

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus
@@ -8,7 +25,7 @@ module Atatus
       # @api private
       class Socket
         def initialize(req)
-          @remote_addr = req.ip
+          @remote_addr = req.env['REMOTE_ADDR']
           @encrypted = req.scheme == 'https'
         end
 

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

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus