atatus 1.3.0 → 1.6.1

data/lib/atatus/metrics.rb

@@ -1,14 +1,27 @@
-# 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/metricset'
+# frozen_string_literal: true
 
 module Atatus
   # @api private
   module Metrics
-    MUTEX = Mutex.new
-
     def self.new(config, &block)
-      Collector.new(config, &block)
+      Registry.new(config, &block)
     end
 
     def self.platform
@@ -16,24 +29,17 @@ module Atatus
     end
 
     # @api private
-    class Collector
+    class Registry
       include Logging
 
       TIMEOUT_INTERVAL = 5 # seconds
 
-      def initialize(config, labels: nil, &block)
+      def initialize(config, &block)
         @config = config
-        @labels = labels
-        @samplers = [CpuMem, VM].map do |kls|
-          debug "Adding metrics collector '#{kls}'"
-          kls.new(config)
-        end
         @callback = block
       end
 
-      attr_reader :config, :samplers, :callback, :labels
-
-      # rubocop:disable Metrics/MethodLength
+      attr_reader :config, :sets, :callback
       def start
         unless config.collect_metrics?
           debug 'Skipping metrics'
@@ -42,6 +48,18 @@ module Atatus
 
         debug 'Starting metrics'
 
+        # Only set the @sets once, in case we stop
+        # and start again.
+        @sets ||= {
+          system: CpuMemSet,
+          # vm: VMSet,
+          breakdown: BreakdownSet,
+          transaction: TransactionSet
+        }.each_with_object({}) do |(key, kls), sets|
+          debug "Adding metrics collector '#{kls}'"
+          sets[key] = kls.new(config)
+        end
+
         @timer_task = Concurrent::TimerTask.execute(
           run_now: true,
           execution_interval: config.metrics_interval,
@@ -60,7 +78,6 @@ module Atatus
 
         @running = true
       end
-      # rubocop:enable Metrics/MethodLength
 
       def stop
         return unless running?
@@ -75,24 +92,49 @@ module Atatus
         !!@running
       end
 
-      def collect_and_send
-        metricset = Metricset.new(labels: labels, **collect)
-        return if metricset.empty?
+      def handle_forking!
+        # Note that ideally we would be able to check if the @timer_task died
+        # and restart it. You can't simply check @timer_task.running? because
+        # it will only return the state of the TimerTask, not whether the
+        # internal thread used to manage the execution interval has died.
+        # This is a limitation of the Concurrent::TimerTask object.
+        # Therefore, our only option when forked is to stop and start.
+        # ~estolfo
+        stop
+        start
+      end
 
-        callback.call(metricset)
+      def get(key)
+        sets.fetch(key)
+      end
+
+      def collect_and_send
+        return unless @config.recording?
+        metricsets = collect
+        metricsets.compact!
+        metricsets.each do |m|
+          callback.call(m)
+        end
       end
 
       def collect
-        MUTEX.synchronize do
-          samplers.each_with_object({}) do |sampler, samples|
-            next unless (sample = sampler.collect)
-            samples.merge!(sample)
-          end
+        sets.each_value.each_with_object([]) do |set, arr|
+          samples = set.collect
+          next unless samples
+          arr.concat(samples)
         end
       end
     end
   end
 end
 
-require 'atatus/metrics/cpu_mem'
-require 'atatus/metrics/vm'
+require 'atatus/metricset'
+
+require 'atatus/metrics/metric'
+require 'atatus/metrics/set'
+
+require 'atatus/metrics/cpu_mem_set'
+require 'atatus/metrics/vm_set'
+require 'atatus/metrics/span_scoped_set'
+require 'atatus/metrics/transaction_set'
+require 'atatus/metrics/breakdown_set'

data/lib/atatus/metricset.rb

@@ -1,19 +1,63 @@
+# 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 Metricset
-    def initialize(timestamp: Util.micros, labels: nil, **samples)
+    def initialize(
+      timestamp: Util.micros,
+      tags: nil,
+      transaction: nil,
+      span: nil,
+      **samples
+    )
       @timestamp = timestamp
-      @labels = labels
+      @tags = tags
+      @transaction = transaction
+      @span = span
       @samples = samples
     end
 
-    attr_accessor :timestamp
-    attr_reader :samples, :labels
+    attr_accessor :timestamp, :transaction, :span, :tags
+    attr_reader :samples
+
+    def merge_tags!(tags)
+      return unless tags
+
+      @tags ||= {}
+      @tags.merge! tags
+    end
+
+    def tags?
+      tags&.any?
+    end
 
     def empty?
       samples.empty?
     end
+
+    def inspect
+      "<Atatus::Metricset timestamp:#{timestamp}" \
+        " transaction:#{transaction.inspect}" \
+        " span:#{span.inspect}" \
+        " tags:#{tags.inspect}" \
+        " samples:#{samples.inspect}>"
+    end
   end
 end

data/lib/atatus/middleware.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
 
@@ -10,7 +27,6 @@ module Atatus
       @app = app
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def call(env)
       begin
         if running? && !path_ignored?(env)
@@ -35,7 +51,6 @@ module Atatus
 
       resp
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     private
 
@@ -44,9 +59,15 @@ module Atatus
     end
 
     def path_ignored?(env)
-      config.ignore_url_patterns.any? do |r|
-        env['PATH_INFO'].match r
+      return true if config.ignore_url_patterns.any? do |r|
+        r.match(env['PATH_INFO'])
       end
+
+      return true if config.transaction_ignore_urls.any? do |r|
+        r.match(env['PATH_INFO'])
+      end
+
+      false
     end
 
     def start_transaction(env)
@@ -58,10 +79,9 @@ module Atatus
     end
 
     def trace_context(env)
-      return unless (header = env['HTTP_ATATUS_APM_TRACEPARENT'])
-      TraceContext.parse(header)
-    rescue TraceContext::InvalidTraceparentHeader
-      warn "Couldn't parse invalid traceparent header: #{header.inspect}"
+      TraceContext.parse(env: env)
+    rescue TraceContext::InvalidTraceparentHeader => e
+      warn e.message
       nil
     end
 

data/lib/atatus/naively_hashable.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/normalizers/grape/endpoint_run.rb

@@ -0,0 +1,65 @@
+# 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 Normalizers
+    module Grape
+      # @api private
+      class EndpointRun < Normalizer
+        register 'endpoint_run.grape'
+
+        TYPE = 'app'
+        SUBTYPE = 'resource'
+
+        FRAMEWORK_NAME = 'Grape'
+
+        def normalize(transaction, _name, payload)
+          transaction.name = endpoint(payload[:env])
+
+          if transaction_from_host_app?(transaction)
+            transaction.context.set_service(
+              framework_name: FRAMEWORK_NAME,
+              framework_version: ::Grape::VERSION
+            )
+          end
+
+          [transaction.name, TYPE, SUBTYPE, nil, nil]
+        end
+
+        def backtrace(payload)
+          source_location = payload[:endpoint].source.source_location
+          ["#{source_location[0]}:#{source_location[1]}"]
+        end
+
+        private
+
+        def transaction_from_host_app?(transaction)
+          transaction.framework_name != FRAMEWORK_NAME
+        end
+
+        def endpoint(env)
+          route_name =
+            env['api.endpoint']&.routes&.first&.pattern&.origin ||
+            env['REQUEST_PATH']
+          [env['REQUEST_METHOD'], route_name].join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/atatus/normalizers/grape.rb

@@ -0,0 +1,22 @@
+# 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
+
+%w[endpoint_run].each do |lib|
+  require "atatus/normalizers/grape/#{lib}"
+end

data/lib/atatus/normalizers/rails/action_controller.rb

@@ -0,0 +1,44 @@
+# 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 Normalizers
+    module ActionController
+      # @api private
+      class ProcessActionNormalizer < Normalizer
+        register 'process_action.action_controller'
+
+        TYPE = 'app'
+        SUBTYPE = 'controller'
+        ACTION = 'action'
+
+        def normalize(transaction, _name, payload)
+          transaction.name = endpoint(payload)
+          [transaction.name, TYPE, SUBTYPE, ACTION, nil]
+        end
+
+        private
+
+        def endpoint(payload)
+          "#{payload[:controller]}##{payload[:action]}"
+        end
+      end
+    end
+  end
+end

data/lib/atatus/normalizers/rails/action_mailer.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
+  module Normalizers
+    module ActionMailer
+      # @api private
+      class ProcessActionNormalizer < Normalizer
+        register 'process.action_mailer'
+
+        TYPE = 'app'
+        SUBTYPE = 'mailer'
+        ACTION = 'action'
+
+        def normalize(_transaction, _name, payload)
+          [endpoint(payload), TYPE, SUBTYPE, ACTION, nil]
+        end
+
+        private
+
+        def endpoint(payload)
+          "#{payload[:mailer]}##{payload[:action]}"
+        end
+      end
+    end
+  end
+end

data/lib/atatus/normalizers/{action_view.rb → rails/action_view.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/normalizers/rails/active_record.rb

@@ -0,0 +1,80 @@
+# 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/sql'
+
+module Atatus
+  module Normalizers
+    module ActiveRecord
+      # @api private
+      class SqlNormalizer < Normalizer
+        register 'sql.active_record'
+
+        TYPE = 'db'
+        ACTION = 'sql'
+        SKIP_NAMES = %w[SCHEMA CACHE].freeze
+        UNKNOWN = 'unknown'
+
+        def initialize(*args)
+          super
+
+          @summarizer = Sql.summarizer
+
+          @adapters = {}
+        end
+
+        def normalize(_transaction, _name, payload)
+          return :skip if SKIP_NAMES.include?(payload[:name])
+
+          name = summarize(payload[:sql]) || payload[:name]
+          subtype = subtype_for(payload)
+
+          context =
+            Span::Context.new(
+              db: { statement: payload[:sql], type: 'sql' },
+              destination: { name: subtype, resource: subtype, type: TYPE }
+            )
+
+          [name, TYPE, subtype, ACTION, context]
+        end
+
+        private
+
+        def subtype_for(payload)
+          cached_adapter_name(
+            payload[:connection]&.adapter_name ||
+              ::ActiveRecord::Base.connection_config[:adapter]
+          )
+        end
+
+        def summarize(sql)
+          @summarizer.summarize(sql)
+        end
+
+        def cached_adapter_name(adapter_name)
+          return UNKNOWN if adapter_name.nil? || adapter_name.empty?
+          @adapters[adapter_name] ||
+            (@adapters[adapter_name] = adapter_name.downcase)
+        rescue StandardError
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/atatus/normalizers/rails.rb

@@ -0,0 +1,27 @@
+# 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
+
+%w[
+  action_controller
+  action_mailer
+  action_view
+  active_record
+].each do |lib|
+  require "atatus/normalizers/rails/#{lib}"
+end

data/lib/atatus/normalizers.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 # :nodoc:
@@ -12,6 +29,8 @@ module Atatus # :nodoc:
       def self.register(name)
         Normalizers.register(name, self)
       end
+
+      def backtrace(payload); end
     end
 
     def self.register(name, klass)
@@ -54,15 +73,10 @@ module Atatus # :nodoc:
       def normalize(transaction, name, payload)
         self.for(name).normalize(transaction, name, payload)
       end
-    end
-  end
 
-  %w[
-    action_controller
-    action_mailer
-    action_view
-    active_record
-  ].each do |lib|
-    require "atatus/normalizers/#{lib}"
+      def backtrace(name, payload)
+        self.for(name).backtrace(payload)
+      end
+    end
   end
 end