elastic-apm 3.0.0 → 3.1.0

data/lib/elastic_apm/instrumenter.rb

@@ -47,7 +47,7 @@ module ElasticAPM
       @current = Current.new
     end
 
-    attr_reader :config, :stacktrace_builder, :enqueue
+    attr_reader :stacktrace_builder, :enqueue
 
     def start
       debug 'Starting instrumenter'
@@ -82,6 +82,7 @@ module ElasticAPM
     def start_transaction(
       name = nil,
       type = nil,
+      config:,
       context: nil,
       trace_context: nil
     )
@@ -92,7 +93,7 @@ module ElasticAPM
           "Transactions may not be nested.\nAlready inside #{transaction}"
       end
 
-      sampled = trace_context ? trace_context.recorded? : random_sample?
+      sampled = trace_context ? trace_context.recorded? : random_sample?(config)
 
       transaction =
         Transaction.new(
@@ -101,7 +102,7 @@ module ElasticAPM
           context: context,
           trace_context: trace_context,
           sampled: sampled,
-          labels: config.default_labels
+          config: config
         )
 
       transaction.start
@@ -149,7 +150,7 @@ module ElasticAPM
 
       transaction.inc_started_spans!
 
-      if transaction.max_spans_reached?(config)
+      if transaction.max_spans_reached?
         transaction.inc_dropped_spans!
         return
       end
@@ -167,7 +168,7 @@ module ElasticAPM
         stacktrace_builder: stacktrace_builder
       )
 
-      if backtrace && config.span_frames_min_duration?
+      if backtrace && transaction.config.span_frames_min_duration?
         span.original_backtrace = backtrace
       end
 
@@ -205,7 +206,7 @@ module ElasticAPM
 
     def set_user(user)
       return unless current_transaction
-      current_transaction.context.user = Context::User.infer(config, user)
+      current_transaction.set_user(user)
     end
 
     def inspect
@@ -216,7 +217,7 @@ module ElasticAPM
 
     private
 
-    def random_sample?
+    def random_sample?(config)
       rand <= config.transaction_sample_rate
     end
   end

data/lib/elastic_apm/normalizers.rb

@@ -56,13 +56,4 @@ module ElasticAPM # :nodoc:
       end
     end
   end
-
-  %w[
-    action_controller
-    action_mailer
-    action_view
-    active_record
-  ].each do |lib|
-    require "elastic_apm/normalizers/#{lib}"
-  end
 end

data/lib/elastic_apm/normalizers/rails.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+%w[
+  action_controller
+  action_mailer
+  action_view
+  active_record
+].each do |lib|
+  require "elastic_apm/normalizers/rails/#{lib}"
+end

data/lib/elastic_apm/rails.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'elastic_apm/subscriber'
+require 'elastic_apm/normalizers/rails'
 
 module ElasticAPM
   # Module for explicitly starting the ElasticAPM agent and hooking into Rails.

data/lib/elastic_apm/sinatra.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # Module for starting the ElasticAPM agent and hooking into Sinatra.
+  module Sinatra
+    extend self
+    # Start the ElasticAPM agent and hook into Sinatra.
+    #
+    # @param app [Sinatra::Base] A Sinatra app.
+    # @param config [Config, Hash] An instance of Config or a Hash config.
+    # @return [true, nil] true if the agent was started, nil otherwise.
+    def start(app, config)
+      config = Config.new(config) unless config.is_a?(Config)
+      configure_app(app, config)
+
+      ElasticAPM.start(config)
+      ElasticAPM.running?
+    rescue StandardError => e
+      config.logger.error format('Failed to start: %s', e.message)
+      config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+    end
+
+    private
+
+    def configure_app(app, config)
+      config.service_name ||= format_name(app.to_s)
+      config.framework_name ||= 'Sinatra'
+      config.framework_version ||= ::Sinatra::VERSION
+      config.__root_path ||= Dir.pwd
+    end
+
+    def format_name(str)
+      str && str.gsub('::', '_')
+    end
+  end
+end

