request_id_logging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36731647d62a626d9fa3006fed3bdcad57c0fd03
+  data.tar.gz: 050638faabbc82a4143f94e105d1c45f7a3f87c4
+SHA512:
+  metadata.gz: 61072d856d4ebe017931b627fabc530d5a3c778c7b745cf0674a102338be52efb16c0178fc2a71f2a183ab1d60b0d75c8b66ca9b39bba23066fde268ef375563
+  data.tar.gz: e9f9a553c43f194e83ffdacfc380af350b9e647eee2e00db063f5dc972304a6193eaa92eb4872cf3b3c81cbd73c26d5f7f9171f22b4d3368b8fed74283ef30c0

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/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6
+script: rake spec

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 ryu39. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in request_id_logging.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 ryu39
+
+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,43 @@
+# RequestIdLogging
+
+[![Build Status](https://travis-ci.org/ryu39/request_id_logging.svg?branch=master)](https://travis-ci.org/ryu39/request_id_logging)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/request_id_logging`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_id_logging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install request_id_logging
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/request_id_logging. 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).
+

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 "request_id_logging"
+
+# 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

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/request_id_logging/constants.rb

@@ -0,0 +1,3 @@
+module RequestIdLogging
+  FIBER_LOCAL_KEY = :"RequestIdLogging::RequestId"
+end

data/lib/request_id_logging/formatter.rb

@@ -0,0 +1,36 @@
+require 'request_id_logging/constants'
+require 'logger'
+
+module RequestIdLogging
+  class Formatter < Logger::Formatter
+    DEFAULT_REQ_ID_PROC = ->(id) { id }
+
+    # Initialize RequestIdLogging::Formatter
+    #
+    # @param [Logger::Formatter] formatter Optional, if you have original formatter, please specify it to this arg.
+    #   This formatter prepends request_id to message, and calls your formatter #call method.
+    #   If not specified, then message is generated in this formatter.
+    # @param [Proc] request_id_proc Optional, proc object or lambda to customize logged request_id.
+    #   If not specified, then raw request_id is used.
+    def initialize(formatter: nil, request_id_proc: DEFAULT_REQ_ID_PROC)
+      super()
+      @original_formatter = formatter
+      @req_id_proc = request_id_proc || DEFAULT_PROC
+    end
+
+    def call(severity, time, progname, msg)
+      @original_formatter ? @original_formatter.call(severity, time, progname, new_msg(msg)) : super(severity, time, progname, new_msg(msg))
+    end
+
+    private
+
+    def new_msg(msg)
+      "[#{request_id}] #{msg2str(msg)}"
+    end
+
+    def request_id
+      id = Thread.current[RequestIdLogging::FIBER_LOCAL_KEY]
+      @req_id_proc.call(id)
+    end
+  end
+end

data/lib/request_id_logging/middleware.rb

@@ -0,0 +1,28 @@
+require 'request_id_logging/constants'
+
+module RequestIdLogging
+  # Rack middleware for logging with request_id.
+  #
+  # Please insert after ActionDispatch::RequestId in your application.rb like as follows.
+  #
+  #   module YourApp
+  #     class Application < Rails::Application
+  #       # some configurations...
+  #
+  #       config.middleware.insert_after ActionDispatch::RequestId, RequestIdLogging::Middleware
+  #     end
+  #   end
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request_id = env['action_dispatch.request_id']
+      Thread.current[RequestIdLogging::FIBER_LOCAL_KEY] = request_id
+      @app.call(env)
+    ensure
+      Thread.current[RequestIdLogging::FIBER_LOCAL_KEY] = nil
+    end
+  end
+end

data/lib/request_id_logging/version.rb

@@ -0,0 +1,3 @@
+module RequestIdLogging
+  VERSION = '0.1.0'
+end

data/lib/request_id_logging.rb

@@ -0,0 +1,3 @@
+require 'request_id_logging/version'
+require 'request_id_logging/middleware'
+require 'request_id_logging/formatter'

data/request_id_logging.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_id_logging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'request_id_logging'
+  spec.version       = RequestIdLogging::VERSION
+  spec.authors       = ['ryu39']
+  spec.email         = ['dev.ryu39@gmail.com']
+
+  spec.summary       = %q{Logging with request id in your Rails app.}
+  spec.description   = <<EOS.gsub("\n", ' ')
+This gems provide a Rack middleware and a logger formatter for logging with request id in your Rails app.
+EOS
+  spec.homepage      = 'https://github.com/ryu39/request_id_logging'
+  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.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: request_id_logging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryu39
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 'This gems provide a Rack middleware and a logger formatter for logging
+  with request id in your Rails app. '
+email:
+- dev.ryu39@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/request_id_logging.rb
+- lib/request_id_logging/constants.rb
+- lib/request_id_logging/formatter.rb
+- lib/request_id_logging/middleware.rb
+- lib/request_id_logging/version.rb
+- request_id_logging.gemspec
+homepage: https://github.com/ryu39/request_id_logging
+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.7
+signing_key: 
+specification_version: 4
+summary: Logging with request id in your Rails app.
+test_files: []