mnemosyne-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d1ae774cf6ab9a36c5d387675d49fc1f646dc03
+  data.tar.gz: 9a2e7ad49b27c1866dfd0517820849bb728744d9
+SHA512:
+  metadata.gz: 2e0a25632d5e1447fdc7af933b02e5b459ebad667b442eb7ae8799ad4556bb42317a525d215ac383f2e24fd7bd028b69651c4f4ee1b2644e54bc7c83d9654159
+  data.tar.gz: 3bd51d5807b2b29dafe064976b0c3faa10649881056535ebe5720f7e4db9b16091006bea2984291fe32c0c15805dc55d3a4039f47e93f1b357d4f90eb23d1304

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Rails:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/Semicolon:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/RescueModifier:
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'mnemosyne.gemspec'
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - '2.3.3'
+  - '2.2.6'
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mnemosyne.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jan Graichen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Mnemosyne
+
+The ruby client plugin for the Mnemosyne monitoring system. It extracts full application traces including cross-application requests for distributed applications (services etc.).
+
+Currently supported probes:
+
+* ActionController: Process Action, Renderers
+* ActiveRecord: SQL query
+* Responders: render time
+* Custom instrumentation
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mnemosyne'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mnemosyne
+
+## Usage
+
+TODO
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mnemosyne/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'bunny'
+
+module Mnemosyne
+  class Client
+    attr_reader :connection
+
+    def initialize(config)
+      @config = config
+    end
+
+    def connection
+      @connection ||= begin
+        @config.logger.info "[Mnemosyne] Connect to #{@config.server}..."
+
+        connection = ::Bunny.new @config.amqp,
+          logger: @config.logger,
+          threaded: false
+
+        connection.start
+        connection
+      end
+    end
+
+    def channel
+      @channel ||= connection.create_channel
+    end
+
+    def exchange
+      @exchange ||= channel.topic @config.exchange, durable: true
+    end
+
+    def send(key, data)
+      blob = JSON.dump data
+
+      exchange.publish blob,
+        routing_key: key,
+        persistent: true,
+        content_type: 'application/json'
+    end
+
+    class << self
+      def instance
+        @instance ||= new
+      end
+    end
+  end
+end

data/lib/mnemosyne/clock.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Clock
+    class << self
+      def tick
+        to_tick Time.now
+      end
+
+      def to_tick(time)
+        time.to_i * 1_000_000_000 + time.nsec
+      end
+    end
+  end
+end

data/lib/mnemosyne/config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require 'socket'
+require 'uri'
+require 'cgi'
+
+module Mnemosyne
+  class Config
+    attr_reader :application
+    attr_reader :hostname
+    attr_reader :amqp
+    attr_reader :exchange
+    attr_reader :logger
+    attr_reader :server
+
+    # rubocop:disable Metrics/AbcSize
+    def initialize(config)
+      @application = config.fetch('application').freeze
+      @enabled     = config.fetch('enabled', true)
+      @hostname    = config.fetch('hostname') { default_hostname }.freeze
+      @exchange    = config.fetch('exchange', 'mnemosyne').freeze
+      @logger      = config.fetch('logger') { Logger.new($stdout) }
+
+      server       = config.fetch('server', 'amqp://localhost')
+      @amqp        = AMQ::Settings.configure(server).freeze
+      @server      = make_amqp_uri(@amqp).freeze
+
+      raise 'Application must be configured' unless application.present?
+      raise 'Hostname must be configured' unless hostname.present?
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    private
+
+    def default_hostname
+      Socket.gethostbyname(Socket.gethostname).first
+    end
+
+    def make_amqp_uri(amqp)
+      uri = URI('')
+
+      uri.scheme = amqp[:scheme]
+      uri.user = amqp[:user]
+      uri.host = amqp[:host]
+      uri.port = amqp[:port] if amqp[:port] != AMQ::URI::AMQP_PORTS[uri.scheme]
+      uri.path = '/' + ::CGI.escape(amqp[:vhost]) if amqp[:vhost] != '/'
+
+      uri
+    end
+  end
+end

