first commit

This commit is contained in:
aserafin 2015-04-14 14:29:07 +02:00
commit adde009a64
12 changed files with 189 additions and 0 deletions

9
.gitignore vendored Normal file
View file

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

4
Gemfile Normal file
View file

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

21
LICENSE.txt Normal file
View file

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2015 aserafin
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.

39
README.md Normal file
View file

@ -0,0 +1,39 @@
# GrapeLogging
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/grape_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 'grape_logging'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install grape_logging
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
1. Fork it ( https://github.com/[my-github-username]/grape_logging/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

2
Rakefile Normal file
View file

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

14
bin/console Normal file
View file

@ -0,0 +1,14 @@
#!/usr/bin/env ruby
require 'bundler/setup'
require 'grape_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

7
bin/setup Normal file
View file

@ -0,0 +1,7 @@
#!/bin/bash
set -euo pipefail
IFS=$'\n\t'
bundle install
# Do any other automated setup that you need to do here

30
grape_logging.gemspec Normal file
View file

@ -0,0 +1,30 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'grape_logging/version'
Gem::Specification.new do |spec|
spec.name = 'grape_logging'
spec.version = GrapeLogging::VERSION
spec.authors = ['aserafin']
spec.email = ['adrian@softmad.pl']
if spec.respond_to?(:metadata)
spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
end
spec.summary = %q{Out of the box request logging for Grape!}
spec.description = %q{This gem provides simple request logging for Grape with just 2 lines of code you have to put in your project! In return you will get response codes, parameters, total response duration and time spent in db (if you are using ActiveRecord.)}
spec.homepage = 'http://github.com/aserafin/grape_logging'
spec.license = 'MIT'
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ['lib']
spec.add_dependency 'grape'
spec.add_development_dependency 'bundler', '~> 1.8'
spec.add_development_dependency 'rake', '~> 10.0'
end

3
lib/grape_logging.rb Normal file
View file

@ -0,0 +1,3 @@
require 'grape_logging/version'
require 'grape_logging/formatters/default'
require 'grape_logging/middleware/request_logger'

View file

@ -0,0 +1,21 @@
module GrapeLogging
module Formatters
class Default
def call(severity, datetime, _, data)
"[#{datetime}] #{severity} -- #{data.delete(:status)} -- total=#{data.delete(:total)} db=#{data.delete(:db)} -- #{data.delete(:method)} #{data.delete(:path)} #{format(data)}\n"
end
def format(data)
if data.is_a?(String)
data
elsif data.is_a?(Exception)
[data.to_s, data.backtrace].flatten.join('\n')
elsif data.is_a?(Hash)
data.keys.sort.map { |key| "#{key}=#{data[key]}" }.join(' ')
else
data.inspect
end
end
end
end
end

View file

@ -0,0 +1,36 @@
require 'grape/middleware/base'
module GrapeLogging
module Middleware
class RequestLogger < Grape::Middleware::Base
def before
@env[:db_duration] = 0
ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
event = ActiveSupport::Notifications::Event.new(*args)
@env[:db_duration] += event.duration
end if defined?(ActiveRecord)
end
def call!(env)
original_response = nil
duration = Benchmark.realtime { original_response = super(env) }
@app.logger.info parameters(::Rack::Request.new(env), original_response, duration)
original_response
end
protected
def parameters(request, response, duration)
{
path: request.path,
params: request.params,
method: request.request_method,
total: (duration * 1000).round(2),
db: request.env[:db_duration].round(2),
status: response.first
}
end
end
end
end

View file

@ -0,0 +1,3 @@
module GrapeLogging
VERSION = '1.0.0'
end