baseline_red_rpm 1.0.0

data/lib/baseline_red_rpm/tracing/span.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module BaselineRedRpm
+  module Tracing
+    class Span
+      attr_accessor :operation_name
+
+      attr_reader :context, :start_time, :end_time, :tags, :log_entries
+      def initialize(context, operation_name, collector, opts = {})
+        @context = context
+        @operation_name = operation_name
+        @collector = collector
+        @start_time = opts[:start_time] || BaselineRedRpm.now
+        @end_time = nil
+        @tags = opts[:tags] || {}
+        @log_entries = []
+      end
+
+      def set_tag(key, value)
+        @tags = @tags.merge(key => value)
+      end
+
+      def add_tags(tags)
+        tags.each_pair do |key, value|
+          set_tag(key, value)
+        end
+      end
+
+      def set_baggage_item(key, value)
+        @context.set_baggage_item(key, value)
+      end
+
+      def get_baggage_item(key)
+        @context.get_baggage_item(key)
+      end
+
+      # Original definition for ruby 2+ was this:
+      # def log(opts = { :event => nil, :timestamp => BaselineRedRpm.now }, **fields)
+      # but this doesn't work in 1.9.
+      def log(opts = {}, *_, fields)
+        entry = {
+          "event" => opts[:event] || nil,
+          "timestamp" => opts[:timestamp] || BaselineRedRpm.now,
+        }
+
+        entry["fields"] = fields
+        @log_entries << entry
+
+        nil
+      end
+
+      def log_error(exception, opts = {})
+        log(
+          event: "error",
+          timestamp: opts[:timestamp] || BaselineRedRpm.now,
+          message: exception.message,
+          error_class: exception.class.to_s,
+          backtrace: BaselineRedRpm::Backtrace.clean(exception.backtrace),
+          source: BaselineRedRpm::Backtrace.source_extract(backtrace: exception.backtrace)
+        )
+      end
+
+      def exit(opts = {})
+        @end_time = opts[:end_time] || BaselineRedRpm.now
+      end
+
+      def finish(opts = {})
+        @collector.send_span(self, @end_time || opts[:end_time] || BaselineRedRpm.now)
+      end
+    end
+  end
+end

data/lib/baseline_red_rpm/tracing/span_context.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BaselineRedRpm
+  module Tracing
+    class SpanContext
+      def self.create_parent_context
+        trace_id = TraceId.generate
+        new(trace_id: trace_id, span_id: trace_id, sampled: true)
+      end
+
+      def self.create_from_parent_context(span_context)
+        new(
+          span_id: TraceId.generate,
+          parent_id: span_context.span_id,
+          trace_id: span_context.trace_id,
+          sampled: span_context.sampled?
+        )
+      end
+
+      attr_reader :span_id, :parent_id, :trace_id, :baggage
+
+      def initialize(opts = {})
+        @span_id = opts[:span_id] || nil
+        @parent_id = opts[:parent_id] || nil
+        @trace_id = opts[:trace_id] || nil
+        @sampled = opts[:sampled] || nil
+        @baggage = opts[:baggage] || {}
+      end
+
+      def set_baggage_item(key, value)
+        baggage[key] = value
+      end
+
+      def get_baggage_item(key)
+        baggage[key]
+      end
+
+      def sampled?
+        @sampled
+      end
+    end
+  end
+end

data/lib/baseline_red_rpm/tracing/thread_span_stack.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BaselineRedRpm
+  module Tracing
+    class ThreadSpanStack
+      def set_active_span(span)
+        active_span = ManagedSpan.new(span, method(:pop))
+        push(active_span)
+        active_span
+      end
+
+      def active_span
+        local_stack.last
+      end
+
+      def clear
+        local_stack.clear
+      end
+
+    private
+      def push(span)
+        local_stack << span
+      end
+
+      def pop
+        local_stack.pop
+      end
+
+      def local_stack
+        Thread.current[:__active_span__] ||= []
+      end
+    end
+  end
+end

