elastic-apm 2.1.2 → 2.2.0

data/lib/elastic_apm/span.rb

@@ -13,55 +13,52 @@ module ElasticAPM
     def initialize(
       name,
       type = nil,
-      transaction: nil,
-      parent: nil,
+      transaction_id: nil,
+      parent_id: nil,
       context: nil,
-      stacktrace_builder: nil
+      stacktrace_builder: nil,
+      trace_context: nil
     )
       @name = name
       @type = type || DEFAULT_TYPE
 
-      @id = SecureRandom.hex(8)
+      @transaction_id = transaction_id
 
-      self.transaction = transaction
-      self.parent = parent
+      @parent_id = parent_id
+      @trace_context = trace_context || TraceContext.for_span
 
-      @context = context
+      @context = context || Span::Context.new
       @stacktrace_builder = stacktrace_builder
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :original_backtrace, :parent
-    attr_reader :id, :context, :stacktrace, :duration,
-      :timestamp, :transaction_id, :trace_id
+    attr_accessor :name, :type, :original_backtrace, :parent_id, :trace_context
+    attr_reader :context, :stacktrace, :duration, :timestamp, :transaction_id
 
-    def transaction=(transaction)
-      @transaction_id = transaction&.id
-      @trace_id = transaction&.trace_id
+    def id
+      trace_context&.span_id
     end
 
-    def parent_id
-      @parent&.id || transaction_id
+    def trace_id
+      trace_context&.trace_id
     end
 
     # life cycle
 
-    def start
-      @timestamp = Util.micros
+    def start(timestamp = Util.micros)
+      @timestamp = timestamp
 
       self
     end
 
-    def stop
-      @duration = Util.micros - timestamp
+    def stop(end_timestamp = Util.micros)
+      @duration ||= (end_timestamp - timestamp)
     end
 
-    def done
-      stop
+    def done(end_time: Util.micros)
+      stop end_time
 
-      if should_build_stacktrace?
-        build_stacktrace
-      end
+      build_stacktrace! if should_build_stacktrace?
 
       self
     end
@@ -89,13 +86,13 @@ module ElasticAPM
 
     private
 
-    def should_build_stacktrace?
-      @stacktrace_builder && original_backtrace && long_enough_for_stacktrace?
+    def build_stacktrace!
+      @stacktrace = @stacktrace_builder.build(original_backtrace, type: :span)
+      self.original_backtrace = nil # release original
     end
 
-    def build_stacktrace
-      @stacktrace = @stacktrace_builder.build(original_backtrace, type: :span)
-      self.original_backtrace = nil # release it
+    def should_build_stacktrace?
+      @stacktrace_builder && original_backtrace && long_enough_for_stacktrace?
     end
 
     def long_enough_for_stacktrace?

data/lib/elastic_apm/span/context.rb

@@ -4,12 +4,14 @@ module ElasticAPM
   class Span
     # @api private
     class Context
-      def initialize(db: nil, http: nil)
+      def initialize(db: nil, http: nil, tags: {})
+        @sync = true
         @db = db && Db.new(db)
         @http = http && Http.new(http)
+        @tags = tags
       end
 
-      attr_accessor :sync, :db, :http
+      attr_accessor :sync, :db, :http, :tags
 
       # @api private
       class Db

data/lib/elastic_apm/spies/faraday.rb

@@ -26,11 +26,10 @@ module ElasticAPM
 
             ElasticAPM.with_span name, type do |span|
               ElasticAPM::Spies::NetHTTPSpy.disable_in do
-                id = span&.id || transaction.id
+                trace_context = span&.trace_context || transaction.trace_context
 
                 run_request_without_apm(method, url, body, headers) do |req|
-                  req['Elastic-Apm-Traceparent'] =
-                    transaction.traceparent.to_header(span_id: id)
+                  req['Elastic-Apm-Traceparent'] = trace_context.to_header
 
                   yield req if block_given?
                 end

data/lib/elastic_apm/spies/http.rb

