rack-instrument 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +5 -0
- data/LICENSE.txt +22 -0
- data/README.md +51 -0
- data/Rakefile +1 -0
- data/examples/config.ru +17 -0
- data/lib/rack/instrument.rb +79 -0
- data/rack-instrument.gemspec +25 -0
- metadata +95 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: fecc12632b181a794b76c07ebd53bef7441b6e70
|
4
|
+
data.tar.gz: 8632c4c9bf2243d3f26a0c19669b15827e6b3c12
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3a7a3e1d6ab3c45322e8b0375de35b42d3bff5a0de9527d9a47da61d8cef9f42dc88332702abdb6b8a404248376684124375f035e630ac967571b89f19b981b0
|
7
|
+
data.tar.gz: a31516d6522937fb8ca8e9dbf195d06922018c7354fa4de372735d6375e4d5d581ed646694169ff07ce7363c8d549fb75ed1ec671c5e45416f55574a29c1dd97
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 brookemckim
|
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,51 @@
|
|
1
|
+
# Rack::Instrument
|
2
|
+
|
3
|
+
Rack::Instrument is a rack middleware for instrumenting request time,
|
4
|
+
total requests, and total requests per path. I am testing with
|
5
|
+
[statsd](https://github.com/reinh/statsd) as an instrumenter, but you can use any
|
6
|
+
object that responds to increment or timing.
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
gem 'rack-instrument'
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install rack-instrument
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'rack/instrument'
|
26
|
+
require 'statsd'
|
27
|
+
|
28
|
+
# Instansiate your instrumenter.
|
29
|
+
statsd = Statsd.new 'localhost'
|
30
|
+
statsd.namespace = 'myapp'
|
31
|
+
|
32
|
+
# Pass the instrumentor along with an Array of the metrics you would
|
33
|
+
# like.
|
34
|
+
#
|
35
|
+
# Metrics
|
36
|
+
# :request - Increments the total request count.
|
37
|
+
# :time - Records total request time.
|
38
|
+
# :path - Increments the total request count per path.
|
39
|
+
use Rack::Instrument, statsd, [:request, :time, :path]
|
40
|
+
```
|
41
|
+
|
42
|
+
Check the examples directory for more examples.
|
43
|
+
|
44
|
+
## Contributing
|
45
|
+
|
46
|
+
1. Fork it
|
47
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
48
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
49
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
50
|
+
5. Create new Pull Request
|
51
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/examples/config.ru
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Example rack application that uses statsd-ruby for instrumentation
|
2
|
+
|
3
|
+
require 'rack'
|
4
|
+
require 'rack/instrument'
|
5
|
+
require 'statsd' # https://github.com/reinh/statsd
|
6
|
+
|
7
|
+
statsd = Statsd.new 'localhost'
|
8
|
+
statsd.namespace = 'myapp'
|
9
|
+
|
10
|
+
use Rack::Instrument, statsd, [:request, :time, :path]
|
11
|
+
|
12
|
+
map '/' do
|
13
|
+
run lambda { |env|
|
14
|
+
[200, {}, ["Instrumenting is Instrumental\n"]]
|
15
|
+
}
|
16
|
+
end
|
17
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
require 'rack'
|
2
|
+
|
3
|
+
class Rack::Instrument
|
4
|
+
# This can be used as the instrument in order to disable instrumentation
|
5
|
+
# without removing it completely.
|
6
|
+
#
|
7
|
+
# use Rack::Instrument, Rack::Instrument::NullInstrument.new
|
8
|
+
class NullInstrument
|
9
|
+
def increment(*args); end
|
10
|
+
def timing(*args); end
|
11
|
+
end
|
12
|
+
|
13
|
+
# use Rack::Instrument, Statsd.new('localhost'), [:request, :time, :path]
|
14
|
+
def initialize(app, instrument, instrumentations = [])
|
15
|
+
@app = app
|
16
|
+
@instrument = instrument || NullInstrument.new
|
17
|
+
|
18
|
+
@instrument_request = instrumentations.include? :request
|
19
|
+
@instrument_time = instrumentations.include? :time
|
20
|
+
@instrument_path = instrumentations.include? :path
|
21
|
+
end
|
22
|
+
|
23
|
+
attr_accessor :instrument
|
24
|
+
|
25
|
+
# Flag for whether or not requests should be counted.
|
26
|
+
attr_reader :instrument_request
|
27
|
+
|
28
|
+
# Flag for whether or not requests should be timed.
|
29
|
+
attr_reader :instrument_time
|
30
|
+
|
31
|
+
# Flag for whether or not specific paths should be counted.
|
32
|
+
attr_reader :instrument_path
|
33
|
+
|
34
|
+
# Rack
|
35
|
+
def call(env)
|
36
|
+
request_start = Time.now
|
37
|
+
|
38
|
+
record_request
|
39
|
+
record_path(env)
|
40
|
+
|
41
|
+
status, headers, response = @app.call(env)
|
42
|
+
|
43
|
+
record_time(request_start)
|
44
|
+
|
45
|
+
[status, headers, response]
|
46
|
+
end
|
47
|
+
|
48
|
+
# Count the total number of requests.
|
49
|
+
def record_request
|
50
|
+
return unless instrument_request
|
51
|
+
|
52
|
+
instrument.increment 'requests'
|
53
|
+
end
|
54
|
+
|
55
|
+
# Instrument the total request time.
|
56
|
+
def record_time(request_start)
|
57
|
+
return unless instrument_time
|
58
|
+
|
59
|
+
request_end = Time.now
|
60
|
+
request_time = (request_end - request_start) * 1000
|
61
|
+
|
62
|
+
instrument.timing 'request_time', request_time
|
63
|
+
end
|
64
|
+
|
65
|
+
# Count the number of times a specific path has been visited.
|
66
|
+
def record_path(env)
|
67
|
+
return unless instrument_path
|
68
|
+
|
69
|
+
# Normalize and remove leading /
|
70
|
+
path = env['REQUEST_PATH'].downcase.slice(1..-1)
|
71
|
+
|
72
|
+
# Convert / to _
|
73
|
+
path_key = path.gsub('/', '_').gsub('.', '_')
|
74
|
+
path_key = 'index' if path_key.empty?
|
75
|
+
|
76
|
+
instrument.increment 'requests.' + path_key
|
77
|
+
end
|
78
|
+
end
|
79
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'rack-instrument'
|
7
|
+
spec.version = '0.0.1'
|
8
|
+
spec.authors = ['Brooke McKim']
|
9
|
+
spec.email = ['brooke.mckim@gmail.com']
|
10
|
+
spec.description = %q{Rack middleware for recording request metrics}
|
11
|
+
spec.summary = %q{Rack::Instrument is a rack middleware for instrumenting request time, total requests, and total requests per path.}
|
12
|
+
spec.homepage = "https://github.com/brookemckim/rack-instrument"
|
13
|
+
spec.license = "MIT"
|
14
|
+
|
15
|
+
spec.files = `git ls-files`.split($/)
|
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.3'
|
21
|
+
spec.add_development_dependency 'rake'
|
22
|
+
|
23
|
+
spec.add_dependency 'rack'
|
24
|
+
end
|
25
|
+
|
metadata
ADDED
@@ -0,0 +1,95 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rack-instrument
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Brooke McKim
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-04-06 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.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rack
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: Rack middleware for recording request metrics
|
56
|
+
email:
|
57
|
+
- brooke.mckim@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- .gitignore
|
63
|
+
- Gemfile
|
64
|
+
- LICENSE.txt
|
65
|
+
- README.md
|
66
|
+
- Rakefile
|
67
|
+
- examples/config.ru
|
68
|
+
- lib/rack/instrument.rb
|
69
|
+
- rack-instrument.gemspec
|
70
|
+
homepage: https://github.com/brookemckim/rack-instrument
|
71
|
+
licenses:
|
72
|
+
- MIT
|
73
|
+
metadata: {}
|
74
|
+
post_install_message:
|
75
|
+
rdoc_options: []
|
76
|
+
require_paths:
|
77
|
+
- lib
|
78
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - '>='
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
84
|
+
requirements:
|
85
|
+
- - '>='
|
86
|
+
- !ruby/object:Gem::Version
|
87
|
+
version: '0'
|
88
|
+
requirements: []
|
89
|
+
rubyforge_project:
|
90
|
+
rubygems_version: 2.0.3
|
91
|
+
signing_key:
|
92
|
+
specification_version: 4
|
93
|
+
summary: Rack::Instrument is a rack middleware for instrumenting request time, total
|
94
|
+
requests, and total requests per path.
|
95
|
+
test_files: []
|