atatus 1.3.0 → 1.4.0

data/lib/atatus/metrics/span_scoped_set.rb

@@ -0,0 +1,56 @@
+# 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 SpanScopedSet < Set
+      def collect
+        super.tap do |sets|
+          next unless sets
+
+          sets.each do |set|
+            move_transaction(set)
+            move_span(set)
+          end
+        end
+      end
+
+      private
+
+      def move_transaction(set)
+        name = set.tags&.delete(:'transaction.name')
+        type = set.tags&.delete(:'transaction.type')
+        return unless name || type
+
+        set.transaction = { name: name, type: type }
+        set.tags = nil if set.tags.empty?
+      end
+
+      def move_span(set)
+        type = set.tags&.delete(:'span.type')
+        subtype = set.tags&.delete(:'span.subtype')
+        return unless type
+
+        set.span = { type: type, subtype: subtype }
+        set.tags = nil if set.tags.empty?
+      end
+    end
+  end
+end

data/lib/atatus/metrics/transaction_set.rb

@@ -0,0 +1,26 @@
+# 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 TransactionSet < SpanScopedSet
+    end
+  end
+end

data/lib/atatus/metrics/vm_set.rb

@@ -0,0 +1,58 @@
+# 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 VMSet < Set
+      include Logging
+
+      def collect
+        read!
+        super
+      end
+
+      def read!
+        return if disabled?
+
+        stat = GC.stat
+
+        gauge(:'ruby.gc.count').value = stat[:count]
+        gauge(:'ruby.threads').value = Thread.list.count
+        gauge(:'ruby.heap.slots.live').value = stat[:heap_live_slots]
+
+        gauge(:'ruby.heap.slots.free').value = stat[:heap_free_slots]
+        gauge(:'ruby.heap.allocations.total').value =
+          stat[:total_allocated_objects]
+
+        return unless GC::Profiler.enabled?
+
+        @total_time ||= 0
+        @total_time += GC::Profiler.total_time
+        GC::Profiler.clear
+        gauge(:'ruby.gc.time').value = @total_time
+      rescue TypeError => e
+        error 'VM metrics encountered error: %s', e
+        debug('Backtrace:') { e.backtrace.join("\n") }
+
+        disable!
+      end
+    end
+  end
+end

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.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

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/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/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