@@ -5,7 +5,7 @@ module ElasticAPM
   module Spies
     # @api private
     class HTTPSpy
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
       def install
         ::HTTP::Client.class_eval do
           alias perform_without_apm perform
@@ -22,17 +22,14 @@ module ElasticAPM
             type = "ext.http_rb.#{method}"
 
             ElasticAPM.with_span name, type do |span|
-              id = span&.id || transaction.id
-
-              req['Elastic-Apm-Traceparent'] =
-                transaction.traceparent.to_header(span_id: id)
-
+              trace_context = span&.trace_context || transaction.trace_context
+              req['Elastic-Apm-Traceparent'] = trace_context.to_header
               perform_without_apm(req, options)
             end
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
     end
 
     register 'HTTP', 'http', HTTPSpy.new

data/lib/elastic_apm/spies/net_http.rb

@@ -49,11 +49,8 @@ module ElasticAPM
             type = "ext.net_http.#{method}"
 
             ElasticAPM.with_span name, type do |span|
-              id = span&.id || transaction.id
-
-              req['Elastic-Apm-Traceparent'] =
-                transaction.traceparent.to_header(span_id: id)
-
+              trace_context = span&.trace_context || transaction.trace_context
+              req['Elastic-Apm-Traceparent'] = trace_context.to_header
               request_without_apm(req, body, &block)
             end
           end

data/lib/elastic_apm/sql_summarizer.rb

@@ -6,7 +6,7 @@ module ElasticAPM
   # @api private
   class SqlSummarizer
     DEFAULT = 'SQL'
