atatus 1.7.0 → 2.0.0

data/lib/atatus/config.rb

@@ -17,20 +17,26 @@
 
 # frozen_string_literal: true
 
-require 'atatus/config/options'
-require 'atatus/config/duration'
 require 'atatus/config/bytes'
+require 'atatus/config/duration'
+require 'atatus/config/log_level_map'
+require 'atatus/config/options'
+require 'atatus/config/round_float'
 require 'atatus/config/regexp_list'
 require 'atatus/config/wildcard_pattern_list'
+require 'atatus/deprecations'
+require 'atatus/config/server_info'
 
 module Atatus
   # @api private
   class Config
     extend Options
+    extend Deprecations
 
-    DEPRECATED_OPTIONS = %i[].freeze
+    SANITIZE_FIELD_NAMES_DEFAULT =
+      %w[password passwd pwd secret *key *token* *session* *credit* *card* *auth* set-cookie].freeze
 
-    # rubocop:disable Metrics/LineLength, Layout/ExtraSpacing
+    # rubocop:disable Layout/LineLength, Layout/ExtraSpacing
     option :app_name,                          type: :string
     option :license_key,                       type: :string
     option :notify_host,                       type: :string, default: 'https://apm-rx.atatus.com'
@@ -51,6 +57,7 @@ module Atatus
     option :capture_elasticsearch_queries,     type: :bool,   default: false
     option :capture_env,                       type: :bool,   default: true
     option :central_config,                    type: :bool,   default: true
+    option :cloud_provider,                    type: :string, default: 'auto'
     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'
@@ -73,7 +80,8 @@ module Atatus
     option :ignore_url_patterns,               type: :list,   default: [],      converter: RegexpList.new
     option :instrument,                        type: :bool,   default: true
     option :instrumented_rake_tasks,           type: :list,   default: []
-    option :log_level,                         type: :int,    default: Logger::INFO
+    option :log_ecs_reformatting,              type: :string, default: 'off'
+    option :log_level,                         type: :int,    default: Logger::INFO, converter: LogLevelMap.new
     option :log_path,                          type: :string, default: '-'
     option :metrics_interval,                  type: :int,    default: '30s',   converter: Duration.new
     option :pool_size,                         type: :int,    default: 1
@@ -83,8 +91,8 @@ module Atatus
     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 :sanitize_field_names,              type: :list,   default: SANITIZE_FIELD_NAMES_DEFAULT, converter: WildcardPatternList.new
+    option :server_ca_cert_file,               type: :string
     option :service_name,                      type: :string
     option :service_node_name,                 type: :string
     option :service_version,                   type: :string
@@ -96,12 +104,21 @@ module Atatus
     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 :transaction_sample_rate,           type: :float,  default: 1.0,     converter: RoundFloat.new
     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
+    def log_ecs_formatting
+      log_ecs_reformatting
+    end
+
+    def log_ecs_formatting=(value)
+      @options[:log_ecs_reformatting].set(value)
+    end
+
+    deprecate :log_ecs_formatting, :log_ecs_reformatting
+
+    # rubocop:enable Layout/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
 
@@ -114,19 +131,20 @@ module Atatus
         self.config_file = env_config_file
       end
 
-      assign(load_config_file)
+      assign(load_config_file(self.environment))
       assign(env)
 
       yield self if block_given?
 
-      self.logger ||= build_logger
+      if self.logger.nil? || self.log_path
+        self.logger = build_logger
+      end
 
       @__view_paths ||= []
       @__root_path ||= Dir.pwd
     end
 
-    attr_accessor :__view_paths, :__root_path
-    attr_accessor :logger
+    attr_accessor :__view_paths, :__root_path, :logger
 
     attr_reader :options
 
@@ -138,6 +156,7 @@ module Atatus
     def available_instrumentations
       %w[
         action_dispatch
+        azure_storage_table
         delayed_job
         dynamo_db
         elasticsearch
@@ -147,13 +166,17 @@ module Atatus
         mongo
         net_http
         rake
+        racecar
         redis
         resque
+        s3
         sequel
         shoryuken
         sidekiq
         sinatra
         sneakers
+        sns
+        sqs
         sucker_punch
         tilt
       ]
@@ -163,11 +186,6 @@ module Atatus
       available_instrumentations - disable_instrumentations
     end
 
-    def method_missing(name, *args)
-      return super unless DEPRECATED_OPTIONS.include?(name)
-      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
@@ -214,8 +232,8 @@ module Atatus
 
       @ssl_context ||=
         OpenSSL::SSL::SSLContext.new.tap do |context|
