system-metrics 0.2.2 → 0.2.3

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.
Files changed (3) hide show
  1. data/README.rdoc +11 -3
  2. data/lib/system_metrics/version.rb +1 -1
  3. metadata +31 -1
@@ -2,6 +2,8 @@
2
2
 
3
3
  System Metrics is a Rails 3 Engine that provides a clean web interface to the performance metrics instrumented with `ActiveSupport::Notifications`. It'll collect and display the notifications baked into Rails and any additional custom ones you add using `ActiveSupport::Notification#instrument`.
4
4
 
5
+ System Metrics is not intended to be a replacement for performance monitoring solutions such as {New Relic}[http://newrelic.com/]. However, it is especially handy for quickly identifying performance problems in a development environment. It's also a great alternative for private networks disconnected from the Internet.
6
+
5
7
  = Installation
6
8
 
7
9
  To install the System Metrics gem in your Rails 3 app, add the following line to your Gemfile
@@ -17,6 +19,8 @@ Lastly, the public assets from the System Metrics gem need to be moved into your
17
19
 
18
20
  rails generate system_metrics:install
19
21
 
22
+ After the above setup, you can reach the System Metrics interface at /system/metrics within your app.
23
+
20
24
  = Setup
21
25
 
22
26
  Out of the box, System Metrics collects the more interesting performance notifications built into Rails with no configuration. However, there are a few options available to fine tune it and add your own instrumentations.
@@ -100,7 +104,7 @@ Since SystemMetrics is not recommended for production use, the lack of authoriza
100
104
  end
101
105
 
102
106
  def authorize
103
- # Do you authorization thing
107
+ # Do your authorization thing
104
108
  end
105
109
  end
106
110
 
@@ -108,11 +112,15 @@ Since SystemMetrics is not recommended for production use, the lack of authoriza
108
112
 
109
113
  = Caveats
110
114
 
111
- I would not currently recommend using SystemMetrics in a production environment. There are far too many synchronous database inserts of the collected metrics to confidently say that it wouldn't impact your application's performance.
115
+ I would not currently recommend using SystemMetrics in a production environment. There are far too many database inserts of the collected metrics to confidently say that it wouldn't impact your application's performance.
116
+
117
+ = Contributing
118
+
119
+ System Metrics is a young project and there's still plenty to do. If you're interested in helping out, please take a look at the open issues and follow the steps described for {contributing to a project}[http://help.github.com/fork-a-repo/]. Your help is greatly appreciated.
112
120
 
113
121
  = Credits
114
122
 
115
- The idea behind System Metrics and the inspiration for a good portion of its code comes from José Valim's Rails Metrics project. The inspiration for the user interface comes from Greg Bell's ActiveAdmin project.
123
+ The idea behind System Metrics and the inspiration for a good portion of its code comes from José Valim's Rails Metrics project.
116
124
 
117
125
  = License
118
126
 
@@ -1,3 +1,3 @@
1
1
  module SystemMetrics
2
- VERSION = "0.2.2"
2
+ VERSION = "0.2.3"
3
3
  end
metadata CHANGED
@@ -1,8 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: system-metrics
3
3
  version: !ruby/object:Gem::Version
4
+ hash: 17
4
5
  prerelease:
5
- version: 0.2.2
6
+ segments:
7
+ - 0
8
+ - 2
9
+ - 3
10
+ version: 0.2.3
6
11
  platform: ruby
7
12
  authors:
8
13
  - Jeff Kunkle
@@ -21,6 +26,11 @@ dependencies:
21
26
  requirements:
22
27
  - - ~>
23
28
  - !ruby/object:Gem::Version
29
+ hash: 7
30
+ segments:
31
+ - 3
32
+ - 0
33
+ - 0
24
34
  version: 3.0.0
25
35
  type: :runtime
26
36
  version_requirements: *id001
@@ -32,6 +42,11 @@ dependencies:
32
42
  requirements:
33
43
  - - "="
34
44
  - !ruby/object:Gem::Version
45
+ hash: 27
46
+ segments:
47
+ - 2
48
+ - 5
49
+ - 0
35
50
  version: 2.5.0
36
51
  type: :development
37
52
  version_requirements: *id002
@@ -43,6 +58,11 @@ dependencies:
43
58
  requirements:
44
59
  - - "="
45
60
  - !ruby/object:Gem::Version
61
+ hash: 29
62
+ segments:
63
+ - 1
64
+ - 3
65
+ - 3
46
66
  version: 1.3.3
47
67
  type: :development
48
68
  version_requirements: *id003
@@ -54,6 +74,10 @@ dependencies:
54
74
  requirements:
55
75
  - - "="
56
76
  - !ruby/object:Gem::Version
77
+ hash: 23
78
+ segments:
79
+ - 3
80
+ - 8
57
81
  version: "3.8"
58
82
  type: :development
59
83
  version_requirements: *id004
@@ -147,12 +171,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
147
171
  requirements:
148
172
  - - ">="
149
173
  - !ruby/object:Gem::Version
174
+ hash: 3
175
+ segments:
176
+ - 0
150
177
  version: "0"
151
178
  required_rubygems_version: !ruby/object:Gem::Requirement
152
179
  none: false
153
180
  requirements:
154
181
  - - ">="
155
182
  - !ruby/object:Gem::Version
183
+ hash: 3
184
+ segments:
185
+ - 0
156
186
  version: "0"
157
187
  requirements: []
158
188