atatus 1.3.0 → 1.4.0

data/lib/atatus/rails.rb

@@ -1,14 +1,31 @@
+# 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
 
+require 'atatus/railtie'
 require 'atatus/subscriber'
+require 'atatus/normalizers/rails'
 
 module Atatus
   # Module for explicitly starting the Atatus agent and hooking into Rails.
   # It is recommended to use the Railtie instead.
   module Rails
     extend self
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     # Start the Atatus agent and hook into Rails.
     # Note that the agent won't be started if the Rails console is being used.
     #
@@ -16,11 +33,13 @@ module Atatus
     # @return [true, nil] true if the agent was started, nil otherwise.
     def start(config)
       config = Config.new(config) unless config.is_a?(Config)
+
       if (reason = should_skip?(config))
         unless config.disable_start_message?
           config.logger.info "Skipping because: #{reason}. " \
             "Start manually with `Atatus.start'"
         end
+
         return
       end
 
@@ -28,24 +47,21 @@ module Atatus
         attach_subscriber(agent)
       end
 
-      if Atatus.running? &&
-         !Atatus.agent.config.disabled_instrumentations.include?(
-           'action_dispatch'
-         )
-        require 'atatus/spies/action_dispatch'
-      end
       Atatus.running?
     rescue StandardError => e
-      config.logger.error format('Failed to start: %s', e.message)
-      config.logger.error "Backtrace:\n" + e.backtrace.join("\n")
+      if config.disable_start_message?
+        config.logger.error format('Failed to start: %s', e.message)
+        config.logger.error "Backtrace:\n" + e.backtrace.join("\n")
+      else
+        puts format('Failed to start: %s', e.message)
+        puts "Backtrace:\n" + e.backtrace.join("\n")
+      end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     private
 
     def should_skip?(_config)
-      if ::Rails.const_defined? 'Rails::Console'
+      if ::Rails.const_defined?('Console', false)
         return 'Rails console'
       end
 

data/lib/atatus/railtie.rb

@@ -1,6 +1,21 @@
-# frozen_string_literal: true
+# 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.
 
-require 'atatus/rails'
+# frozen_string_literal: true
 
 module Atatus
   # @api private
@@ -9,13 +24,11 @@ module Atatus
 
     Config.schema.each do |key, args|
       next unless args.length > 1
-      config.atatus[key] = args.last[:default]
+      config.atatus[key] = args[:default]
     end
 
     initializer 'atatus.initialize' do |app|
-      config = Config.new(app.config.atatus).tap do |c|
-        c.app = app
-
+      config = Config.new(app.config.atatus.merge(app: app)).tap do |c|
         # Prepend Rails.root to log_path if present
         if c.log_path && !c.log_path.start_with?('/')
           c.log_path = ::Rails.root.join(c.log_path)

data/lib/atatus/resque.rb

@@ -0,0 +1,29 @@
+# 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
+  # Defines a before_first_fork hook for starting the Atatus agent
+  # with Resque.
+  module Resque
+    ::Resque.before_first_fork do
+      ::Resque.logger.debug('Starting Atatus agent')
+      Atatus.start
+    end
+  end
+end

data/lib/atatus/sinatra.rb

@@ -0,0 +1,53 @@
+# 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
+  # Module for starting the Atatus agent and hooking into Sinatra.
+  module Sinatra
+    extend self
+    # Start the Atatus 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)
+
+      Atatus.start(config)
+      Atatus.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&.gsub('::', '_')
+    end
+  end
+end

data/lib/atatus/span.rb

@@ -1,7 +1,21 @@
-# frozen_string_literal: true
+# 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.
 
-require 'securerandom'
-require 'forwardable'
+# frozen_string_literal: true
 
 require 'atatus/span/context'
 
@@ -9,22 +23,24 @@ module Atatus
   # @api private
   class Span
     extend Forwardable
-
-    def_delegators :@trace_context, :trace_id, :parent_id, :id
+    include ChildDurations::Methods
 
     DEFAULT_TYPE = 'Custom'
     DEFAULT_SUBTYPE = 'Ruby'
 