-          if server_ca_cert
-            context.ca_file = server_ca_cert
+          if server_ca_cert_file
+            context.ca_file = server_ca_cert_file
           else
             context.cert_store =
               OpenSSL::X509::Store.new.tap(&:set_default_paths)
@@ -234,66 +252,49 @@ module Atatus
       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
+    def version
+      @version ||= ServerInfo.new(self).version
     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
+    private
 
-      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.'
+    def parse_erb(file)
+      begin
+        file.gsub!(/^\s*#.*$/, '#')
+        ERB.new(file).result(binding)
+      rescue ScriptError, StandardError => e
+        warn "[Atatus] FATAL : Failed ERB processing of atatus.yml file. Please check contents of the file. #{e}"
+        nil
       end
-
-      set(:custom_key_filters, value)
-    end
-
-    def disabled_instrumentations
-      disable_instrumentations
     end
 
-    def active
-      enabled
-    end
-    alias active? active
+    def load_config_file(env)
+      return unless File.exist?(config_file)
 
-    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
+      config = {}
 
-    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
+      begin
+        read = File.read(config_file)
+        evaled = parse_erb(read)
+        
+        # YAML.safe_load(evaled)
 
-    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
+        loaded_config = YAML.load(evaled)
 
-    private
+        if loaded_config.key?("default")
+          unless loaded_config.key?(env)
+            warn "[Atatus] ERROR : atatus.yml does not include '#{env}' section!"
+            loaded_config = loaded_config["default"]          
+          end
+        end
 
-    def load_config_file
-      return unless File.exist?(config_file)
+        config = loaded_config[env] || loaded_config
+      rescue ScriptError, StandardError => e
+        warn "[Atatus] FATAL : Error parsing atatus.yml configuration '#{e}'"
+      end
 
-      read = File.read(config_file)
-      evaled = ERB.new(read).result
-      YAML.safe_load(evaled)
+      config
     end
 
     def load_env
@@ -304,7 +305,25 @@ module Atatus
     end
 
     def build_logger
-      Logger.new(log_path == '-' ? STDOUT : log_path).tap do |logger|
+      if self.log_ecs_reformatting == 'override'
+        begin
+          return build_ecs_logger
+        rescue LoadError
+          logger.info "Attempted to use EcsLogging::Logger but the gem couldn't be " \
+            "loaded so a ::Logger was created instead. Check if you have the `ecs-logging` " \
+            "gem installed and attempt to start the agent again."
+        end
+      end
+
+      Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
+        logger.level = log_level
+      end
+    end
+
+    def build_ecs_logger
+      require 'ecs_logging/logger'
+
+      ::EcsLogging::Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
         logger.level = log_level
       end
     end
@@ -333,9 +352,11 @@ module Atatus
       self.framework_name ||= 'Rails'
       self.framework_version ||= ::Rails::VERSION::STRING
       self.logger ||= ::Rails.logger
+      self.log_level ||= ::Rails.logger.log_level
 
       self.__root_path = ::Rails.root.to_s
-      self.__view_paths = app.config.paths['app/views'].existent + [::Rails.root.to_s]
+      self.__view_paths = app.config.paths['app/views'].existent +
+                          [::Rails.root.to_s]
     end
 
     def rails_app_name(app)

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

@@ -26,10 +26,9 @@ module Atatus
       class Socket
         def initialize(req)
           @remote_addr = req.env['REMOTE_ADDR']
-          @encrypted = req.scheme == 'https'
         end
 
-        attr_reader :remote_addr, :encrypted
+        attr_reader :remote_addr
       end
     end
   end

data/lib/atatus/context/response.rb

@@ -38,9 +38,7 @@ module Atatus
       attr_reader :headers
 
       def headers=(headers)
-        @headers = headers&.each_with_object({}) do |(k, v), hsh|
-          hsh[k] = v.to_s
-        end
+        @headers = headers&.transform_values { |v| v.to_s }
       end
     end
   end

data/lib/atatus/context.rb

@@ -37,16 +37,10 @@ module Atatus
     Service = Struct.new(:framework)
     Framework = Struct.new(:name, :version)
 
-    attr_accessor :request
-    attr_accessor :response
-    attr_accessor :user
-    attr_reader :custom
-    attr_reader :labels
-    attr_reader :service
-    attr_accessor :company
-    attr_accessor :response_body
+    attr_accessor :request, :response, :user
+    attr_reader :custom, :labels, :service
+    attr_accessor :company, :response_body
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def empty?
       return false if labels.any?
       return false if custom.any?
@@ -56,7 +50,6 @@ module Atatus
 
       true
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def set_service(framework_name: nil, framework_version: nil)
       @service = Service.new(

data/lib/atatus/context_builder.rb

@@ -44,7 +44,7 @@ module Atatus
       request = context.request
 
       request.socket = Context::Request::Socket.new(req)
-      request.http_version = build_http_version rack_env
+      request.http_version = build_http_version req
       request.method = req.request_method
       request.url = Context::Request::Url.new(req)
 
@@ -104,8 +104,8 @@ module Atatus
       key.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
     end
 
-    def build_http_version(rack_env)
-      return unless (http_version = rack_env['HTTP_VERSION'])
+    def build_http_version(req)
+      return unless (http_version = req.env['HTTP_VERSION'])
       http_version.gsub(%r{HTTP/}, '')
     end
   end

data/lib/atatus/error.rb

@@ -33,7 +33,7 @@ module Atatus
     end
 
     attr_accessor :id, :culprit, :exception, :log, :transaction_id,
-      :transaction, :context, :parent_id, :trace_id
+      :transaction_name, :transaction, :context, :parent_id, :trace_id
     attr_reader :timestamp
 
     def inspect
@@ -41,6 +41,7 @@ module Atatus
         " culprit:#{culprit}" \
         " timestamp:#{timestamp}" \
         " transaction_id:#{transaction_id}" \
+        " transaction_name:#{transaction_name}" \
         " trace_id:#{trace_id}" \
         " exception:#{exception.inspect}" \
         '>'

data/lib/atatus/error_builder.rb

@@ -74,11 +74,11 @@ module Atatus
       return unless transaction
 
       error.transaction_id = transaction.id
+      error.transaction_name = transaction.name
       error.transaction = {
         sampled: transaction.sampled?,
         type: transaction.type
       }
-      error.transaction[:name] = transaction.name unless transaction.name.nil?
       error.trace_id = transaction.trace_id
       error.parent_id = Atatus.current_span&.id || transaction.id
 

data/lib/atatus/fields.rb

@@ -0,0 +1,98 @@
+# 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
+  # An interface for creating simple, value holding objects that correspond to
+  # object fields in the API.
+  #
+  # Example:
+  #   class MyThing
+  #     include Fields
+  #     field :name
+  #     field :address, default: 'There'
+  #   end
+  #
+  #   MyThing.new(name: 'AJ').to_h
+  #     # => { name: 'AJ' }
+  #   MyThing.new().empty?
+  #     # => true
+  module Fields
+    class Field
+      def initialize(key, default: nil)
+        @key = key
+        @default = default
+      end
+
+      attr_reader :key, :default
+    end
+
+    module InstanceMethods
+      def initialize(**attrs)
+        schema.each do |key, field|
+          send(:"#{key}=", field.default)
+        end
+
+        attrs.each do |key, value|
+          send(:"#{key}=", value)
+        end
+
+        super()
+      end
+
+      def empty?
+        self.class.schema.each do |key, field|
+          next if send(key).nil?
+          return false
+        end
+
+        true
+      end
+
+      def to_h
+        schema.each_with_object({}) do |(key, field), hsh|
+          hsh[key] = send(key)
+        end
+      end
+
+      private
+
+      def schema
+        self.class.schema
+      end
+    end
+
+    module ClassMethods
+      def field(key, default: nil)
+        field = Field.new(key, default: default)
+        schema[key] = field
+
+        attr_accessor(key)
+      end
+
+      attr_reader :schema
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+      cls.include(InstanceMethods)
+
+      cls.instance_variable_set(:@schema, {})
+    end
+  end
+end

data/lib/atatus/graphql.rb

@@ -48,6 +48,7 @@ module Atatus
       # "authorized" => "graphql.authorized",
     }.freeze
 
+    # rubocop:disable Style/ExplicitBlockArgument
     def self.trace(key, data)
       return yield unless KEYS_TO_NAME.key?(key)
       return yield unless (transaction = Atatus.current_transaction)
@@ -69,6 +70,7 @@ module Atatus
 
       results
     end
+    # rubocop:enable Style/ExplicitBlockArgument
 
     class << self
       private

data/lib/atatus/grpc.rb

@@ -25,7 +25,7 @@ module Atatus
       TYPE = 'external'
       SUBTYPE = 'grpc'
 
-      # rubocop:disable Lint/UnusedMethodArgument
+      # rubocop:disable Lint/UnusedMethodArgument, Style/ExplicitBlockArgument
       def request_response(request:, call:, method:, metadata:)
         return yield unless (transaction = Atatus.current_transaction)
         if (trace_context = transaction.trace_context)
@@ -40,7 +40,7 @@ module Atatus
           yield
         end
       end
-      # rubocop:enable Lint/UnusedMethodArgument
+      # rubocop:enable Lint/UnusedMethodArgument, Style/ExplicitBlockArgument
 
       private
 
@@ -50,11 +50,9 @@ module Atatus
 
         split_peer = URI.split(peer)
         destination = Atatus::Span::Context::Destination.new(
-          type: TYPE,
-          name: SUBTYPE,
-          resource: peer,
           address: split_peer[0],
-          port: split_peer[6]
+          port: split_peer[6],
+          service: { type: TYPE, name: SUBTYPE, resource: peer }
         )
         Atatus::Span::Context.new(destination: destination)
       end
@@ -71,7 +69,7 @@ module Atatus
         transaction.done 'success'
       rescue ::Exception => e
         Atatus.report(e, handled: false)
-        transaction.done 'error' if transaction
+        transaction&.done 'error'
         raise
       ensure
         Atatus.end_transaction

data/lib/atatus/instrumenter.rb

@@ -89,7 +89,7 @@ module Atatus
     end
 
     def subscriber=(subscriber)
-      debug 'Registering subscriber'
+      debug 'Registering ActiveSupport::Notifications subscriber'
       @subscriber = subscriber
       @subscriber.register!
     end
@@ -120,11 +120,11 @@ module Atatus
       end
 
       if trace_context
-        samled = trace_context.recorded?
+        sampled = trace_context.recorded?
         sample_rate = trace_context.tracestate.sample_rate
       else
         sampled = random_sample?(config)
-        sample_rate = config.transaction_sample_rate
+        sample_rate = sampled ? config.transaction_sample_rate : 0
       end
 
       transaction =
@@ -150,7 +150,9 @@ module Atatus
 
       transaction.done result
 
-      enqueue.call transaction
+      if transaction.sampled? || @config.version < Config::ServerInfo::VERSION_8_0
+        enqueue.call transaction
+      end
 
       update_transaction_metrics(transaction)
 
@@ -179,7 +181,8 @@ module Atatus
       context: nil,
       trace_context: nil,
       parent: nil,
-      sync: nil
+      sync: nil,
+      exit_span: nil
     )
 
       transaction =