data/lib/mnemosyne/global.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Global
+    def trace(name, meta: {})
+      ::ActiveSupport::Notifications.instrument 'trace.mnemosyne',
+        name: name, meta: meta do
+
+        yield
+      end
+    end
+  end
+end

data/lib/mnemosyne/instrumenter.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+require 'thread'
+
+module Mnemosyne
+  class Instrumenter
+    IDENT = :__mnemosyne_current_trace
+    MUTEX = Mutex.new
+
+    attr_reader :logger
+
+    def initialize(config)
+      @config = config
+
+      raise 'Config required!' unless @config
+
+      @logger = config.logger
+      @client = Client.new(config)
+
+      logger.info 'Mnemosyne instrumenter started.'
+    end
+
+    def current_trace
+      Thread.current[IDENT]
+    end
+
+    def current_trace=(trace)
+      Thread.current[IDENT] = trace
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def trace(name, **kwargs)
+      if (trace = current_trace)
+        return yield trace if block_given?
+        return trace
+      end
+
+      trace = self.current_trace = Trace.new(self, name, **kwargs)
+
+      return trace unless block_given?
+
+      begin
+        yield trace
+      ensure
+        self.current_trace = nil
+        trace.submit
+      end
+    end
+
+    def submit(trace)
+      blob = {
+        hostname: @config.hostname,
+        application: @config.application
+      }
+
+      # TODO: nest
+      blob.merge! trace.serialize
+
+      logger.debug { "Submit trace #{trace.uuid}" }
+
+      @client.send 'mnemosyne.trace', blob
+    end
+
+    def release(trace)
+      return unless current_trace.equal?(trace)
+
+      self.current_trace = nil
+    end
+
+    class << self
+      attr_reader :instance
+
+      def start!(config = nil)
+        return @instance if @instance
+
+        MUTEX.synchronize do
+          return @instance if @instance
+
+          @instance = new(config)
+        end
+      rescue => err
+        message = "Unable to start instrumenter: #{err}"
+
+        if config && config.respond_to?(:logger)
+          config.logger.warn message
+        else
+          ::Kernel.warn message
+        end
+
+        raise
+      end
+
+      def trace(*args)
+        return unless (instrumenter = instance)
+        instrumenter.trace(*args)
+      end
+
+      def logger
+        if (instrumenter = instance)
+          instrumenter.logger
+        else
+          @logger ||= Logger.new($stdout)
+        end
+      end
+
+      def current_trace
+        return unless (instrumenter = instance)
+        instrumenter.current_trace
+      end
+    end
+  end
+end

data/lib/mnemosyne/middleware/acfs.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Middleware
+    class Acfs
+      def initialize(app, *_)
+        @app = app
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def call(request)
+        trace = ::Mnemosyne::Instrumenter.current_trace
+
+        if trace
+          span = ::Mnemosyne::Span.new('external.http.acfs',
+            meta: extract_meta(request))
+
+          span.start!
+
+          request.headers['X-Mnemosyne-Transaction'] = trace.transaction
+          request.headers['X-Mnemosyne-Origin'] = span.uuid
+        end
+
+        request.on_complete do |response, nxt|
+          begin
+            span.finish!
+            trace << span
+          ensure
+            nxt.call(response)
+          end
+        end
+
+        @app.call(request)
+      end
+
+      private
+
+      def extract_meta(request)
+        {
+          method: request.method,
+          url: request.url
+        }
+      end
+    end
+  end
+end

