atatus 1.6.2 → 2.0.0

data/lib/atatus/trace_context.rb

@@ -29,10 +29,9 @@ module Atatus
 
     def initialize(
       traceparent: nil,
-      tracestate: nil,
-      **legacy_traceparent_attrs
+      tracestate: nil
     )
-      @traceparent = traceparent || Traceparent.new(**legacy_traceparent_attrs)
+      @traceparent = traceparent || Traceparent.new
       @tracestate = tracestate || Tracestate.new
     end
 
@@ -42,22 +41,18 @@ module Atatus
       :version, :trace_id, :id, :parent_id, :ensure_parent_id, :recorded?
 
     class << self
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def parse(legacy_header = nil, env: nil, metadata: nil)
-        unless legacy_header || env || metadata
+      def parse(env: nil, metadata: nil)
+        unless env || metadata
           raise ArgumentError, 'TraceContext expects env:, metadata: ' \
             'or single argument header string'
         end
 
-        if legacy_header
-          legacy_parse_from_header(legacy_header)
-        elsif env
+        if env
           trace_context_from_env(env)
         elsif metadata
           trace_context_from_metadata(metadata)
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       private
 
@@ -90,11 +85,6 @@ module Atatus
 
         new(traceparent: parent, tracestate: state)
       end
-
-      def legacy_parse_from_header(header)
-        parent = Traceparent.parse(header)
-        new(traceparent: parent)
-      end
     end
 
     def child
@@ -106,7 +96,7 @@ module Atatus
     def apply_headers
       yield 'Traceparent', traceparent.to_header
 
-      if tracestate
+      if tracestate && !tracestate.to_header.empty?
         yield 'Tracestate', tracestate.to_header
       end
 

data/lib/atatus/transaction.rb

@@ -20,6 +20,17 @@
 module Atatus
   # @api private
   class Transaction
+    # @api private
+    class Outcome
+      FAILURE = "failure"
+      SUCCESS = "success"
+      UNKNOWN = "unknown"
+
+      def self.from_http_status(code)
+        code.to_i >= 500 ? FAILURE : SUCCESS
+      end
+    end
+
     extend Forwardable
     include ChildDurations::Methods
 
@@ -33,10 +44,10 @@ module Atatus
     def initialize(
       name = nil,
       type = nil,
+      config:,
       sampled: true,
       sample_rate: 1,
       context: nil,
-      config:,
       trace_context: nil
     )
       @name = name
@@ -63,7 +74,9 @@ module Atatus
       unless (@trace_context = trace_context)
         @trace_context = TraceContext.new(
           traceparent: TraceContext::Traceparent.new(recorded: sampled),
-          tracestate: TraceContext::Tracestate.new(sample_rate: sampled ? sample_rate : 0)
+          tracestate: TraceContext::Tracestate.new(
+            sample_rate: sampled ? sample_rate : 0
+          )
         )
       end
 
@@ -74,7 +87,7 @@ module Atatus
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :result, :spans, :ruby_time
+    attr_accessor :name, :type, :result, :outcome, :spans, :ruby_time
 
     attr_reader(
       :breakdown_metrics,
@@ -90,7 +103,7 @@ module Atatus
       :started_spans,
       :timestamp,
       :trace_context,
-      :transaction_max_spans 
+      :transaction_max_spans
     )
 
     alias :collect_metrics? :collect_metrics
@@ -148,6 +161,14 @@ module Atatus
       context.user = Context::User.infer(@config, user)
     end
 
+    def set_company(company)
+      context.company = Context::Company.infer(@config, company)
+    end
+
+    def set_response_body(response_body)
+      context.response_body = response_body
+    end
+
     def inspect
       "<Atatus::Transaction id:#{id}" \
         " name:#{name.inspect} type:#{type.inspect}>"

data/lib/atatus/transport/base.rb

@@ -35,7 +35,6 @@ module Atatus
       include Logging
 
       WATCHER_EXECUTION_INTERVAL = 5
-      WATCHER_TIMEOUT_INTERVAL = 4
       WORKER_JOIN_TIMEOUT = 5
 
       def initialize(config)
