queries_watch 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +7 -0
- data/CHANGELOG.md +3 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +64 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/queries_watch.rb +15 -0
- data/lib/queries_watch/configuration.rb +8 -0
- data/lib/queries_watch/current.rb +37 -0
- data/lib/queries_watch/helpers.rb +22 -0
- data/lib/queries_watch/railtie.rb +19 -0
- data/lib/queries_watch/subscriber.rb +27 -0
- data/lib/queries_watch/version.rb +3 -0
- data/queries_watch.gemspec +29 -0
- metadata +119 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 61e240b2f84eb8df9f5b5211771f481df29b4f63d4822beef35838c768a1f81b
|
4
|
+
data.tar.gz: d60f318296569a96e954cc21a705031daed1955786c4a48894464f9826ad9a1e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5bab1c9b21706fa4966bb69506d7bbf637adbf5836e5e93405e4a052b39338241f06ee85e8aac8d1ee7e823b9867b9c7f14e58749d83ddc4f0680b0ccccebcb7
|
7
|
+
data.tar.gz: eb659c6434f31478d3ed19d774ad8fa544a96f4d138cd741dce4abf2e394e1d174b3d714b84920d34c0a478e5df3a21fe9bffcb9a2af8b8ce3f7f9aa57cbc98e
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at lala.akira@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 aki
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# Queries Watch
|
2
|
+
|
3
|
+
An overview of the number of queries is output to the log and browser console.
|
4
|
+
|
5
|
+
`log/development.log`:
|
6
|
+
|
7
|
+
```
|
8
|
+
Queries total_count: 5, cached_count: 0, exec_count: 5, total_duration: 4.4ms
|
9
|
+
```
|
10
|
+
|
11
|
+
Browser console:
|
12
|
+
|
13
|
+
[![Image from Gyazo](https://i.gyazo.com/6cc0653c42ed02fa3b2cdb312897e40f.png)](https://gyazo.com/6cc0653c42ed02fa3b2cdb312897e40f)
|
14
|
+
|
15
|
+
## Usage
|
16
|
+
|
17
|
+
In `app/views/layout/application.html.haml`:
|
18
|
+
|
19
|
+
```haml
|
20
|
+
!!!
|
21
|
+
%html
|
22
|
+
%head
|
23
|
+
%title MyAPP
|
24
|
+
= favicon_link_tag '/favicon.ico'
|
25
|
+
%body
|
26
|
+
= yield
|
27
|
+
- if Rails.env.development?
|
28
|
+
= queries_watch_summary
|
29
|
+
```
|
30
|
+
|
31
|
+
## Installation
|
32
|
+
|
33
|
+
Add this line to your application's Gemfile:
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
gem 'queries_watch', group: 'development'
|
37
|
+
```
|
38
|
+
|
39
|
+
And then execute:
|
40
|
+
|
41
|
+
```
|
42
|
+
$ bundle
|
43
|
+
```
|
44
|
+
|
45
|
+
## Configuration
|
46
|
+
|
47
|
+
In `config/initializers/queries_watch.rb`, you can configure the following values.
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
if Rails.env.development?
|
51
|
+
QueriesWatch.configure do |config|
|
52
|
+
config.warn_threshold = 30 # default: nil
|
53
|
+
config.error_threshold = 100 # default: nil
|
54
|
+
end
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
## License
|
59
|
+
|
60
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
61
|
+
|
62
|
+
## Code of Conduct
|
63
|
+
|
64
|
+
Everyone interacting in the QueriesWatch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aki77/queries_watch/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "queries_watch"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'queries_watch/version'
|
2
|
+
require 'queries_watch/railtie'
|
3
|
+
require 'queries_watch/configuration'
|
4
|
+
|
5
|
+
module QueriesWatch
|
6
|
+
class << self
|
7
|
+
def configure
|
8
|
+
yield(configuration)
|
9
|
+
end
|
10
|
+
|
11
|
+
def configuration
|
12
|
+
@configuration ||= Configuration.new
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module QueriesWatch
|
4
|
+
class Current < ActiveSupport::CurrentAttributes
|
5
|
+
attribute :logs
|
6
|
+
|
7
|
+
resets { self.logs = [] }
|
8
|
+
|
9
|
+
def initialize
|
10
|
+
super
|
11
|
+
self.logs = []
|
12
|
+
end
|
13
|
+
|
14
|
+
def summary
|
15
|
+
total_count = logs.size
|
16
|
+
cached_count = logs.count { |log| log[:cached] }
|
17
|
+
exec_count = total_count - cached_count
|
18
|
+
total_duration = '%.1fms' % logs.sum { |log| log[:duration] }
|
19
|
+
|
20
|
+
OpenStruct.new({ total_count: total_count, cached_count: cached_count, exec_count: exec_count, total_duration: total_duration }).freeze
|
21
|
+
end
|
22
|
+
|
23
|
+
def level
|
24
|
+
error_threshold = QueriesWatch.configuration.error_threshold || Float::INFINITY
|
25
|
+
warn_threshold = QueriesWatch.configuration.warn_threshold || Float::INFINITY
|
26
|
+
|
27
|
+
case logs.count { |log| !log[:cached] }
|
28
|
+
when error_threshold..Float::INFINITY
|
29
|
+
:error
|
30
|
+
when warn_threshold..Float::INFINITY
|
31
|
+
:warn
|
32
|
+
else
|
33
|
+
:info
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module QueriesWatch
|
4
|
+
module Helpers
|
5
|
+
def queries_watch_summary
|
6
|
+
summary = Current.summary
|
7
|
+
messaage = "%c[Queries] %ctotal_count: #{summary.total_count}, cached_count: #{summary.cached_count}, exec_count: #{summary.exec_count}, total_duration: #{summary.total_duration}"
|
8
|
+
logs = Current.logs.map do |log|
|
9
|
+
log.merge(duration: log[:duration].round(2))
|
10
|
+
end
|
11
|
+
|
12
|
+
javascript_tag <<~JS
|
13
|
+
if (console && console.groupCollapsed) {
|
14
|
+
console.#{Current.level}('#{messaage}', 'font-weight: bold', '')
|
15
|
+
console.groupCollapsed()
|
16
|
+
console.table(#{logs.to_json})
|
17
|
+
console.groupEnd()
|
18
|
+
}
|
19
|
+
JS
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module QueriesWatch
|
4
|
+
class Railtie < Rails::Railtie
|
5
|
+
initializer 'initialize_queries_watch', after: 'active_support.reset_all_current_attributes_instances' do |app|
|
6
|
+
require 'queries_watch/subscriber'
|
7
|
+
Subscriber.attach_to :active_record
|
8
|
+
|
9
|
+
app.executor.to_complete(prepend: true) do
|
10
|
+
Subscriber.flush
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
ActiveSupport.on_load :action_view do
|
15
|
+
require 'queries_watch/helpers'
|
16
|
+
include Helpers
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'queries_watch/current'
|
3
|
+
|
4
|
+
module QueriesWatch
|
5
|
+
class Subscriber < ActiveSupport::Subscriber
|
6
|
+
COLORS = {
|
7
|
+
info: ActiveSupport::LogSubscriber::CYAN,
|
8
|
+
warn: ActiveSupport::LogSubscriber::YELLOW,
|
9
|
+
error: ActiveSupport::LogSubscriber::RED,
|
10
|
+
}
|
11
|
+
|
12
|
+
def sql(event)
|
13
|
+
return if event.payload[:name] == 'SCHEMA'
|
14
|
+
|
15
|
+
log = event.payload.slice(:name, :sql, :cached).merge(duration: event.duration)
|
16
|
+
Current.logs << log
|
17
|
+
end
|
18
|
+
|
19
|
+
def self.flush
|
20
|
+
summary = Current.summary
|
21
|
+
level = Current.level
|
22
|
+
name = ActiveSupport::LogSubscriber.new.send(:color, 'Queries', COLORS.fetch(level), true)
|
23
|
+
message = "#{name} total_count: #{summary.total_count}, cached_count: #{summary.cached_count}, exec_count: #{summary.exec_count}, total_duration: #{summary.total_duration}"
|
24
|
+
Rails.logger.public_send(level, message)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
lib = File.expand_path("lib", __dir__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require "queries_watch/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "queries_watch"
|
7
|
+
spec.version = QueriesWatch::VERSION
|
8
|
+
spec.authors = ["aki77"]
|
9
|
+
spec.email = ["aki77@users.noreply.github.com"]
|
10
|
+
|
11
|
+
spec.summary = %q{An overview of the number of queries is output to the log and browser console.}
|
12
|
+
spec.description = %q{An overview of the number of queries is output to the log and browser console.}
|
13
|
+
spec.homepage = "https://github.com/aki77/queries_watch"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
# Specify which files should be added to the gem when it is released.
|
17
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
18
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
19
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
20
|
+
end
|
21
|
+
spec.bindir = "exe"
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
|
+
spec.require_paths = ["lib"]
|
24
|
+
|
25
|
+
spec.add_dependency 'rails', '>= 5.2.0'
|
26
|
+
spec.add_development_dependency "bundler", "~> 2.0"
|
27
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
28
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
29
|
+
end
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: queries_watch
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- aki77
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-07-06 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rails
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 5.2.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 5.2.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
description: An overview of the number of queries is output to the log and browser
|
70
|
+
console.
|
71
|
+
email:
|
72
|
+
- aki77@users.noreply.github.com
|
73
|
+
executables: []
|
74
|
+
extensions: []
|
75
|
+
extra_rdoc_files: []
|
76
|
+
files:
|
77
|
+
- ".gitignore"
|
78
|
+
- ".rspec"
|
79
|
+
- ".travis.yml"
|
80
|
+
- CHANGELOG.md
|
81
|
+
- CODE_OF_CONDUCT.md
|
82
|
+
- Gemfile
|
83
|
+
- LICENSE.txt
|
84
|
+
- README.md
|
85
|
+
- Rakefile
|
86
|
+
- bin/console
|
87
|
+
- bin/setup
|
88
|
+
- lib/queries_watch.rb
|
89
|
+
- lib/queries_watch/configuration.rb
|
90
|
+
- lib/queries_watch/current.rb
|
91
|
+
- lib/queries_watch/helpers.rb
|
92
|
+
- lib/queries_watch/railtie.rb
|
93
|
+
- lib/queries_watch/subscriber.rb
|
94
|
+
- lib/queries_watch/version.rb
|
95
|
+
- queries_watch.gemspec
|
96
|
+
homepage: https://github.com/aki77/queries_watch
|
97
|
+
licenses:
|
98
|
+
- MIT
|
99
|
+
metadata: {}
|
100
|
+
post_install_message:
|
101
|
+
rdoc_options: []
|
102
|
+
require_paths:
|
103
|
+
- lib
|
104
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - ">="
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '0'
|
109
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
110
|
+
requirements:
|
111
|
+
- - ">="
|
112
|
+
- !ruby/object:Gem::Version
|
113
|
+
version: '0'
|
114
|
+
requirements: []
|
115
|
+
rubygems_version: 3.0.3
|
116
|
+
signing_key:
|
117
|
+
specification_version: 4
|
118
|
+
summary: An overview of the number of queries is output to the log and browser console.
|
119
|
+
test_files: []
|