atatus 1.3.0 → 1.4.0

data/lib/atatus/deprecations.rb

@@ -1,3 +1,20 @@
+# 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

data/lib/atatus/error.rb

@@ -1,3 +1,20 @@
+# 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/stacktrace'
@@ -18,5 +35,15 @@ module Atatus
     attr_accessor :id, :culprit, :exception, :log, :transaction_id,
       :transaction, :context, :parent_id, :trace_id
     attr_reader :timestamp
+
+    def inspect
+      "<Atatus::Error id:#{id}" \
+        " culprit:#{culprit}" \
+        " timestamp:#{timestamp}" \
+        " transaction_id:#{transaction_id}" \
+        " trace_id:#{trace_id}" \
+        " exception:#{exception.inspect}" \
+        '>'
+    end
   end
 end

data/lib/atatus/error/exception.rb

@@ -1,3 +1,20 @@
+# 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
@@ -34,6 +51,13 @@ module Atatus
         :cause
       )
 
+      def inspect
+        '<Atatus::Error::Exception' \
+          " type:#{type}" \
+          " message:#{message}" \
+          '>'
+      end
+
       class << self
         private
 

data/lib/atatus/error/log.rb

@@ -1,3 +1,20 @@
+# 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

data/lib/atatus/error_builder.rb

@@ -1,3 +1,20 @@
+# 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
@@ -53,7 +70,6 @@ module Atatus
       error.culprit = stacktrace.frames.first&.function
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def add_current_transaction_fields(error, transaction)
       return unless transaction
 
@@ -71,6 +87,5 @@ module Atatus
       Util.reverse_merge!(error.context.labels, transaction.context.labels)
       Util.reverse_merge!(error.context.custom, transaction.context.custom)
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
   end
 end

data/lib/atatus/grape.rb

@@ -0,0 +1,62 @@
+# 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/subscriber'
+require 'atatus/normalizers/grape'
+
+module Atatus
+  # Module for starting the Atatus agent and hooking into Grape.
+  module Grape
+    extend self
+    # Start the Atatus agent and hook into Grape.
+    #
+    # @param app [Grape::API] A Grape 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).tap do |agent|
+        attach_subscriber(agent)
+      end
+
+      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 ||= app.name
+      config.framework_name ||= 'Grape'
+      config.framework_version ||= ::Grape::VERSION
+      config.logger ||= app.logger
+      config.__root_path ||= Dir.pwd
+    end
+
+    def attach_subscriber(agent)
+      return unless agent
+
+      agent.instrumenter.subscriber = Atatus::Subscriber.new(agent)
+    end
+  end
+end

data/lib/atatus/graphql.rb

@@ -0,0 +1,91 @@
+# 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
+  # @api private
+  module GraphQL
+    TYPE = 'app'
+    SUBTYPE = 'graphql'
+
+    PREFIX = 'GraphQL: '
+    UNNAMED = '[unnamed]'
+    MULTIPLE_QUERIES = '[multiple-queries]'
+    CONCATENATOR = '+'
+    MAX_NUMBER_OF_QUERIES_FOR_NAME = 5
+
+    KEYS_TO_NAME = {
+      'lex' => 'graphql.lex',
+      'parse' => 'graphql.parse',
+      'validate' => 'graphql.validate',
+      'analyze_multiplex' => 'graphql.analyze_multiplex',
+      'analyze_query' => 'graphql.analyze_query',
+      'execute_multiplex' => 'graphql.execute_multiplex',
+      'execute_query' => 'graphql.execute_query',
+      'execute_query_lazy' => 'graphql.execute_query_lazy',
+      'authorized_lazy' => 'graphql.authorized_lazy',
+      'resolve_type' => 'graphql.resolve_type',
+      'resolve_type_lazy' => 'graphql.resolve_type_lazy'
+
+      # These are available but deliberately left out as they are mostly noise.
+      # "execute_field" => "graphql.execute_field",
+      # "execute_field_lazy" => "graphql.execute_field_lazy",
+      # "authorized" => "graphql.authorized",
+    }.freeze
+
+    def self.trace(key, data)
+      return yield unless KEYS_TO_NAME.key?(key)
+      return yield unless (transaction = Atatus.current_transaction)
+
+      if key == 'execute_query'
+        transaction.name =
+          "#{PREFIX}#{query_name(data[:query])}"
+      end
+
+      results =
+        Atatus.with_span(
+          KEYS_TO_NAME.fetch(key, key),
+          TYPE, subtype: SUBTYPE, action: key
+        ) { yield }
+
+      if key == 'execute_multiplex'
+        transaction.name = "#{PREFIX}#{concat_names(results)}"
+      end
+
+      results
+    end
+
+    class << self
+      private
+
+      def query_name(query)
+        query.operation_name || UNNAMED
+      end
+
+      def concat_names(results)
+        if results.length > MAX_NUMBER_OF_QUERIES_FOR_NAME
+          return MULTIPLE_QUERIES
+        end
+
+        results.map do |result|
+          query_name(result.query)
+        end.join(CONCATENATOR)
+      end
+    end
+  end
+end