-    TABLE_REGEX = %{["'`]?([A-Za-z0-9]+)}
+    TABLE_REGEX = %{["'`]?([A-Za-z0-9_]+)}
 
     REGEXES = {
       /^BEGIN/i => 'BEGIN',

data/lib/elastic_apm/{traceparent.rb → trace_context.rb}

@@ -2,20 +2,41 @@
 
 module ElasticAPM
   # @api private
-  class Traceparent
+  class TraceContext
     class InvalidTraceparentHeader < StandardError; end
 
     VERSION = '00'
     HEX_REGEX = /[^[:xdigit:]]/.freeze
 
-    def initialize
-      @version = VERSION
+    def initialize(
+      version: VERSION,
+      trace_id: nil,
+      span_id: nil,
+      recorded: true
+    )
+      @version = version
+      @trace_id = trace_id
+      @span_id = span_id
+      @recorded = recorded
     end
 
-    def self.from_transaction(transaction)
+    attr_accessor :version, :trace_id, :span_id, :recorded
+
+    alias :recorded? :recorded
+
+    def self.for_transaction(sampled: true)
       new.tap do |t|
         t.trace_id = SecureRandom.hex(16)
-        t.recorded = transaction.sampled?
+        t.span_id = SecureRandom.hex(8)
+        t.recorded = sampled
+      end
+    end
+
+    def self.for_span
+      new.tap do |t|
+        t.trace_id = SecureRandom.hex(16)
+        t.span_id = SecureRandom.hex(8)
+        t.recorded = true
       end
     end
 
@@ -36,10 +57,6 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/AbcSize
 
-    attr_accessor :header, :version, :trace_id, :span_id, :recorded
-
-    alias :recorded? :recorded
-
     def flags=(flags)
       @flags = flags
 
@@ -54,8 +71,11 @@ module ElasticAPM
       format('%02x', flags.to_i(2))
     end
 
-    def to_header(span_id: nil)
-      span_id ||= self.span_id
+    def child
+      dup.tap { |tc| tc.span_id = SecureRandom.hex(8) }
+    end
+
+    def to_header
       format('%s-%s-%s-%s', version, trace_id, span_id, hex_flags)
     end
   end

data/lib/elastic_apm/transaction.rb

@@ -16,7 +16,7 @@ module ElasticAPM
       sampled: true,
       context: nil,
       tags: nil,
-      traceparent: nil
+      trace_context: nil
     )
       @name = name
       @type = type || DEFAULT_TYPE
@@ -26,13 +26,11 @@ module ElasticAPM
       @context = context || Context.new # TODO: Lazy generate this?
       Util.reverse_merge!(@context.tags, tags) if tags
 
-      @id = SecureRandom.hex(8)
-
-      if traceparent
-        @traceparent = traceparent
-        @parent_id = traceparent.span_id
+      if trace_context
+        @parent_id = trace_context.span_id
+        @trace_context = trace_context
       else
-        @traceparent = Traceparent.from_transaction(self)
+        @trace_context = TraceContext.for_transaction(sampled: sampled)
       end
 
       @started_spans = 0
@@ -44,8 +42,12 @@ module ElasticAPM
 
     attr_accessor :name, :type, :result
 
-    attr_reader :id, :context, :duration, :started_spans, :dropped_spans,
-      :timestamp, :traceparent, :notifications, :parent_id
+    attr_reader :context, :duration, :started_spans, :dropped_spans,
+      :timestamp, :trace_context, :notifications, :parent_id
+
+    def id
+      trace_context.span_id
+    end
 
     def sampled?
       @sampled
@@ -62,24 +64,24 @@ module ElasticAPM
     deprecate :done?, :stopped?
 
     def trace_id
-      traceparent&.trace_id
+      trace_context&.trace_id
     end
 
     # life cycle
 
-    def start
-      @timestamp = Util.micros
+    def start(timestamp = Util.micros)
+      @timestamp = timestamp
       self
     end
 
-    def stop
+    def stop(end_timestamp = Util.micros)
       raise 'Transaction not yet start' unless timestamp
-      @duration = Util.micros - timestamp
+      @duration = end_timestamp - timestamp
       self
     end
 
-    def done(result = nil)
-      stop
+    def done(result = nil, end_time: Util.micros)
+      stop end_time
       self.result = result if result
       self
     end

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

@@ -9,6 +9,7 @@ module ElasticAPM
 
         KEY_FILTERS = [
           /passw(or)?d/i,
+          /auth/i,
           /^pw$/,
           /secret/i,
           /token/i,

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

@@ -46,7 +46,7 @@ module ElasticAPM
         end
 
         def build_user(user)
-          return unless user
+          return if !user || user.empty?
 
           {
             id: keyword_field(user.id),

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

@@ -37,11 +37,10 @@ module ElasticAPM
           def build(context)
             return unless context
 
-            {
-              sync: context.sync,
-              db: build_db(context.db),
-              http: build_http(context.http)
-            }
+            { sync: context.sync }.tap do |base|
+              base[:db] = build_db(context.db) if context.db
+              base[:http] = build_http(context.http) if context.http
+            end
           end
 
           private

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -75,6 +75,7 @@ files:
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
 - docs/introduction.asciidoc
+- docs/opentracing.asciidoc
 - docs/supported-technologies.asciidoc
 - elastic-apm.gemspec
 - lib/elastic-apm.rb
@@ -109,6 +110,7 @@ files:
 - lib/elastic_apm/normalizers/action_mailer.rb
 - lib/elastic_apm/normalizers/action_view.rb
 - lib/elastic_apm/normalizers/active_record.rb
+- lib/elastic_apm/opentracing.rb
 - lib/elastic_apm/railtie.rb
 - lib/elastic_apm/span.rb
 - lib/elastic_apm/span/context.rb
@@ -133,7 +135,7 @@ files:
 - lib/elastic_apm/stacktrace/frame.rb
 - lib/elastic_apm/stacktrace_builder.rb
 - lib/elastic_apm/subscriber.rb
-- lib/elastic_apm/traceparent.rb
+- lib/elastic_apm/trace_context.rb
 - lib/elastic_apm/transaction.rb
 - lib/elastic_apm/transport/base.rb
 - lib/elastic_apm/transport/connection.rb
@@ -173,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: The official Elastic APM agent for Ruby