signalfx-rails-instrumentation 0.1.0

data/Rakefile

@@ -0,0 +1,8 @@
+require "rubygems"
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/tracer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,4 @@
+memcached:
+  image: memcached
+  ports:
+    - 11211:11211

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_32.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 3.2.0"
+gem "test-unit", "~> 3.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 5.1.3"
+
+gemspec path: "../"

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 4.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_42.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 5.1.3"
+
+gemspec path: "../"

data/gemfiles/rails_50.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_51.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-byebug"
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/lib/rails-tracer.rb

@@ -0,0 +1 @@
+require 'rails/tracer'

data/lib/rails/action_controller/tracer.rb

@@ -0,0 +1,100 @@
+
+module ActionController
+  module Tracer
+    COMPONENT = "ActionController".freeze
+
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        @subscribers = []
+        @subscribers << ::ActiveSupport::Notifications.subscribe('start_processing.action_controller') do |*args|
+          ActionController::Tracer.start_processing(tracer: tracer, active_span: active_span, args: args)
+        end
+        @subscribers << ::ActiveSupport::Notifications.subscribe('process_action.action_controller') do |*args|
+          ActionController::Tracer.process_action(tracer: tracer, active_span: active_span, args: args)
+        end
+      end
+
+      def disable
+        @subscribers.each do |subscriber|
+          ::ActiveSupport::Notifications.unsubscribe(subscriber)
+        end
+        @subscribers.clear
+        self
+      end
+
+      def start_processing(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
+        event, start, finish, id, payload = *args
+
+        # extract the rack context, if it exists
+        # it seems like this might be the earliest place env is available
+        rack_span = Rails::Tracer::SpanHelpers.rack_span(payload)
+        Rails::Tracer::Defer.add_parent(id, rack_span)
+
+        path = payload.fetch(:path)
+        name = "#{payload.fetch(:controller)}##{payload.fetch(:action)} #{event} #{path}"
+        tags = {
+          'component' => COMPONENT,
+          'span.kind' => 'client',
+          'http.method' => payload.fetch(:method),
+          'http.path' => path,
+        }
+
+        if !Rails::Tracer::Defer.enabled
+          span = tracer.start_span(name,
+                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                   start_time: start,
+                                   tags: tags)
+
+          span.finish(end_time: finish)
+        else
+          spaninfo = {
+            'event' => event,
+            'name' => name,
+            'start' => start,
+            'finish' => finish,
+            'tags' => tags,
+          }
+
+          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
+        end
+      end
+
+      def process_action(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
+        event, start, finish, id, payload = *args
+
+        path = payload.fetch(:path)
+        name = "#{payload.fetch(:controller)}##{payload.fetch(:action)} #{path}"
+        tags = {
+          'component' => COMPONENT,
+          'span.kind' => 'client',
+          'http.method' => payload.fetch(:method),
+          'http.status_code' => payload.fetch(:status),
+          'http.path' => path,
+          'view.runtime' => payload.fetch(:view_runtime),
+          'db.runtime' => payload.fetch(:db_runtime),
+        }
+
+        if !Rails::Tracer::Defer.enabled
+          # write out the span
+          span = tracer.start_span(name,
+                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                   start_time: start,
+                                   tags: tags)
+
+          span.finish(end_time: finish)
+        else
+          # defer the spans if full_trace is configured
+          spaninfo = {
+            'event' => event,
+            'name' => name,
+            'start' => start,
+            'finish' => finish,
+            'tags' => tags,
+          }
+
+          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
+        end
+      end
+    end
+  end
+end

data/lib/rails/action_view/tracer.rb

@@ -0,0 +1,105 @@
+
+module ActionView
+  module Tracer
+    COMPONENT = "ActionView".freeze
+
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        @subscribers = []
+        @subscribers << ::ActiveSupport::Notifications.subscribe('render_template.action_view') do |*args|
+          ActionView::Tracer.render_template(tracer: tracer, active_span: active_span, args: args)
+        end
+        @subscribers << ::ActiveSupport::Notifications.subscribe('render_partial.action_view') do |*args|
+          ActionView::Tracer.render_partial(tracer: tracer, active_span: active_span, args: args)
+        end
+        @subscribers << ::ActiveSupport::Notifications.subscribe('render_collection.action_view') do |*args|
+          ActionView::Tracer.render_collection(tracer: tracer, active_span: active_span, args: args)
+        end
+      end
+
+      def disable
+        @subscribers.each do |subscriber|
+          ::ActiveSupport::Notifications.unsubscribe(subscriber)
+        end
+        @subscribers = []
+        self
+      end
+
+      def render_template(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
+        event, start, finish, id, payload = *args
+
+        tags = {
+          'component' => COMPONENT,
+          'span.kind' => 'client',
+          'template_path' => payload.fetch(:identifier),
+          'layout' => payload.fetch(:layout),
+        }
+
+        handle_notification(tracer: tracer,
+                            active_span: active_span,
+                            id: id,
+                            name: event,
+                            tags: tags,
+                            start: start,
+                            finish: finish)
+      end
+
+      def render_partial(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
+        event, start, finish, id, payload = *args
+
+        tags = {
+          'component' => COMPONENT,
+          'span.kind' => 'client',
+          'template_path' => payload.fetch(:identifier),
+        }
+
+        handle_notification(tracer: tracer,
+                            active_span: active_span,
+                            id: id,
+                            name: event,
+                            tags: tags,
+                            start: start,
+                            finish: finish)
+      end
+
+      def render_collection(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
+        event, start, finish, id, payload = *args
+
+        tags = {
+          'component' => COMPONENT,
+          'span.kind' => 'client',
+          'template_path' => payload.fetch(:identifier),
+          'collection_size' => payload.fetch(:count),
+        }
+
+        handle_notification(tracer: tracer,
+                            active_span: active_span,
+                            id: id,
+                            name: event,
+                            tags: tags,
+                            start: start,
+                            finish: finish)
+      end
+
+      def handle_notification(tracer:, active_span:, id:, name:, tags:, start:, finish:)
+        if !Rails::Tracer::Defer.enabled
+          span = tracer.start_span(name,
+                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                   start_time: start,
+                                   tags: tags)
+
+          span.finish(end_time: finish)
+        else
+          spaninfo = {
+            'event' => name,
+            'name' => name,
+            'start' => start,
+            'finish' => finish,
+            'tags' => tags,
+          }
+          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
+        end
+      end
+    end
+  end
+end

data/lib/rails/active_record/tracer.rb

@@ -0,0 +1,89 @@
+module ActiveRecord
+  module Tracer
+    DEFAULT_OPERATION_NAME = "sql.query".freeze
+
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        clear_subscribers
+        @subscriber = ::ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          ActiveRecord::Tracer.sql(tracer: tracer, active_span: active_span, args: args)
+        end
+
+        self
+      end
+
+      def disable
+        if @subscriber
+          ActiveSupport::Notifications.unsubscribe(@subscriber)
+          @subscriber = nil
+        end
+
+        self
+      end
+      alias :clear_subscribers :disable
+
+      def sql(tracer: OpenTracing.global_tracer, active_span: nil, args:)
+        event, start, finish, id, payload = *args
+
+        connection_config = ::ActiveRecord::Base.connection_config
+        name = payload.fetch(:name)
+        tags = {
+          'component' => 'ActiveRecord',
+          'span.kind' => 'client',
+          'db.user' => connection_config.fetch(:username, 'unknown'),
+          'db.instance' => connection_config.fetch(:database),
+          'db.vendor' => connection_config.fetch(:adapter),
+          'db.connection_id' => payload.fetch(:connection_id, 'unknown'),
+          'db.cached' => payload.fetch(:cached, false),
+          'db.statement' => payload.fetch(:sql),
+          'db.type' => 'sql'
+        }
+
+        if !Rails::Tracer::Defer.enabled
+          span = tracer.start_span(name || DEFAULT_OPERATION_NAME,
+                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                   start_time: start,
+                                   tags: tags)
+
+          if payload[:exception]
+            Rails::Tracer::SpanHelpers.set_error(span, payload[:exception_object] || payload[:exception])
+          end
+
+          span.finish(end_time: finish)
+        else
+          spaninfo = {
+            'event' => event,
+            'name' => name || DEFAULT_OPERATION_NAME,
+            'start' => start,
+            'finish' => finish,
+            'tags' => tags,
+          }
+
+          # errors aren't being propagated yet this way...
+
+          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
+        end
+      end
+
+      def start_span(operation_name, tracer: OpenTracing.global_tracer, active_span: nil, start_time: Time.now, **fields)
+        connection_config = ::ActiveRecord::Base.connection_config
+
+        span = tracer.start_span(operation_name || DEFAULT_OPERATION_NAME,
+                                 child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                 start_time: start_time,
+                                 tags: {
+                                  'component' => 'ActiveRecord',
+                                  'span.kind' => 'client',
+                                  'db.user' => connection_config.fetch(:username, 'unknown'),
+                                  'db.instance' => connection_config.fetch(:database),
+                                  'db.vendor' => connection_config.fetch(:adapter),
+                                  'db.connection_id' => fields.fetch(:connection_id, 'unknown'),
+                                  'db.cached' => fields.fetch(:cached, false),
+                                  'db.statement' => fields.fetch(:sql),
+                                  'db.type' => 'sql'
+                                 })
+        span
+      end
+    end
+  end
+end

data/lib/rails/active_support/cache/core_ext.rb

@@ -0,0 +1,11 @@
+module ActiveSupport
+  module Cache
+    class Store
+      # See the PR https://github.com/rails/rails/pull/15943/files
+      # In order to make the instrumentation to work we need to override the original implementation
+      def self.instrument
+        true
+      end
+    end
+  end
+end