marlowe 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 291c85e33c000a88ba28cdccf0be187169ce7e05
+  data.tar.gz: 0a0f402e1d0a5a3870d265ef59ea596b008dfb1f
+SHA512:
+  metadata.gz: 6f4822e623322547de37cb6fc94f61d7c937fc5712f48eea385678c9c9db4efaa1953a5ff97751a8ab6b0c504fdcda163ced9aa9538be94c331c8645cb9c7732
+  data.tar.gz: 1f40c48a8b2cf0f8fc78c50ff951be7aaa7c3b24bf0fce80c730c6c54714a0343cd5931bd70d1eefed08ae8a654034c64537a3e561f6aedb3164f3809bf3b7f6

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.rdoc

@@ -0,0 +1,4 @@
+=== 1.0.0 / 2015-10-16
+
+* Initial Commit
+

data/Licence.rdoc

@@ -0,0 +1,27 @@
+cence
+
+This software is available under an MIT-style licence.
+
+* Copyright 2015 Kinetic Cafe
+
+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 names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+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/Manifest.txt

@@ -0,0 +1,11 @@
+.autotest
+History.rdoc
+Licence.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/marlowe.rb
+lib/marlowe/formatter.rb
+lib/marlowe/middleware.rb
+lib/marlowe/rails.rb
+lib/marlowe/simple_formatter.rb

data/README.rdoc

@@ -0,0 +1,99 @@
+= marlowe
+
+== Description
+
+{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation id 
+header for Rails and Rack applications to correlate logs for a single request 
+across multiple services.
+
+== Install
+
+You can install it as a gem:
+
+  $ gem install marlowe
+
+or add it into a Gemfile:
+
+  gem 'marlowe'
+
+== Configuration
+
+There is no configuration as of yet. Future plans include configuring the name
+of the correlation id header.
+
+== Accesing the Correlation ID
+
+The correlation id can be accessed throughout the application by accessing the
+{RequestStore}[https://github.com/steveklabnik/request_store] storage.
+
+  RequestStore[:correlation_id]
+
+== Logging
+
+For a rails application, you simply need to change the log formatter to one of
+the provided ones. Correlated versions of both the SimpleFormatter and Formatter 
+are included. 
+
+  # config/environments/development.rb
+  Rails.application.configure do
+    config.log_formatter = CorrelatedSimpleFormatter.new
+  end
+
+
+To create your own formatter, you'll need to access the RequestStore storage.
+You can use this pattern if you've rolled your own logger/formatter:
+
+  # lib/correlated_formatter.rb
+  require 'request_store'
+
+  class CorrelatedSimpleFormatter < ActiveSupport::Logger::SimpleFormatter
+    def call(severity, timestamp, progname, msg)
+      "[#{RequestStore.store[:correlation_id]}] #{super}"
+    end
+  end
+
+
+== Clients
+
+Catching and creating the correlation ID is a great all on its own, but to
+really take advantage of the correlation in a service based architecture you'll
+need to pass the id to the next service in the change.
+
+Here's an example of a {Hurley}[https://github.com/lostisland/hurley] client:
+
+  # lib/correlated_client.rb
+
+  require 'hurley'
+  require 'request_store'
+
+  class Hurley::CorrelatedClient < Hurley::Client
+    def initialize(*args, &block)
+      super
+      header['Correlation-Id'] = ::RequestStore.store[:correlation_id]
+    end
+  end
+
+If you have long-lived Hurley clients, it is also possible to use the Hurley {callback
+machanism}[https://github.com/lostisland/hurley#client-callbacks] to add the
+outgoing headers:
+
+  client.before_call do |request|
+    request.header['Correlation-Id'] = ::RequestStore.store[:correlation_id]
+  end
+
+or 
+  
+  class Correlator
+    def name
+      :correlator
+    end
+
+    def call(request)
+      request.header['Correlation-Id'] = ::RequestStore.store[:correlation_id]
+    end
+  end
+
+  client.before_call(Correlator.new)
+
+
+

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :minitest
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :rdoc
+
+Hoe.spec "marlowe" do
+  developer("Trevor Oke", "toke@kineticcafe.com")
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/lib/marlowe.rb

@@ -0,0 +1,10 @@
+# Marlowe, a correlation id injector.
+module Marlowe
+  VERSION = '1.0.0' #:nodoc:
+
+  require 'marlowe/middleware'
+  require 'marlowe/rails' if defined? Rails::Railtie
+
+  autoload :Formatter, 'marlowe/formatter'
+  autoload :SimpleFormatter, 'marlowe/simple_formatter'
+end

data/lib/marlowe/formatter.rb

@@ -0,0 +1,14 @@
+require 'request_store'
+
+module Marlowe
+
+  # Marlowe::Formatter is a subclass of +ActiveSupport::Logger::Formatter+
+  # that adds a correlation id string to a rails log.
+  class Formatter < ActiveSupport::Logger::Formatter
+
+    # Overrides the formatter return to add the correlation id.
+    def call(severity, timestamp, progname, msg)
+      "[#{RequestStore.store[:correlation_id]}] #{super}"
+    end
+  end
+end

data/lib/marlowe/middleware.rb

@@ -0,0 +1,26 @@
+require 'rack'
+require 'request_store'
+require 'securerandom'
+
+module Marlowe
+  # Marlowe correlation id middleware. Including this into your
+  # middleware stack will add a 'Correlation-Id' header as an incoming
+  # request, and save that id in a request session variable.
+
+  class Middleware
+    # Sets the the rack application to +app+
+    def initialize(app)
+      @app = app
+    end
+
+    # Stores the incoming correlation id from the +env+ hash. If the correlation
+    # id has not been sent, a new UUID is generated and the +env+ is modified.
+    def call(env)
+      env['HTTP_CORRELATION_ID'] ||= SecureRandom.uuid
+      RequestStore.store[:correlation_id] = env['HTTP_CORRELATION_ID']
+
+      @status, @headers, @response = @app.call(env)
+      [@status, @headers, @response]
+    end
+  end
+end

data/lib/marlowe/rails.rb

@@ -0,0 +1,12 @@
+module Marlowe
+  class Railtie < Rails::Railtie
+    initializer 'marlowe.configure_rails_initialization' do
+      app.middleware.insert_before Rails::Rack::Logger, Marlowe::Middleware
+    end
+
+    #:nodoc:
+    def app
+      Rails.application
+    end
+  end
+end

data/lib/marlowe/simple_formatter.rb

@@ -0,0 +1,16 @@
+require 'request_store'
+
+module Marlowe
+  # Marlowe::SimpleFormatter is a subclass of
+  # +ActiveSupport::Logger::SimpleFormatter+ that adds a correlation id
+  # string to a rails log.
+  class SimpleFormatter < ActiveSupport::Logger::SimpleFormatter
+
+    # Overrides the formatter return to add the correlation id.
+    def call(severity, timestamp, progname, msg)
+      "[#{RequestStore.store[:correlation_id]}] #{super}"
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: marlowe
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trevor Oke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+description: "{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation
+  id \nheader for Rails and Rack applications to correlate logs for a single request
+  \nacross multiple services."
+email:
+- toke@kineticcafe.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Licence.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ".autotest"
+- History.rdoc
+- Licence.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/marlowe.rb
+- lib/marlowe/formatter.rb
+- lib/marlowe/middleware.rb
+- lib/marlowe/rails.rb
+- lib/marlowe/simple_formatter.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+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.4.8
+signing_key: 
+specification_version: 4
+summary: "{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation
+  id  header for Rails and Rack applications to correlate logs for a single request
+  \ across multiple services."
+test_files: []