@@ -112,8 +111,7 @@ module Atatus
 
       def create_watcher
         @watcher = Concurrent::TimerTask.execute(
-          execution_interval: WATCHER_EXECUTION_INTERVAL,
-          timeout_interval: WATCHER_TIMEOUT_INTERVAL
+          execution_interval: WATCHER_EXECUTION_INTERVAL
         ) { ensure_worker_count }
       end
 

data/lib/atatus/transport/connection/http.rb

@@ -74,8 +74,16 @@ module Atatus
           debug '%s: Closing request with reason %s', thread_str, reason
           @closed.make_true
 
-          @wr&.close(reason)
-          return if @request.nil? || @request&.join(5)
+          @wr&.close
+
+          if @request&.join(5)
+            @rd&.close
+            return
+          end
+
+          @rd&.close
+
+          return if @request.nil?
 
           error(
             '%s: APM Server not responding in time, terminating request',
@@ -85,7 +93,7 @@ module Atatus
         end
 
         def closed?
-          @closed.true?
+          @rd.closed? && @closed.true?
         end
 
         def inspect

data/lib/atatus/transport/connection/proxy_pipe.rb

@@ -62,8 +62,7 @@ module Atatus
             @io = Zlib::GzipWriter.new(io)
           end
 
-          def close(reason = nil)
-            debug("Closing writer with reason #{reason}")
+          def close
             io.close
           end
 

data/lib/atatus/transport/connection.rb

@@ -42,11 +42,12 @@ module Atatus
             Metadata.new(config)
           )
         )
-        @url = config.server_url + '/intake/v2/events'
+        @url = "#{config.server_url}/intake/v2/events"
         @mutex = Mutex.new
       end
 
       attr_reader :http
+
       def write(str)
         return false if @config.disable_send
 
@@ -104,7 +105,7 @@ module Atatus
         @close_task&.cancel
         @close_task =
           Concurrent::ScheduledTask.execute(@config.api_request_time) do
-            flush(:timeout)
+            flush(:scheduled_flush)
           end
       end
     end

data/lib/atatus/transport/filters/hash_sanitizer.rb

@@ -17,59 +17,41 @@
 
 # frozen_string_literal: true
 
+require 'atatus/util/deep_dup'
+
 module Atatus
   module Transport
     module Filters
+      # @api private
       class HashSanitizer
         FILTERED = '[FILTERED]'
 
-        KEY_FILTERS = [
-          /passw(or)?d/i,
-          /auth/i,
-          /^pw$/,
-          /secret/i,
-          /token/i,
-          /api[-._]?key/i,
-          /session[-._]?id/i,
-          /(set[-_])?cookie/i
-        ].freeze
-
-        VALUE_FILTERS = [
-          # (probably) credit card number
-          /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/
-        ].freeze
+        def initialize(key_patterns:)
+          @key_patterns = key_patterns
+        end
 
-        attr_accessor :key_filters
+        attr_accessor :key_patterns
 
-        def initialize
-          @key_filters = KEY_FILTERS
+        def strip_from(obj)
+          strip_from!(Util::DeepDup.dup(obj))
         end
 
-        def strip_from!(obj, key_filters = KEY_FILTERS)
-          return unless obj&.is_a?(Hash)
-
-          obj.each do |k, v|
-            if filter_key?(k)
-              next obj[k] = FILTERED
-            end
+        def strip_from!(obj)
+          return unless obj.is_a?(Hash)
 
+          obj.each_pair do |k, v|
             case v
             when Hash
               strip_from!(v)
-            when String
-              if filter_value?(v)
-                obj[k] = FILTERED
-              end
+            else
+              next unless filter_key?(k)
+              obj[k] = FILTERED
             end
           end
         end
 
         def filter_key?(key)
-          @key_filters.any? { |regex| regex.match(key) }
-        end
-
-        def filter_value?(value)
-          VALUE_FILTERS.any? { |regex| regex.match(value) }
+          @key_patterns.any? { |regex| regex.match(key) }
         end
       end
     end

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

@@ -26,21 +26,44 @@ module Atatus
       class SecretsFilter
         def initialize(config)
           @config = config
-          @sanitizer = HashSanitizer.new
-          @sanitizer.key_filters += config.custom_key_filters +
-                                     config.sanitize_field_names
+          @sanitizer =
+            HashSanitizer.new(
+              key_patterns: config.custom_key_filters +
+                            config.sanitize_field_names
+            )
         end
 
         def call(payload)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :headers)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :env)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :cookies)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :response, :headers)
