instrumenter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c95085fc5bb7e7cb303a374bef702c6991bd5e50
+  data.tar.gz: 0ac211510212f653bd6f5915b51cd378070bf067
+SHA512:
+  metadata.gz: 32a78156f2813dc6a7daf1dc516ce063a1d7073e464b7879cc3a9fd38328501a98bf3744f5f9384e002a115737b4c6dfc93945f9b41a82a5a2338eb1e5b51b82
+  data.tar.gz: bb96ce82454041b7f68eefa9446a6fe75776b44cdf11d17604a1e61d18ccb6312dcbb450d49e2719b8290d38880e084250901c9b8dcc4cc1a81b58edb419308f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at timothy.mukaibo@rea-group.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in instrumenter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Timothy Mukaibo
+
+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,90 @@
+# Instrumenter
+
+Instrumenter is a small gem that was created to allow logging with a single request id across multiple microservice backends. The idea here is that you set an `X-Request-Id` header on your edge, and this Gem will allow you to propagate that value through all your various services. For example:
+
+1. CDN edge generates a request id (setting the `X-Request-Id` header)
+1. The request goes to your first Rack microservice, which is a Rails app
+1. The Rails app then calls another microservice. You add `Instrumenter.log_event(message)` around your call to the second service, and set the `X-Request-Id` header on the call to the second service to the value of `Instrumenter.instance.request_id`
+1. The second service receives the same value for `X-Request-Id` that was generated at the edge
+1. The second (and any subsequent services) can continue to easily pass the same `X-Request-Id` header around, allowing you to trace a single request through multiple backends in your logs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'instrumenter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instrumenter
+
+## Usage
+
+### Usage with Rack apps
+1. Load the Rack middleware
+```$ruby
+require 'instrumenter/instrumenter_middleware'
+use Instrumenter::InstrumenterMiddleware
+```
+
+2. Use it in calls to internal services
+
+```$ruby
+HTTParty.get(url, headers: { 'X-Request-Id': Instrumenter.instance.request_id })
+```
+
+### Usage with Rails apps
+[Lograge](https://github.com/roidrage/lograge) is recommended to get the most out of your logs on Rails
+
+1. Load the Rack middleware in an initializer
+```$ruby
+require 'instrumenter/instrumenter_middleware'
+
+Rails.configuration.middleware.tap do |rack|
+  rack.use Instrumenter::InstrumenterMiddleware
+end
+```
+
+2. Configure logging in environment / application.rb
+
+```$ruby
+module YourApp
+  class Application < Rails::Application
+    config.lograge.enabled = true
+    config.lograge.formatter = Lograge::Formatters::Json.new
+    config.lograge.custom_options = lambda do |event|
+      { request_id: Instrumenter.instance.request_id }
+    end
+  end
+end
+```
+
+3. Use it in calls to internal services
+
+```$ruby
+HTTParty.get(url, headers: { 'X-Request-Id': Instrumenter.instance.request_id })
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mukaibot/instrumenter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Instrumenter project’s codebases, issue trackers and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/instrumenter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+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 "instrumenter"
+
+# 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/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/instrumenter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "instrumenter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "instrumenter"
+  spec.version       = Instrumenter::VERSION
+  spec.authors       = ["Timothy Mukaibo"]
+  spec.email         = ["timothy.mukaibo@rea-group.com"]
+
+  spec.summary       = "Easily add instrumentation to your Rails app"
+  spec.homepage      = "https://github.com/mukaibot/instrumenter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/instrumenter.rb

@@ -0,0 +1,25 @@
+require "instrumenter/instance"
+require "instrumenter/version"
+require "securerandom"
+
+module Instrumenter
+  THREAD_VARIABLE_NAME = 'instrumenter'.freeze
+
+  class << self
+
+    def setup(env)
+      request_id = env.fetch("HTTP_X_REQUEST_ID", SecureRandom.uuid)
+      instrumenter = Instrumenter::Instance.new(request_id)
+      Thread.current[THREAD_VARIABLE_NAME] = instrumenter
+      instrumenter
+    end
+
+    def instance
+      Thread.current[THREAD_VARIABLE_NAME] ||= Instrumenter::Instance.new(SecureRandom.uuid)
+    end
+
+    def clear
+      Thread.current[THREAD_VARIABLE_NAME] = nil
+    end
+  end
+end

data/lib/instrumenter/instance.rb

@@ -0,0 +1,14 @@
+module Instrumenter
+  class Instance
+    attr_reader :logger, :request_id
+
+    def initialize(request_id)
+      @request_id = request_id
+    end
+
+    def log_event(message)
+      event = {request_id: request_id, message: message}.to_json
+      Rails.logger.info event
+    end
+  end
+end

data/lib/instrumenter/instrumenter_middleware.rb

@@ -0,0 +1,16 @@
+module Instrumenter
+  class InstrumenterMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Instrumenter.setup(env)
+      begin
+        @app.call(env)
+      ensure
+        Instrumenter.clear
+      end
+    end
+  end
+end

data/lib/instrumenter/version.rb

@@ -0,0 +1,3 @@
+module Instrumenter
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: instrumenter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Timothy Mukaibo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- timothy.mukaibo@rea-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- instrumenter.gemspec
+- lib/instrumenter.rb
+- lib/instrumenter/instance.rb
+- lib/instrumenter/instrumenter_middleware.rb
+- lib/instrumenter/version.rb
+homepage: https://github.com/mukaibot/instrumenter
+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.11
+signing_key: 
+specification_version: 4
+summary: Easily add instrumentation to your Rails app
+test_files: []