data/lib/baseline_red_rpm/tracing/trace_id.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BaselineRedRpm
+  module Tracing
+    module TraceId
+      TRACE_ID_UPPER_BOUND = 2 ** 64
+
+      def self.generate
+        rand(TRACE_ID_UPPER_BOUND).to_s(16)
+      end
+    end
+  end
+end

data/lib/baseline_red_rpm/tracing/tracer.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module BaselineRedRpm
+  module Tracing
+    class Tracer
+      attr_reader :thread_span_stack, :collector
+
+      def self.build(opts = {})
+        opts[:collector] ||= nil
+        opts[:sender] ||= nil
+        opts[:service_name] ||= nil
+
+        opts[:sender].start
+
+        new(opts[:collector], opts[:sender])
+      end
+
+      def initialize(collector, sender)
+        @collector = collector
+        @sender = sender
+      end
+
+      def stop
+        @sender.stop
+      end
+
+      def start_span(operation_name, opts = {}, *)
+        child_of = opts[:child_of] || nil
+        opts[:start_time] ||= BaselineRedRpm.now
+        opts[:tags] ||= {}
+
+        context =
+          if child_of
+            parent_context = child_of.respond_to?(:context) ? child_of.context : child_of
+            SpanContext.create_from_parent_context(parent_context)
+          else
+            SpanContext.create_parent_context
+          end
+
+        span = Span.new(context, operation_name, @collector, {
+          start_time: opts[:start_time],
+          tags: opts[:tags]
+        })
+      end
+
+      def inject(span_context, format, carrier)
+        case format
+        when OpenTracing::FORMAT_TEXT_MAP
+          carrier['trace-id'] = span_context.trace_id
+          carrier['parent-id'] = span_context.parent_id
+          carrier['span-id'] = span_context.span_id
+          carrier['sampled'] = span_context.sampled? ? '1' : '0'
+        when OpenTracing::FORMAT_RACK
+          carrier['X-BaselineRed-TraceId'] = span_context.trace_id
+          carrier['X-BaselineRed-ParentSpanId'] = span_context.parent_id
+          carrier['X-BaselineRed-SpanId'] = span_context.span_id
+          carrier['X-BaselineRed-Sampled'] = span_context.sampled? ? '1' : '0'
+        else
+          STDERR.puts "BaselineRedRpm::Tracer with format #{format} is not supported yet"
+        end
+      end
+
+      def extract(format, carrier)
+        case format
+        when OpenTracing::FORMAT_TEXT_MAP
+          trace_id = carrier['trace-id']
+          parent_id = carrier['parent-id']
+          span_id = carrier['span-id']
+          sampled = carrier['sampled'] == '1'
+
+          create_span_context(trace_id, span_id, parent_id, sampled)
+        when OpenTracing::FORMAT_RACK
+          trace_id = carrier['HTTP_X_BaselineRed_TRACEID']
+          parent_id = carrier['HTTP_X_BaselineRed_PARENTSPANID']
+          span_id = carrier['HTTP_X_BaselineRed_SPANID']
+          sampled = carrier['HTTP_X_BaselineRed_SAMPLED'] == '1'
+
+          create_span_context(trace_id, span_id, parent_id, sampled)
+        else
+          STDERR.puts "BaselineRedRpm::Tracer with format #{format} is not supported yet"
+          nil
+        end
+      end
+
+      private
+      def create_span_context(trace_id, span_id, parent_id, sampled)
+        if trace_id && span_id
+          SpanContext.new(
+            trace_id: trace_id,
+            parent_id: parent_id,
+            span_id: span_id,
+            sampled: sampled
+          )
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/baseline_red_rpm/utils.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BaselineRedRpm
+  module Utils
+    REGEXP ||= Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)')
+
+    def sanitize_sql(sql, adapter)
+      sql.gsub(REGEXP, '?')
+    end
+
+    def connection_config
+      @connection_config ||= if ::ActiveRecord::VERSION::MAJOR == 2 || (::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR < 1)
+                               ActiveRecord::Base.connection.instance_variable_get(:@config)
+                             else
+                               ::ActiveRecord::Base.connection_config
+                             end
+    end
+
+    def format_redis(command)
+      command.is_a?(Symbol) ? command.to_s.upcase : command.to_s
+    rescue StandardError => e
+      "?"
+    end
+
+    def format_redis_command(command)
+      command.map { |x| format_redis(x) }.join(' ')
+    end
+
+    def self.log_source_and_backtrace(span, instrument)
+      config = ::BaselineRedRpm.config.instrumentation[instrument] || {}
+      if kind = config[:backtrace]
+        backtrace = BaselineRedRpm::Backtrace.backtrace(kind: kind)
+        if backtrace.length > 0
+          span.log(event: "backtrace", stack: backtrace)
+        end
+      end
+      if config[:source]
+        source = BaselineRedRpm::Backtrace.source_extract
+        if source.length > 0
+          span.log(event: "source", stack: source)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,6 @@
+namespace :baseline_red do
+  desc "Install baseline_red_ruby_agent.yml file"
+  task :install do
+    load File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "install.rb"))
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: baseline_red_rpm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jim Jones
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Agent for the Baseline Red, APM.
+email: jim@baseline.red
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/baseline_red_rpm.rb
+- lib/baseline_red_rpm/backtrace.rb
+- lib/baseline_red_rpm/configuration.rb
+- lib/baseline_red_rpm/instrumentation.rb
+- lib/baseline_red_rpm/instruments/action_controller.rb
+- lib/baseline_red_rpm/instruments/action_view.rb
+- lib/baseline_red_rpm/instruments/active_model_serializer.rb
+- lib/baseline_red_rpm/instruments/active_record.rb
+- lib/baseline_red_rpm/instruments/active_record/adapters/mysql2.rb
+- lib/baseline_red_rpm/instruments/active_record/adapters/postgresql.rb
+- lib/baseline_red_rpm/instruments/active_record/adapters/sqlite3.rb
+- lib/baseline_red_rpm/instruments/activerecord_import.rb
+- lib/baseline_red_rpm/instruments/emque_consuming.rb
+- lib/baseline_red_rpm/instruments/faraday.rb
+- lib/baseline_red_rpm/instruments/grape.rb
+- lib/baseline_red_rpm/instruments/net_http.rb
+- lib/baseline_red_rpm/instruments/rack.rb
+- lib/baseline_red_rpm/instruments/redis.rb
+- lib/baseline_red_rpm/instruments/roda.rb
+- lib/baseline_red_rpm/instruments/sequel.rb
+- lib/baseline_red_rpm/instruments/sidekiq.rb
+- lib/baseline_red_rpm/instruments/sinatra.rb
+- lib/baseline_red_rpm/instruments/typhoeus.rb
+- lib/baseline_red_rpm/introspector.rb
+- lib/baseline_red_rpm/logger.rb
+- lib/baseline_red_rpm/rails.rb
+- lib/baseline_red_rpm/railtie.rb
+- lib/baseline_red_rpm/reporters/json_client.rb
+- lib/baseline_red_rpm/reporters/null_client.rb
+- lib/baseline_red_rpm/tracer.rb
+- lib/baseline_red_rpm/tracing/buffer.rb
+- lib/baseline_red_rpm/tracing/carrier.rb
+- lib/baseline_red_rpm/tracing/collector.rb
+- lib/baseline_red_rpm/tracing/endpoint.rb
+- lib/baseline_red_rpm/tracing/managed_span.rb
+- lib/baseline_red_rpm/tracing/managed_tracer.rb
+- lib/baseline_red_rpm/tracing/span.rb
+- lib/baseline_red_rpm/tracing/span_context.rb
+- lib/baseline_red_rpm/tracing/thread_span_stack.rb
+- lib/baseline_red_rpm/tracing/trace_id.rb
+- lib/baseline_red_rpm/tracing/tracer.rb
+- lib/baseline_red_rpm/utils.rb
+- lib/tasks/install.rake
+homepage: https://baseline.red
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Baseline Red Ruby Agent
+test_files: []