data/lib/mnemosyne/middleware/rack.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Middleware
+    class Rack
+      class Proxy
+        def initialize(body, &block)
+          @body = body
+          @block = block
+          @closed = false
+        end
+
+        def respond_to_missing?(*args)
+          return false if args.first && args.first.to_s == 'to_ary'
+
+          @body.respond_to?(*args)
+        end
+
+        def method_missing(*args)
+          super if args.first && args.first.to_s == 'to_ary'
+
+          if block_given?
+            @body.__send__(*args, &Proc.new)
+          else
+            @body.__send__(*args)
+          end
+        end
+
+        def close
+          return if @closed
+          @closed = true
+
+          begin
+            @body.close if @body.respond_to? :close
+          ensure
+            @block.call
+          end
+        end
+
+        def closed?
+          @closed
+        end
+
+        def each(*args)
+          if block_given?
+            @body.each(*args, &Proc.new)
+          else
+            @body.each(*args)
+          end
+        end
+      end
+
+      def initialize(app)
+        @app = app
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def call(env)
+        origin      = env.fetch('HTTP_X_MNEMOSYNE_ORIGIN', false)
+        transaction = env.fetch('HTTP_X_MNEMOSYNE_TRANSACTION') do
+          ::SecureRandom.uuid
+        end
+
+        trace = ::Mnemosyne::Instrumenter.trace 'app.web.request.rack',
+          transaction: transaction,
+          origin: origin
+
+        if trace
+          trace.start!
+
+          response = @app.call env
+          response[2] = Proxy.new(response[2]) { trace.submit }
+          response
+        else
+          @app.call env
+        end
+
+      # rubocop:disable Lint/RescueException
+      rescue Exception
+        trace.submit if trace
+        raise
+      ensure
+        trace.release if trace
+      end
+    end
+
+    private
+
+    def _uuid
+      ::SecureRandom.uuid
+    end
+  end
+end

data/lib/mnemosyne/middleware/restify.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Middleware
+    module Restify
+      class Writer
+        def initialize(writer, trace, span)
+          @writer = writer
+          @trace = trace
+          @span = span
+        end
+
+        def fulfill(*args)
+          @span.finish!
+          @trace << @span
+
+          @writer.fulfill(*args)
+        end
+
+        def reject(*args)
+          @span.finish!
+          @trace << @span
+
+          @writer.reject(*args)
+        end
+      end
+
+      class << self
+        # rubocop:disable Metrics/MethodLength
+        def call(request, writer)
+          if (trace = ::Mnemosyne::Instrumenter.current_trace)
+            meta = {url: request.uri, method: request.method}
+
+            span = ::Mnemosyne::Span.new('external.http.restify', meta: meta)
+            span.start!
+
+            request.headers['X-Mnemosyne-Transaction'] = trace.transaction
+            request.headers['X-Mnemosyne-Origin'] = span.uuid
+
+            hook = Writer.new(writer, trace, span)
+
+            yield request, hook
+          else
+            yield request, writer
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mnemosyne/probe.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  class Probe
+    # rubocop:disable Metrics/MethodLength
+    def install
+      setup
+
+      self.class.subscriptions.each do |subscribe|
+        ::ActiveSupport::Notifications.subscribe(subscribe) do |*args|
+          trace = ::Mnemosyne::Instrumenter.current_trace
+          next unless trace
+
+          call(trace, *args)
+        end
+      end
+
+      ::Mnemosyne::Instrumenter.logger.debug do
+        "Installed probe #{self.class.name}"
+      end
+    end
+
+    def setup
+      # noop
+    end
+
+    class << self
+      def subscriptions
+        @subscriptions ||= Set.new
+      end
+
+      def subscribe(name)
+        subscriptions << name
+      end
+    end
+  end
+end

data/lib/mnemosyne/probes/acfs/request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Probes
+    module Acfs
+      module Request
+        class Probe < ::Mnemosyne::Probe
+          subscribe 'acfs.run'
+
+          def setup
+            require 'mnemosyne/middleware/acfs'
+
+            ::Acfs::Runner.use ::Mnemosyne::Middleware::Acfs
+          end
+
+          # rubocop:disable Metrics/ParameterLists
+          def call(trace, _name, start, finish, _id, _payload)
+            start  = ::Mnemosyne::Clock.to_tick(start)
+            finish = ::Mnemosyne::Clock.to_tick(finish)
+
+            callers = caller
+
+            callers.shift until callers[0].include? 'lib/acfs/global.rb:'
+
+            meta = {
+              backtrace: callers[1..-1]
+            }
+
+            span = ::Mnemosyne::Span.new 'external.run.acfs',
+              start: start, finish: finish, meta: meta
+
+            trace << span
+          end
+        end
+      end
+    end
+
+    register 'Acfs::Runner', 'acfs/runner', Acfs::Request::Probe.new
+  end
+end