data/lib/atatus/grpc.rb

@@ -0,0 +1,99 @@
+# 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
+  # @api private
+  class GRPC
+    # @api private
+    class ClientInterceptor < ::GRPC::ClientInterceptor
+      TYPE = 'external'
+      SUBTYPE = 'grpc'
+
+      # rubocop:disable Lint/UnusedMethodArgument
+      def request_response(request:, call:, method:, metadata:)
+        return yield unless (transaction = Atatus.current_transaction)
+        if (trace_context = transaction.trace_context)
+          trace_context.apply_headers { |k, v| metadata[k.downcase] = v }
+        end
+
+        Atatus.with_span(
+          method, TYPE,
+          subtype: SUBTYPE,
+          context: span_context(call)
+        ) do
+          yield
+        end
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      private
+
+      def span_context(call)
+        peer = call.instance_variable_get(:@wrapped)&.peer
+        return unless peer
+
+        split_peer = URI.split(peer)
+        destination = Atatus::Span::Context::Destination.new(
+          type: TYPE,
+          name: SUBTYPE,
+          resource: peer,
+          address: split_peer[0],
+          port: split_peer[6]
+        )
+        Atatus::Span::Context.new(destination: destination)
+      end
+    end
+
+    # @api private
+    class ServerInterceptor < ::GRPC::ClientInterceptor
+      TYPE = 'request'
+
+      # rubocop:disable Lint/UnusedMethodArgument
+      def request_response(request:, call:, method:)
+        transaction = start_transaction(call)
+        yield
+        transaction.done 'success'
+      rescue ::Exception => e
+        Atatus.report(e, handled: false)
+        transaction.done 'error' if transaction
+        raise
+      ensure
+        Atatus.end_transaction
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      private
+
+      def start_transaction(call)
+        Atatus.start_transaction(
+          'grpc',
+          'request',
+          trace_context: trace_context(call)
+        )
+      end
+
+      def trace_context(call)
+        TraceContext.parse(metadata: call.metadata)
+      rescue TraceContext::InvalidTraceparentHeader
+        warn "Couldn't parse invalid trace context header: #{call.metadata}"
+        nil
+      end
+    end
+  end
+end

data/lib/atatus/instrumenter.rb

@@ -1,12 +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
 
 require 'atatus/trace_context'
+require 'atatus/child_durations'
 require 'atatus/span'
 require 'atatus/transaction'
 require 'atatus/span_helpers'
 
 module Atatus
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Instrumenter
     TRANSACTION_KEY = :__atatus_instrumenter_transaction_key
@@ -39,18 +56,22 @@ module Atatus
       end
     end
 
-    def initialize(config, stacktrace_builder:, &enqueue)
+    def initialize(config, metrics:, stacktrace_builder:, &enqueue)
       @config = config
       @stacktrace_builder = stacktrace_builder
       @enqueue = enqueue
+      @metrics = metrics
 
       @current = Current.new
     end
 
-    attr_reader :config, :stacktrace_builder, :enqueue
+    attr_reader :stacktrace_builder, :enqueue
 
     def start
       debug 'Starting instrumenter'
+      # We call register! on @subscriber in case the
+      # instrumenter was stopped and started again
+      @subscriber&.register!
     end
 
     def stop
@@ -59,7 +80,12 @@ module Atatus
       self.current_transaction = nil
       current_spans.pop until current_spans.empty?
 
-      @subscriber.unregister! if @subscriber
+      @subscriber&.unregister!
+    end
+
+    def handle_forking!
+      stop
+      start
     end
 
     def subscriber=(subscriber)
@@ -78,10 +104,10 @@ module Atatus
       @current.transaction = transaction
     end
 
-    # rubocop:disable Metrics/MethodLength
     def start_transaction(
       name = nil,
       type = nil,
+      config:,
       context: nil,
       trace_context: nil
     )
@@ -89,10 +115,17 @@ module Atatus
 
       if (transaction = current_transaction)
         raise ExistingTransactionError,
-          "Transactions may not be nested.\nAlready inside #{transaction}"
+          "Transactions may not be nested.\n" \
+          "Already inside #{transaction.inspect}"
       end
 