-          @sanitizer.strip_from! payload.dig(:error, :context, :request, :headers)
-          @sanitizer.strip_from! payload.dig(:error, :context, :request, :cookies)
-          @sanitizer.strip_from! payload.dig(:error, :context, :response, :headers)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :body)
-
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :body)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :cookies)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :env)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :headers)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :response, :headers)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :body)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :cookies)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :env)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :headers)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :response, :headers)
+          )
           payload
         end
       end

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

@@ -77,8 +77,7 @@ module Atatus
           return unless socket
 
           {
-            remote_addr: socket.remote_addr,
-            encrypted: socket.encrypted
+            remote_addr: socket.remote_addr
           }
         end
 

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

@@ -23,14 +23,19 @@ module Atatus
       # @api private
       class MetadataSerializer < Serializer
         def build(metadata)
-          {
-            metadata: {
+          base =
+            {
               service: build_service(metadata.service),
               process: build_process(metadata.process),
               system: build_system(metadata.system),
               labels: build_labels(metadata.labels)
             }
-          }
+
+          if metadata.cloud.provider
+            base[:cloud] = build_cloud(metadata.cloud)
+          end
+
+          { metadata: base }
         end
 
         private
@@ -59,8 +64,8 @@ module Atatus
               }
             }
 
-          if node_name = service.node_name
-            base[:node] = { name: keyword_field(node_name) }
+          if (node_name = service.node_name)
+            base[:node] = { configured_name: keyword_field(node_name) }
           end
 
           base
@@ -75,17 +80,58 @@ module Atatus
         end
 
         def build_system(system)
-          {
-            hostname: keyword_field(system.hostname),
+          base = {
+            configured_hostname: keyword_field(system.configured_hostname),
             architecture: keyword_field(system.architecture),
             platform: keyword_field(system.platform),
-            kubernetes: keyword_object(system.kubernetes)
+            kubernetes: keyword_object(system.kubernetes),
+            container: keyword_object(system.container)
           }
+          if system.detected_hostname
+            base[:detected_hostname] = keyword_field(system.detected_hostname)
+          end
+
+          base
+        end
+
+        def build_cloud(cloud)
+          strip_nulls!(
+            provider: cloud.provider,
+            account: {
+              id: keyword_field(cloud.account_id),
+              name: keyword_field(cloud.account_name)
+            },
+            availability_zone: keyword_field(cloud.availability_zone),
+            instance: {
+              id: keyword_field(cloud.instance_id),
+              name: keyword_field(cloud.instance_name)
+            },
+            machine: { type: keyword_field(cloud.machine_type) },
+            project: {
+              id: keyword_field(cloud.project_id),
+              name: keyword_field(cloud.project_name)
+            },
+            region: keyword_field(cloud.region)
+          )
         end
 
         def build_labels(labels)
           keyword_object(labels)
         end
+
+        # A bug in APM Server 7.9 disallows null values in `cloud`
+        def strip_nulls!(hash)
+          hash.each_key do |key|
+            case value = hash[key]
+            when Hash
+              strip_nulls!(value)
+              hash.delete(key) if value.empty?
+            when nil then hash.delete(key)
+            end
+          end
+
+          hash
+        end
       end
     end
   end

data/lib/atatus/transport/serializers/metricset_serializer.rb

@@ -46,8 +46,8 @@ module Atatus
         private
 
         def build_samples(samples)
-          samples.each_with_object({}) do |(key, value), hsh|
-            hsh[key] = { value: value }
+          samples.transform_values do |value|
+            { value: value }
           end
         end
       end

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

@@ -43,14 +43,14 @@ module Atatus
               stacktrace: span.stacktrace.to_a,
               timestamp: span.timestamp,
               trace_id: span.trace_id,
-              sample_rate: span.sample_rate
+              sample_rate: span.sample_rate,
+              outcome: keyword_field(span.outcome)
             }
           }
         end
 
         # @api private
         class ContextSerializer < Serializer
-          # rubocop:disable Metrics/CyclomaticComplexity
           def build(context)
             return unless context
 
@@ -65,9 +65,20 @@ module Atatus
               base[:destination] = build_destination(context.destination)
             end
 
+            if context.message
+              base[:message] = build_message(context.message)
+            end
+
+            if context.service
+              base[:service] = build_service(context.service)
+            end
+
+            if context.links && !context.links.empty?
+              base[:links] = build_links(context.links)
+            end
+
             base
           end
-          # rubocop:enable Metrics/CyclomaticComplexity
 
           private
 
@@ -90,15 +101,50 @@ module Atatus
           end
 
           def build_destination(destination)
-            {
-              service: {
-                name: keyword_field(destination.name),
-                resource: keyword_field(destination.resource),
-                type: keyword_field(destination.type)
-              },
+            return unless destination
+
+            base = {
               address: keyword_field(destination.address),
               port: destination.port
             }
+
+            if (service = destination.service) && !service.empty?
+              base[:service] = service.to_h
+            end
+
+            if (cloud = destination.cloud) && !cloud.empty?
+              base[:cloud] = cloud.to_h
+            end
+
+            base
+          end
+
+          def build_message(message)
+            {
+              queue: {
+                name: keyword_field(message.queue_name)
+              },
+              age: {
+                ms: message.age_ms.to_i
+              }
+            }
+          end
+
+          def build_service(service)
+            {
+              target: {
+                name: keyword_field(service.target&.name),
+                type: keyword_field(service.target&.type)
+              }
+            }
+          end
+
+          def build_links(links)
+            {
+              links: links.map do |link|
+                {"trace_id" => link.trace_id, "span_id" => link.span_id}
+              end
+            }
           end
         end
 

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

@@ -35,6 +35,7 @@ module Atatus
               name: keyword_field(transaction.name),
               type: keyword_field(transaction.type),
               result: keyword_field(transaction.result.to_s),
+              outcome: keyword_field(transaction.outcome),
               duration: ms(transaction.duration),
               timestamp: transaction.timestamp,
               sampled: transaction.sampled?,

data/lib/atatus/transport/serializers.rb

@@ -45,18 +45,20 @@ module Atatus
         def keyword_object(hash)
           return unless hash
 
-          hash.tap do |h|
-            h.each { |k, v| hash[k] = keyword_field(v) }
+          hash.each do |k, v|
+            hash[k] =
+              case v
+              when Hash then keyword_object(v)
+              else keyword_field(v)
+              end
           end
         end
 
         def mixed_object(hash)
           return unless hash
 
-          hash.tap do |h|
-            h.each do |k, v|
-              hash[k] = v.is_a?(String) ? keyword_field(v) : v
-            end
+          hash.each do |k, v|
+            hash[k] = v.is_a?(String) ? keyword_field(v) : v
           end
         end
       end
@@ -72,6 +74,7 @@ module Atatus
         end
 
         attr_reader :transaction, :span, :error, :metadata, :metricset
+
         def serialize(resource)
           case resource
           when Transaction

data/lib/atatus/transport/user_agent.rb

@@ -21,7 +21,8 @@ module Atatus
   module Transport
     # @api private
     class UserAgent
-      def initialize(config)
+      def initialize(config, version: VERSION)
+        @version = version
         @built = build(config)
       end
 
@@ -32,16 +33,22 @@ module Atatus
       private
 
       def build(config)
-        metadata = Metadata.new(config)
+        service = Metadata::ServiceInfo.new(config)
 
         [
-          "atatus-ruby/#{VERSION}",
-          HTTP::Request::USER_AGENT,
-          [
-            metadata.service.runtime.name,
-            metadata.service.runtime.version
-          ].join('/')
-        ].join(' ')
+          "atatus-ruby/#{@version}",
+          formatted_service_info(service)
+        ].compact.join(' ')
+      end
+
+      def formatted_service_info(service)
+        if service.name
+          "(#{[
+                service.name,
+                service.version
+               ].compact.join(' ')
+             })"
+        end
       end
     end
   end

data/lib/atatus/transport/worker.rb

@@ -53,11 +53,12 @@ module Atatus
       end
 
       attr_reader :queue, :filters, :name, :connection, :serializers
+
       def work_forever
         while (msg = queue.pop)
           case msg
           when StopMessage
-            debug 'Stopping worker -- %s', self
+            debug 'Stopping worker [%s]', self
             connection.flush(:halt)
             break
           else