microscope_tracer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7643c5e1b0005e105386c53d615cbbfdd9fc31cf
+  data.tar.gz: fb317d4e561db12dd7decdef4e2c99a46a3202d2
+SHA512:
+  metadata.gz: 1ede11290a7d81ef89830609109b7a513c24fb4cdf3167d002269f1f11cbf84c93c5acb8d286da85cbf53286a8e068be1a3ed9a2c99b5f4e581221b7d944d9f4
+  data.tar.gz: 41765f463a2183041991376d8d5912a582d36e080e04dcd4e2e3137b098e768088a0743715aa475911925f04b5c29117e285ca2f0d36042e62334596d86bc2c6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in microscope_tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Pete Hodgson
+
+MIT License
+
+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,31 @@
+# MicroscopeTracer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'microscope_tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install microscope_tracer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/moredip/microscope_tracer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/microscope_tracer/faraday_middleware.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+
+require 'microscope_tracer/trace_logger'
+
+module MicroscopeTracer
+class FaradayMiddleware < Faraday::Middleware
+  def initialize(app,logger = Logger.new($stdout))
+    @trace_logger = TraceLogger.new(logger)
+    super(app)
+  end
+
+  def call(env)
+    span = Span.lookup_for_this_request
+    child_span_id = Span.generate_unique_id
+
+    Headers.add_client_request_headers(env.request_headers,span,child_span_id)
+
+    started_at = Time.now
+
+    @trace_logger.log_client_start(span)
+
+
+    @app.call(env).on_complete do |response_env|
+      duration = Time.now - started_at
+      @trace_logger.log_client_end(span,duration) 
+    end
+  end
+end
+end

data/lib/microscope_tracer/headers.rb

@@ -0,0 +1,35 @@
+require 'microscope_tracer/span'
+
+module MicroscopeTracer
+  module Headers
+    def self.add_client_request_headers(headers,span,child_span_id)
+      headers["Microscope-Trace-Id"] = span.trace_id if span.trace_id
+      headers["Microscope-Parent-Span-Id"] = span.span_id if span.span_id
+      headers["Microscope-Span-Id"] = child_span_id if child_span_id
+    end
+
+    def self.span_from_server_request_headers(env)
+      trace_id = env.fetch("HTTP_MICROSCOPE_TRACE_ID",false)
+      parent_span_id = env.fetch("HTTP_MICROSCOPE_PARENT_SPAN_ID",false)
+      span_id = env.fetch("HTTP_MICROSCOPE_SPAN_ID",false)
+
+      sanity_checks(!!trace_id,!!span_id,!!parent_span_id)
+
+      if trace_id && !parent_span_id 
+        return false
+      end
+
+      Span.new(trace_id,parent_span_id,span_id)
+    end
+
+    def self.sanity_checks(trace_id_provided, span_id_provided, parent_span_id_provided)
+      if !trace_id_provided && span_id_provided 
+        puts "WARNING: no TraceId provided but a SpanId *was* provided"
+      end
+
+      if !trace_id_provided && parent_span_id_provided 
+        puts "WARNING: no TraceId provided but a ParentSpanId *was* provided"
+      end
+    end
+  end
+end

data/lib/microscope_tracer/rack_middleware.rb

@@ -0,0 +1,36 @@
+require 'rack/body_proxy'
+require 'request_store'
+
+require 'microscope_tracer/headers'
+require 'microscope_tracer/trace_logger'
+
+module MicroscopeTracer
+
+class RackMiddleware
+  def initialize(app,logger = Logger.new($stdout))
+    @app = app
+    @trace_logger = TraceLogger.new(logger)
+  end
+
+  def call(env)
+    span = (env["SPAN"] ||= Headers.span_from_server_request_headers(env))
+    span.store_for_this_request
+
+    started_at = Time.now
+
+    @trace_logger.log_server_start(span)
+
+    status, header, body = @app.call(env)
+
+    body = Rack::BodyProxy.new(body) do
+      duration = Time.now - started_at
+      @trace_logger.log_server_end(span,duration) 
+    end
+
+    [status, header, body]
+  ensure
+    RequestStore.clear! # make certain that any span info is cleared out before the next request comes in
+  end
+end
+
+end

data/lib/microscope_tracer/span.rb

@@ -0,0 +1,26 @@
+require 'securerandom'
+require 'request_store'
+
+module MicroscopeTracer
+class Span
+  attr_reader :trace_id, :span_id, :parent_span_id
+
+  def self.generate_unique_id
+    SecureRandom.uuid
+  end
+
+  def self.lookup_for_this_request
+    RequestStore.store[:microscope_span]
+  end
+
+  def store_for_this_request
+    RequestStore.store[:microscope_span] = self
+  end
+
+  def initialize(trace_id,parent_span_id,span_id)
+    trace_id ||= Span.generate_unique_id
+    span_id ||= Span.generate_unique_id
+    @trace_id, @parent_span_id, @span_id = trace_id, parent_span_id, span_id
+  end
+end
+end

data/lib/microscope_tracer/trace_logger.rb

@@ -0,0 +1,31 @@
+module MicroscopeTracer
+class TraceLogger
+  def initialize(logger)
+    @logger = logger
+  end
+
+  def log_server_start(span)
+    log(:server_start,span)
+  end
+
+  def log_server_end(span,duration_in_seconds)
+    millis = duration_in_seconds * 1000
+    log(:server_end,span,{elapsedMillis:millis})
+  end
+
+  def log_client_start(span)
+    log(:client_start,span)
+  end
+
+  def log_client_end(span,duration_in_seconds)
+    millis = duration_in_seconds * 1000
+    log(:client_end,span,{elapsedMillis:millis})
+  end
+
+  def log(type,span,extras={})
+    fields = {type:type,traceId:span.trace_id,spanId:span.span_id,pspanId:span.parent_span_id}.merge(extras)
+    line = fields.map{ |k,v| if v then "#{k}=\"#{v}\"" else nil end }.compact.join(" ")
+    @logger.info(line)
+  end
+end
+end

data/lib/microscope_tracer/version.rb

@@ -0,0 +1,3 @@
+module MicroscopeTracer
+  VERSION = "0.0.1"
+end

data/lib/microscope_tracer.rb

@@ -0,0 +1,5 @@
+require "microscope_tracer/version"
+
+module MicroscopeTracer
+  # Your code goes here...
+end

data/microscope_tracer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'microscope_tracer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "microscope_tracer"
+  spec.version       = MicroscopeTracer::VERSION
+  spec.authors       = ["Pete Hodgson"]
+  spec.email         = ["rubygems@thepete.net"]
+  spec.summary       = %q{Logs Microscope-compliant trace entries and wrangles Microscope- HTTP headers.}
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "request_store"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: microscope_tracer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pete Hodgson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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'
+description: 
+email:
+- rubygems@thepete.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/microscope_tracer.rb
+- lib/microscope_tracer/faraday_middleware.rb
+- lib/microscope_tracer/headers.rb
+- lib/microscope_tracer/rack_middleware.rb
+- lib/microscope_tracer/span.rb
+- lib/microscope_tracer/trace_logger.rb
+- lib/microscope_tracer/version.rb
+- microscope_tracer.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Logs Microscope-compliant trace entries and wrangles Microscope- HTTP headers.
+test_files: []