-      sampled = trace_context ? trace_context.recorded? : random_sample?
+      if trace_context
+        samled = trace_context.recorded?
+        sample_rate = trace_context.tracestate.sample_rate
+      else
+        sampled = random_sample?(config)
+        sample_rate = config.transaction_sample_rate
+      end
 
       transaction =
         Transaction.new(
@@ -101,14 +134,14 @@ module Atatus
           context: context,
           trace_context: trace_context,
           sampled: sampled,
-          labels: config.default_labels
+          sample_rate: sample_rate,
+          config: config
         )
 
       transaction.start
 
       self.current_transaction = transaction
     end
-    # rubocop:enable Metrics/MethodLength
 
     def end_transaction(result = nil)
       return nil unless (transaction = current_transaction)
@@ -119,6 +152,8 @@ module Atatus
 
       enqueue.call transaction
 
+      update_transaction_metrics(transaction)
+
       transaction
     end
 
@@ -132,8 +167,8 @@ module Atatus
       current_spans.last
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     # rubocop:disable Metrics/ParameterLists
     def start_span(
       name,
@@ -142,32 +177,40 @@ module Atatus
       action: nil,
       backtrace: nil,
       context: nil,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
-      return unless (transaction = current_transaction)
-      return unless transaction.sampled?
-
-      transaction.inc_started_spans!
 
-      if transaction.max_spans_reached?(config)
-        transaction.inc_dropped_spans!
-        return
-      end
+      transaction =
+        case parent
+        when Span
+          parent.transaction
+        when Transaction
+          parent
+        else
+          current_transaction
+        end
+      return unless transaction
+      return unless transaction.sampled?
+      return unless transaction.inc_started_spans!
 
-      parent = current_span || transaction
+      parent ||= (current_span || current_transaction)
 
       span = Span.new(
         name: name,
         subtype: subtype,
         action: action,
-        transaction_id: transaction.id,
-        trace_context: trace_context || parent.trace_context.child,
+        transaction: transaction,
+        parent: parent,
+        trace_context: trace_context,
         type: type,
         context: context,
-        stacktrace_builder: stacktrace_builder
+        stacktrace_builder: stacktrace_builder,
+        sync: sync
       )
 
-      if backtrace && config.span_frames_min_duration?
+      if backtrace && transaction.span_frames_min_duration
         span.original_backtrace = backtrace
       end
 
@@ -176,8 +219,8 @@ module Atatus
       span.start
     end
     # rubocop:enable Metrics/ParameterLists
-    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def end_span
       return unless (span = current_spans.pop)
@@ -186,6 +229,8 @@ module Atatus
 
       enqueue.call span
 
+      update_span_metrics(span)
+
       span
     end
 
@@ -205,7 +250,7 @@ module Atatus
 
     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,9 +261,69 @@ module Atatus
 
     private
 
-    def random_sample?
+    def random_sample?(config)
       rand <= config.transaction_sample_rate
     end
+
+    def update_transaction_metrics(transaction)
+      return unless transaction.collect_metrics?
+
+      tags = {
+        'transaction.name': transaction.name,
+        'transaction.type': transaction.type
+      }
+
+      @metrics.get(:transaction).timer(
+        :'transaction.duration.sum.us',
+        tags: tags, reset_on_collect: true
+      ).update(transaction.duration)
+
+      @metrics.get(:transaction).counter(
+        :'transaction.duration.count',
+        tags: tags, reset_on_collect: true
+      ).inc!
+
+      return unless transaction.sampled?
+      return unless transaction.breakdown_metrics
+
+      @metrics.get(:breakdown).counter(
+        :'transaction.breakdown.count',
+        tags: tags, reset_on_collect: true
+      ).inc!
+
+      span_tags = tags.merge('span.type': 'app')
+
+      @metrics.get(:breakdown).timer(
+        :'span.self_time.sum.us',
+        tags: span_tags, reset_on_collect: true
+      ).update(transaction.self_time)
+
+      @metrics.get(:breakdown).counter(
+        :'span.self_time.count',
+        tags: span_tags, reset_on_collect: true
+      ).inc!
+    end
+
+    def update_span_metrics(span)
+      return unless span.transaction.collect_metrics?
+
+      tags = {
+        'span.type': span.type,
+        'transaction.name': span.transaction.name,
+        'transaction.type': span.transaction.type
+      }
+
+      tags[:'span.subtype'] = span.subtype if span.subtype
+
+      @metrics.get(:breakdown).timer(
+        :'span.self_time.sum.us',
+        tags: tags, reset_on_collect: true
+      ).update(span.self_time)
+
+      @metrics.get(:breakdown).counter(
+        :'span.self_time.count',
+        tags: tags, reset_on_collect: true
+      ).inc!
+    end
   end
-  # rubocop:enable Metrics/ClassLength
 end