atatus 1.3.0 → 1.6.1

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

data/lib/atatus/internal_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
 
 module Atatus

data/lib/atatus/logging.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 'logger'
+# frozen_string_literal: true
 
 module Atatus
   # @api private

data/lib/atatus/metadata/process_info.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/metadata/service_info.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
@@ -13,16 +30,17 @@ module Atatus
 
         attr_reader :name, :version
       end
+
       class Agent < Versioned; end
       class Framework < Versioned; end
       class Language < Versioned; end
       class Runtime < Versioned; end
 
-      # rubocop:disable Metrics/MethodLength
       def initialize(config)
         @config = config
 
         @name = @config.service_name
+        @node_name = @config.service_node_name
         @environment = @config.environment
         @agent = Agent.new(name: 'ruby', version: VERSION)
         @framework = Framework.new(
@@ -33,14 +51,12 @@ module Atatus
         @runtime = lookup_runtime
         @version = @config.service_version || Util.git_sha
       end
-      # rubocop:enable Metrics/MethodLength
 
-      attr_reader :name, :environment, :agent, :framework, :language, :runtime,
-        :version
+      attr_reader :name, :node_name, :environment, :agent, :framework, :language,
+        :runtime, :version
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def lookup_runtime
         case RUBY_ENGINE
         when 'ruby'
@@ -55,7 +71,6 @@ module Atatus
           )
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/atatus/metadata/system_info/container_info.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,7 +51,6 @@ module Atatus
             end
         end
 
-        # rubocop:disable Metrics/MethodLength
         def kubernetes
           @kubernetes =
             begin
@@ -51,7 +67,6 @@ module Atatus
               kubernetes
             end
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 
@@ -66,12 +81,18 @@ module Atatus
             ENV.fetch('KUBERNETES_POD_UID', kubernetes_pod_uid)
         end
 
-        CONTAINER_ID_REGEX = /^[0-9A-Fa-f]{64}$/.freeze
-        KUBEPODS_REGEX = %r{(?:^/kubepods/[^/]+/pod([^/]+)$)|(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}.freeze # rubocop:disable Metrics/LineLength
+        CONTAINER_ID_REGEXES = [
+          %r{^[[:xdigit:]]{64}$},
+          %r{^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4,}$}
+        ]
+        KUBEPODS_REGEXES = [
+          %r{(?:^/kubepods[^\s]*/pod([^/]+)$)},
+          %r{(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}
+        ]
         SYSTEMD_SCOPE_SUFFIX = '.scope'
 
-        # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+        # rubocop:disable Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/CyclomaticComplexity
         def read_from_cgroup!
           return unless File.exist?(cgroup_path)
           IO.readlines(cgroup_path).each do |line|
@@ -103,18 +124,36 @@ module Atatus
               end
             end
 
-            if (kubepods_match = KUBEPODS_REGEX.match(directory))
+            if (kubepods_match = match_kubepods(directory))
               pod_id = kubepods_match[1] || kubepods_match[2]
 
               self.container_id = container_id
               self.kubernetes_pod_uid = pod_id
-            elsif CONTAINER_ID_REGEX.match(container_id)
+            elsif match_container(container_id)
               self.container_id = container_id
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        def match_kubepods(directory)
+          KUBEPODS_REGEXES.each do |r|
+            next unless (match = r.match(directory))
+            return match
+          end
+
+          nil
+        end
+
+        def match_container(container_id)
+          CONTAINER_ID_REGEXES.each do |r|
+            next unless (match = r.match(container_id))
+            return match
+          end
+
+          nil
+        end
       end
     end
   end

data/lib/atatus/metadata/system_info/hw_info.rb

@@ -66,7 +66,7 @@ module Atatus
         end
 
         LINUX_CPUINFO_PATH = '/proc/cpuinfo'.freeze
-        PROCESSOR_COUNT_REGEX = /^processor\s*:/.freeze
+        PROCESSOR_COUNT_REGEX = /processor\s+:\s+([0-9.]+)/.freeze
         MODEL_NAME_REGEX = /model name.+:(.+)/.freeze
         CPU_MHZ_REGEX = /cpu MHz\s+:\s+([0-9.]+)/.freeze
 

data/lib/atatus/metadata/system_info.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
@@ -7,7 +24,7 @@ module Atatus
       def initialize(config)
         @config = config
 
-        @hostname = @config.hostname || `hostname`.chomp
+        @hostname = @config.hostname || self.class.system_hostname
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
 
@@ -21,11 +38,13 @@ module Atatus
 
       attr_reader :hostname, :architecture, :platform, :container, :kubernetes, :hwinfo, :osinfo
 
-      private
-
       def gem_platform
         @gem_platform ||= Gem::Platform.local
       end
+
+      def self.system_hostname
+        @system_hostname ||= `hostname`.chomp
+      end
     end
   end
 end

data/lib/atatus/metadata.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/metrics/breakdown_set.rb

@@ -0,0 +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
+
+module Atatus
+  module Metrics
+    # @api private
+    class BreakdownSet < SpanScopedSet
+      def initialize(config)
+        super
+
+        disable! unless config.breakdown_metrics?
+      end
+    end
+  end
+end