@@ -197,6 +200,15 @@ module Atatus
 
       parent ||= (current_span || current_transaction)
 
+      # To not mess with breakdown metric stats, exit spans MUST not add
+      # sub-spans unless they share the same type and subtype.
+      if parent && parent.is_a?(Span) && parent.exit_span?
+        if parent.type != type || parent.subtype != subtype
+          debug "Skipping new span '#{name}' as its parent is an exit_span"
+          return
+        end
+      end
+
       span = Span.new(
         name: name,
         subtype: subtype,
@@ -207,7 +219,8 @@ module Atatus
         type: type,
         context: context,
         stacktrace_builder: stacktrace_builder,
-        sync: sync
+        sync: sync,
+        exit_span: exit_span
       )
 
       if backtrace && transaction.span_frames_min_duration
@@ -222,8 +235,14 @@ module Atatus
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
 
-    def end_span
-      return unless (span = current_spans.pop)
+    def end_span(span = nil)
+      if span
+        current_spans.delete(span)
+      else
+        span = current_spans.pop
+      end
+
+      return unless span
 
       span.done
 
@@ -239,7 +258,7 @@ module Atatus
     def set_label(key, value)
       return unless current_transaction
 
-      key = key.to_s.gsub(/[\."\*]/, '_').to_sym
+      key = key.to_s.gsub(/[."*]/, '_').to_sym
       current_transaction.context.labels[key] = value
     end
 
@@ -261,7 +280,7 @@ module Atatus
     def set_response_body(response_body)
       return unless current_transaction
       current_transaction.set_response_body(response_body)
-    end
+    end    
 
     def inspect
       '<Atatus::Instrumenter ' \
@@ -283,24 +302,9 @@ module Atatus
         'transaction.type': transaction.type
       }
 
-      @metrics.get(:transaction).timer(
-        :'transaction.duration.sum.us',
-        tags: tags, reset_on_collect: true
-      ).update(transaction.duration)
-
-      @metrics.get(:transaction).counter(
-        :'transaction.duration.count',
-        tags: tags, reset_on_collect: true
-      ).inc!
-
       return unless transaction.sampled?
       return unless transaction.breakdown_metrics
 
-      @metrics.get(:breakdown).counter(
-        :'transaction.breakdown.count',
-        tags: tags, reset_on_collect: true
-      ).inc!
-
       span_tags = tags.merge('span.type': 'app')
 
       @metrics.get(:breakdown).timer(