-    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:disable Metrics/ParameterLists
     def initialize(
       name:,
-      transaction_id:,
+      transaction:,
       trace_context:,
+      parent:,
       type: nil,
       subtype: nil,
       action: nil,
       context: nil,
-      stacktrace_builder: nil
+      stacktrace_builder: nil,
+      sync: nil,
+      sample_rate: nil
     )
       @name = name
 
@@ -36,13 +52,18 @@ module Atatus
         @action = action
       end
 
-      @transaction_id = transaction_id
-      @trace_context = trace_context
+      @transaction = transaction
+      @transaction_id = transaction.id
+      @parent = parent
+      @trace_context = trace_context || parent.trace_context.child
+      @sample_rate = transaction.sample_rate
 
-      @context = context || Span::Context.new
+      @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
     end
-    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:enable Metrics/ParameterLists
+
+    def_delegators :@trace_context, :trace_id, :parent_id, :id
 
     attr_accessor(
       :action,
@@ -55,8 +76,12 @@ module Atatus
     attr_reader(
       :context,
       :duration,
+      :parent,
+      :sample_rate,
+      :self_time,
       :stacktrace,
       :timestamp,
+      :transaction,
       :transaction_id
     )
 
@@ -65,21 +90,25 @@ module Atatus
     def start(clock_start = Util.monotonic_micros)
       @timestamp = Util.micros
       @clock_start = clock_start
+      @parent.child_started
       self
     end
 
     def stop(clock_end = Util.monotonic_micros)
       @duration ||= (clock_end - @clock_start)
+      @parent.child_stopped
+      @self_time = @duration - child_durations.duration
       self
     end
 
     def done(clock_end: Util.monotonic_micros)
       stop clock_end
+      self
+    end
 
+    def prepare_for_serialization!
       # build_stacktrace! if should_build_stacktrace?
       self.original_backtrace = nil # release original
-
-      self
     end
 
     def stopped?
@@ -97,7 +126,7 @@ module Atatus
     # relations
 
     def inspect
-      "<Atatus::Span id:#{id}" \
+      "<Atatus::Span id:#{trace_context&.id}" \
         " name:#{name.inspect}" \
         " type:#{type.inspect}" \
         '>'

data/lib/atatus/span/context.rb

@@ -1,40 +1,55 @@
+# 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
   class Span
     # @api private
     class Context
-      def initialize(db: nil, http: nil, labels: {})
-        @sync = true
-        @db = db && Db.new(db)
-        @http = http && Http.new(http)
+      def initialize(
+        db: nil,
+        destination: nil,
+        http: nil,
+        labels: {},
+        sync: nil
+      )
+        @sync = sync
+        @db = db && Db.new(**db)
+        @http = http && Http.new(**http)
+        @destination =
+          case destination
+          when Destination then destination
+          when Hash then Destination.new(**destination)
+          end
         @labels = labels
       end
 
-      attr_accessor :sync, :db, :http, :labels
-
-      # @api private
-      class Db
-        def initialize(instance: nil, statement: nil, type: nil, user: nil)
-          @instance = instance
-          @statement = statement
-          @type = type
-          @user = user
-        end
-
-        attr_accessor :instance, :statement, :type, :user
-      end
-
-      # @api private
-      class Http
-        def initialize(url: nil, status_code: nil, method: nil)
-          @url = url
-          @status_code = status_code
-          @method = method
-        end
-
-        attr_accessor :url, :status_code, :method
-      end
+      attr_reader(
+        :db,
+        :destination,
+        :http,
+        :labels,
+        :sync
+      )
     end
   end
 end
+
+require 'atatus/span/context/db'
+require 'atatus/span/context/http'
+require 'atatus/span/context/destination'

data/lib/atatus/span/context/db.rb

@@ -0,0 +1,43 @@
+# 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
+  class Span
+    class Context
+      # @api private
+      class Db
+        def initialize(
+          instance: nil,
+          statement: nil,
+          type: nil,
+          user: nil,
+          rows_affected: nil
+        )
+          @instance = instance
+          @statement = statement
+          @type = type
+          @user = user
+          @rows_affected = rows_affected
+        end
+
+        attr_accessor :instance, :statement, :type, :user, :rows_affected
+      end
+    end
+  end
+end