system-metrics 0.2.2 → 0.2.3

data/README.rdoc

@@ -2,6 +2,8 @@
 
 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`.
 
+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.
+
 = Installation
 
 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
 
     rails generate system_metrics:install
 
+After the above setup, you can reach the System Metrics interface at /system/metrics within your app.
+
 = Setup
 
 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
       end
       
       def authorize
-        # Do you authorization thing
+        # Do your authorization thing
       end
     end
 
@@ -108,11 +112,15 @@ Since SystemMetrics is not recommended for production use, the lack of authoriza
 
 = Caveats
 
-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.
+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.
+
+= Contributing
+
+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.
 
 = Credits
 
-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.
+The idea behind System Metrics and the inspiration for a good portion of its code comes from José Valim's Rails Metrics project.
 
 = License
 

data/lib/system_metrics/version.rb

@@ -1,3 +1,3 @@
 module SystemMetrics
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: system-metrics
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: 
-  version: 0.2.2
+  segments: 
+  - 0
+  - 2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jeff Kunkle
@@ -21,6 +26,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
   type: :runtime
   version_requirements: *id001
@@ -32,6 +42,11 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
         version: 2.5.0
   type: :development
   version_requirements: *id002
@@ -43,6 +58,11 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
         version: 1.3.3
   type: :development
   version_requirements: *id003
@@ -54,6 +74,10 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 3
+        - 8
         version: "3.8"
   type: :development
   version_requirements: *id004
@@ -147,12 +171,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []