elastic-apm 3.10.1 → 3.13.0

data/lib/elastic_apm/trace_context/traceparent.rb

@@ -27,14 +27,12 @@ module ElasticAPM
       TRACE_ID_LENGTH = 16
       ID_LENGTH = 8
 
-      # rubocop:disable Metrics/ParameterLists
       def initialize(
         version: VERSION,
         trace_id: nil,
         span_id: nil,
         id: nil,
-        recorded: true,
-        tracestate: nil
+        recorded: true
       )
         @version = version
         @trace_id = trace_id || hex(TRACE_ID_LENGTH)
@@ -42,11 +40,9 @@ module ElasticAPM
         @parent_id = span_id
         @id = id || hex(ID_LENGTH)
         @recorded = recorded
-        @tracestate = tracestate
       end
-      # rubocop:enable Metrics/ParameterLists
 
-      attr_accessor :version, :id, :trace_id, :parent_id, :recorded, :tracestate
+      attr_accessor :version, :id, :trace_id, :parent_id, :recorded
 
       alias :recorded? :recorded
 

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -17,26 +17,131 @@
 
 # frozen_string_literal: true
 
+require 'elastic_apm/util/precision_validator'
+
 module ElasticAPM
   class TraceContext
     # @api private
     class Tracestate
-      def initialize(values = [])
-        @values = values
+      # @api private
+      class Entry
+        def initialize(key, value)
+          @key = key
+          @value = value
+        end
+
+        attr_reader :key, :value
+
+        def to_s
+          "#{key}=#{value}"
+        end
       end
 
-      attr_accessor :values
+      # @api private
+      class EsEntry
+        ASSIGN = ':'
+        SPLIT = ';'
+
+        SHORT_TO_LONG = { 's' => 'sample_rate' }.freeze
+        LONG_TO_SHORT = { 'sample_rate' => 's' }.freeze
+
+        def initialize(values = nil)
+          parse(values)
+        end
+
+        attr_reader :sample_rate
+
+        def key
+          'es'
+        end
+
+        def value
+          LONG_TO_SHORT.map do |l, s|
+            "#{s}#{ASSIGN}#{send(l)}"
+          end.join(SPLIT)
+        end
+
+        def empty?
+          !sample_rate
+        end
+
+        def sample_rate=(val)
+          @sample_rate = Util::PrecisionValidator.validate(
+            val, precision: 4, minimum: 0.0001
+          )
+        end
+
+        def to_s
+          return nil if empty?
+
+          "es=#{value}"
+        end
+
+        private
+
+        def parse(values)
+          return unless values
+
+          values.split(SPLIT).map do |kv|
+            k, v = kv.split(ASSIGN)
+            next unless SHORT_TO_LONG.key?(k)
+            send("#{SHORT_TO_LONG[k]}=", v)
+          end
+        end
+      end
+
+      extend Forwardable
+
+      def initialize(entries: {}, sample_rate: nil)
+        @entries = entries
+
+        self.sample_rate = sample_rate if sample_rate
+      end
+
+      attr_accessor :entries
+
+      def_delegators :es_entry, :sample_rate, :sample_rate=
 
       def self.parse(header)
-        # HTTP allows multiple headers with the same name, eg. multiple
-        # Set-Cookie headers per response.
-        # Rack handles this by joining the headers under the same key, separated
-        # by newlines, see https://www.rubydoc.info/github/rack/rack/file/SPEC
-        new(String(header).split("\n"))
+        entries =
+          split_by_nl_and_comma(header)
+          .each_with_object({}) do |entry, hsh|
+            k, v = entry.split('=')
+
+            hsh[k] =
+              case k
+              when 'es' then EsEntry.new(v)
+              else Entry.new(k, v)
+              end
+          end
+
+        new(entries: entries)
       end
 
       def to_header