data/lib/elastic_apm/transaction.rb

@@ -13,22 +13,25 @@ module ElasticAPM
 
     DEFAULT_TYPE = 'custom'
 
-    # rubocop:disable Metrics/ParameterLists
+    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
     def initialize(
       name = nil,
       type = nil,
       sampled: true,
       context: nil,
-      labels: nil,
+      config:,
       trace_context: nil
     )
       @name = name
       @type = type || DEFAULT_TYPE
+      @config = config
 
       @sampled = sampled
 
       @context = context || Context.new # TODO: Lazy generate this?
-      Util.reverse_merge!(@context.labels, labels) if labels
+      if config.default_labels
+        Util.reverse_merge!(@context.labels, config.default_labels)
+      end
 
       @trace_context = trace_context || TraceContext.new(recorded: sampled)
 
@@ -37,12 +40,12 @@ module ElasticAPM
 
       @notifications = [] # for AS::Notifications
     end
-    # rubocop:enable Metrics/ParameterLists
+    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
 
     attr_accessor :name, :type, :result
 
     attr_reader :context, :duration, :started_spans, :dropped_spans,
-      :timestamp, :trace_context, :notifications
+      :timestamp, :trace_context, :notifications, :config
 
     def sampled?
       @sampled
@@ -82,7 +85,7 @@ module ElasticAPM
       @dropped_spans += 1
     end
 
-    def max_spans_reached?(config)
+    def max_spans_reached?
       started_spans > config.transaction_max_spans
     end
 
@@ -92,6 +95,10 @@ module ElasticAPM
       context.response = Context::Response.new(*args)
     end
 
+    def set_user(user)
+      context.user = Context::User.infer(config, user)
+    end
+
     def inspect
       "<ElasticAPM::Transaction id:#{id}" \
         " name:#{name.inspect} type:#{type.inspect}>"

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

@@ -13,7 +13,8 @@ module ElasticAPM
             tags: mixed_object(context.labels),
             request: build_request(context.request),
             response: build_response(context.response),
-            user: build_user(context.user)
+            user: build_user(context.user),
+            service: build_service(context.service)
           }
         end
 
@@ -79,6 +80,17 @@ module ElasticAPM
             hash: keyword_field(url.hash)
           }
         end
+
+        def build_service(service)
+          return unless service
+
+          {
+            framework: {
+              name: keyword_field(service.framework.name),
+              version: keyword_field(service.framework.version)
+            }
+          }
+        end
       end
     end
   end

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -65,6 +65,7 @@ files:
 - ".pre-commit-config.yaml"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.asciidoc
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -97,6 +98,7 @@ files:
 - docs/metrics.asciidoc
 - docs/opentracing.asciidoc
 - docs/release-notes.asciidoc
+- docs/set-up.asciidoc
 - docs/supported-technologies.asciidoc
 - elastic-apm.gemspec
 - lib/elastic-apm.rb
@@ -136,13 +138,15 @@ files:
 - lib/elastic_apm/middleware.rb
 - lib/elastic_apm/naively_hashable.rb
 - lib/elastic_apm/normalizers.rb
-- lib/elastic_apm/normalizers/action_controller.rb
-- lib/elastic_apm/normalizers/action_mailer.rb
-- lib/elastic_apm/normalizers/action_view.rb
-- lib/elastic_apm/normalizers/active_record.rb
+- lib/elastic_apm/normalizers/rails.rb
+- lib/elastic_apm/normalizers/rails/action_controller.rb
+- lib/elastic_apm/normalizers/rails/action_mailer.rb
+- lib/elastic_apm/normalizers/rails/action_view.rb
+- lib/elastic_apm/normalizers/rails/active_record.rb
 - lib/elastic_apm/opentracing.rb
 - lib/elastic_apm/rails.rb
 - lib/elastic_apm/railtie.rb
+- lib/elastic_apm/sinatra.rb
 - lib/elastic_apm/span.rb
 - lib/elastic_apm/span/context.rb
 - lib/elastic_apm/span_helpers.rb