concise_logging 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +40 -0
- data/Rakefile +2 -0
- data/concise_logging.gemspec +22 -0
- data/lib/concise_logging.rb +3 -0
- data/lib/concise_logging/log_middleware.rb +15 -0
- data/lib/concise_logging/log_subscriber.rb +72 -0
- data/lib/concise_logging/version.rb +3 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: a9038b0d3a150fd312a6a77851a1bd4a2786522f
|
4
|
+
data.tar.gz: 73d045e793888426413a37f1658959b86ad9ab4a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d8c3a0a2b7bc52c97f6054b3dd97e0ca29a8858cd0a0904138be97385f798c8e8adb6e575847a3e9fbd342a4ba1adea197bfb2a2e7faf53221a74172f32b1efe
|
7
|
+
data.tar.gz: 531e929b45056feb0b15829df9a87bc3f4278f9f58bb29d4dd29a4f8ed0fc3c9851a318cf0a3cacc9f197bf9e0ae9bca1a29349c834550ca24a73732106359e8
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Gerry Shaw
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# ConciseLogging
|
2
|
+
|
3
|
+
Alternate logging for Rails production servers
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'concise_logging'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install concise_logging
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Add this to your `config/production.rb`. Configure tagging as per your desires.
|
24
|
+
|
25
|
+
````ruby
|
26
|
+
config.middleware.use "ConciseLogging::LogMiddleware"
|
27
|
+
ConciseLogging::LogSubscriber.attach_to :action_controller
|
28
|
+
|
29
|
+
config.log_level = :warn
|
30
|
+
config.log_tags = ["cv-#{Rails.env[0]}"]
|
31
|
+
config.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(File.join(Rails.root, "log", "#{Rails.env}.log")))
|
32
|
+
````
|
33
|
+
|
34
|
+
## Contributing
|
35
|
+
|
36
|
+
1. Fork it ( https://github.com/[my-github-username]/concise_logging/fork )
|
37
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
38
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
39
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
40
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'concise_logging/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "concise_logging"
|
8
|
+
spec.version = ConciseLogging::VERSION
|
9
|
+
spec.authors = ["Gerry Shaw"]
|
10
|
+
spec.email = ["gerry_shaw@yahoo.com"]
|
11
|
+
spec.summary = %q{Alternate logging for Rails production servers}
|
12
|
+
spec.homepage = "https://github.com/gshaw/concise_logging"
|
13
|
+
spec.license = "MIT"
|
14
|
+
|
15
|
+
spec.files = `git ls-files -z`.split("\x0")
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
21
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
22
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
module ConciseLogging
|
2
|
+
class LogMiddleware
|
3
|
+
def initialize(app)
|
4
|
+
@app = app
|
5
|
+
end
|
6
|
+
|
7
|
+
def call(env)
|
8
|
+
request = ActionDispatch::Request.new(env)
|
9
|
+
Thread.current[:logged_ip] = request.ip
|
10
|
+
@app.call(env)
|
11
|
+
ensure
|
12
|
+
Thread.current[:logged_ip] = nil
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
module ConciseLogging
|
2
|
+
class LogSubscriber < ActiveSupport::LogSubscriber
|
3
|
+
INTERNAL_PARAMS = %w(controller action format _method only_path)
|
4
|
+
|
5
|
+
def redirect_to(event)
|
6
|
+
Thread.current[:logged_location] = event.payload[:location]
|
7
|
+
end
|
8
|
+
|
9
|
+
def process_action(event)
|
10
|
+
payload = event.payload
|
11
|
+
param_method = payload[:params]["_method"]
|
12
|
+
method = param_method ? param_method.upcase : payload[:method]
|
13
|
+
status, exception_details = compute_status(payload)
|
14
|
+
path = payload[:path].to_s.gsub(/\?.*/, "")
|
15
|
+
params = payload[:params].except(*INTERNAL_PARAMS)
|
16
|
+
|
17
|
+
ip = Thread.current[:logged_ip]
|
18
|
+
location = Thread.current[:logged_location]
|
19
|
+
Thread.current[:logged_location] = nil
|
20
|
+
|
21
|
+
app = payload[:view_runtime].to_i
|
22
|
+
db = payload[:db_runtime].to_i
|
23
|
+
|
24
|
+
message = format(
|
25
|
+
"%{method} %{status} %{ip} %{path}",
|
26
|
+
ip: format("%-15s", ip),
|
27
|
+
method: format_method(format("%-6s", method)),
|
28
|
+
status: format_status(status),
|
29
|
+
path: path
|
30
|
+
)
|
31
|
+
message << " redirect_to=#{location}" if location.present?
|
32
|
+
message << " parameters=#{params}" if params.present?
|
33
|
+
message << " #{color(exception_details, RED)}" if exception_details.present?
|
34
|
+
message << " (app:#{app}ms db:#{db}ms)"
|
35
|
+
|
36
|
+
logger.warn message
|
37
|
+
end
|
38
|
+
|
39
|
+
def compute_status(payload)
|
40
|
+
details = nil
|
41
|
+
status = payload[:status]
|
42
|
+
if status.nil? && payload[:exception].present?
|
43
|
+
exception_class_name = payload[:exception].first
|
44
|
+
status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
|
45
|
+
|
46
|
+
if payload[:exception].respond_to?(:uniq)
|
47
|
+
details = payload[:exception].uniq.join(" ")
|
48
|
+
end
|
49
|
+
end
|
50
|
+
[status, details]
|
51
|
+
end
|
52
|
+
|
53
|
+
def format_method(method)
|
54
|
+
if method.strip == "GET"
|
55
|
+
method
|
56
|
+
else
|
57
|
+
color(method, CYAN)
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
def format_status(status)
|
62
|
+
status = status.to_i
|
63
|
+
if status >= 400
|
64
|
+
color(status, RED)
|
65
|
+
elsif status >= 300
|
66
|
+
color(status, YELLOW)
|
67
|
+
else
|
68
|
+
color(status, GREEN)
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: concise_logging
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Gerry Shaw
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-10-11 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
description:
|
42
|
+
email:
|
43
|
+
- gerry_shaw@yahoo.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- ".gitignore"
|
49
|
+
- Gemfile
|
50
|
+
- LICENSE.txt
|
51
|
+
- README.md
|
52
|
+
- Rakefile
|
53
|
+
- concise_logging.gemspec
|
54
|
+
- lib/concise_logging.rb
|
55
|
+
- lib/concise_logging/log_middleware.rb
|
56
|
+
- lib/concise_logging/log_subscriber.rb
|
57
|
+
- lib/concise_logging/version.rb
|
58
|
+
homepage: https://github.com/gshaw/concise_logging
|
59
|
+
licenses:
|
60
|
+
- MIT
|
61
|
+
metadata: {}
|
62
|
+
post_install_message:
|
63
|
+
rdoc_options: []
|
64
|
+
require_paths:
|
65
|
+
- lib
|
66
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
requirements: []
|
77
|
+
rubyforge_project:
|
78
|
+
rubygems_version: 2.2.2
|
79
|
+
signing_key:
|
80
|
+
specification_version: 4
|
81
|
+
summary: Alternate logging for Rails production servers
|
82
|
+
test_files: []
|