-        values.join(',')
+        return "" unless entries.any?
+
+        entries.values.map(&:to_s).join(',')
+      end
+
+      private
+
+      def es_entry
+        # lazy generate this so we only add it if necessary
+        entries['es'] ||= EsEntry.new
+      end
+
+      class << self
+        private
+
+        def split_by_nl_and_comma(str)
+          # HTTP allows multiple headers with the same name, eg. multiple
+          # Set-Cookie headers per response.
+          # Rack handles this by joining the headers under the same key,
+          # separated by newlines.
+          # See https://www.rubydoc.info/github/rack/rack/file/SPEC
+          String(str).split("\n").map { |s| s.split(',') }.flatten
+        end
       end
     end
   end

data/lib/elastic_apm/transaction.rb

@@ -20,6 +20,17 @@
 module ElasticAPM
   # @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,9 +44,10 @@ module ElasticAPM
     def initialize(
       name = nil,
       type = nil,
+      config:,
       sampled: true,
+      sample_rate: 1,
       context: nil,
-      config:,
       trace_context: nil
     )
       @name = name
@@ -52,13 +64,21 @@ module ElasticAPM
       @default_labels = config.default_labels
 
       @sampled = sampled
+      @sample_rate = sample_rate
 
       @context = context || Context.new # TODO: Lazy generate this?
       if @default_labels
         Util.reverse_merge!(@context.labels, @default_labels)
       end
 
-      @trace_context = trace_context || TraceContext.new(recorded: sampled)
+      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
+          )
+        )
+      end
 
       @started_spans = 0
       @dropped_spans = 0
@@ -67,12 +87,26 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :result
+    attr_accessor :name, :type, :result, :outcome
+
+    attr_reader(
+      :breakdown_metrics,
+      :collect_metrics,
+      :context,
+      :dropped_spans,
+      :duration,
+      :framework_name,
+      :notifications,
+      :self_time,
+      :sample_rate,
+      :span_frames_min_duration,
+      :started_spans,
+      :timestamp,
+      :trace_context,
+      :transaction_max_spans
+    )
 
-    attr_reader :context, :duration, :started_spans, :dropped_spans,
-      :timestamp, :trace_context, :notifications, :self_time,
-      :span_frames_min_duration, :collect_metrics, :breakdown_metrics,
-      :framework_name, :transaction_max_spans
+    alias :collect_metrics? :collect_metrics
 
     def sampled?
       @sampled

data/lib/elastic_apm/transport/connection.rb

@@ -42,11 +42,12 @@ module ElasticAPM
             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
 

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

@@ -17,36 +17,36 @@
 
 # frozen_string_literal: true
 
+require 'elastic_apm/util/deep_dup'
+
 module ElasticAPM
   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
+        # DEPRECATED: Remove these additions in next major version
+        LEGACY_KEY_FILTERS = [/cookie/i, /auth/i].freeze
 
+        # DEPRECATED: Remove this check in next major version
         VALUE_FILTERS = [
           # (probably) credit card number
           /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/
         ].freeze
 
-        attr_accessor :key_filters
+        def initialize(key_patterns:)
+          @key_patterns = key_patterns + LEGACY_KEY_FILTERS
+        end
+
+        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)
+        def strip_from!(obj)
+          return unless obj.is_a?(Hash)
 
           obj.each do |k, v|
             if filter_key?(k)
@@ -65,7 +65,7 @@ module ElasticAPM
         end
 
         def filter_key?(key)
-          @key_filters.any? { |regex| regex.match(key) }
+          @key_patterns.any? { |regex| regex.match(key) }
         end
 
         def filter_value?(value)

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

@@ -26,21 +26,44 @@ module ElasticAPM
       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/elastic_apm/transport/serializers.rb

@@ -45,18 +45,20 @@ module ElasticAPM
         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 ElasticAPM
         end
 
         attr_reader :transaction, :span, :error, :metadata, :metricset
+
         def serialize(resource)
           case resource
           when Transaction

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

@@ -23,14 +23,19 @@ module ElasticAPM
       # @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,7 +64,7 @@ module ElasticAPM
               }
             }
 
-          if node_name = service.node_name
+          if (node_name = service.node_name)
             base[:node] = { name: keyword_field(node_name) }
           end
 
@@ -83,9 +88,44 @@ module ElasticAPM
           }
         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