README.md in logster-1.0.1 vs README.md in logster-1.1.1
- old
+ new
@@ -1,12 +1,12 @@
-![logster logo](https://raw.githubusercontent.com/discourse/logster/master/assets/images/logo-logster-cropped-small.png)
+![logster logo](https://raw.githubusercontent.com/discourse/logster/master/website/images/logo-logster-cropped-small.png)
Logster is an embedded Ruby "exception reporting service" admins can view on live websites, at `http://example.com/logs`
## Interface
-![Screenshot](https://raw.githubusercontent.com/discourse/logster/master/assets/images/logster-screenshot.png)
+![Screenshot](https://raw.githubusercontent.com/discourse/logster/master/website/images/logster-screenshot.png)
Play with a live demo at [logster.info/logs](http://logster.info/logs).
## Installation
@@ -33,10 +33,27 @@
```
Logster.set_environments([:development, :staging, :production])
```
+### Tracking Error Rate
+Logster allows you to register a callback when the rate of errors has exceeded
+a given limit.
+
+Tracking buckets available are one minute and an hour.
+
+Example:
+```
+Logster.register_rate_limit_per_minute(Logger::WARN, 60) do |rate|
+ puts "O no! The error rate is now #{rate} errors/min"
+end
+
+Logster.register_rate_limit_per_hour([Logger::WARN, Logger::ERROR, Logger::FATAL], 60) do |rate|
+ puts "O no! The error rate is now #{rate} errors/hour"
+end
+```
+
### Note
If you are seeing the error `No such middleware to insert before: ActionDispatch::DebugExceptions` after installing logster,
then you are using a conflicting gem like `better_errors`.
To avoid this error, make sure logster is added behind those conflicting gems in your Gemfile.
@@ -57,11 +74,11 @@
```
Logster.store = Logster::RedisStore.new(redis_connection)
```
### Heroku Deployment
-In case you may be using the `rails_12factor` gem in a production deployment on Heroku, the standard `Rails.logger` will not cooperate properly with Logster. Extend Rails.logger in your `config/application.rb` or `config/initializers/logster.rb` with:
+In case you may be using the `rails_12factor` gem in a production deployment on Heroku, the standard `Rails.logger` will not cooperate properly with Logster. Extend Rails.logger in your `config/application.rb` or `config/initializers/logster.rb` with:
```
if Rails.env.production?
Rails.logger.extend(ActiveSupport::Logger.broadcast(Logster.logger))
end
```
@@ -77,9 +94,12 @@
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
# CHANGELOG
+
+- 2015-02-11: Version 1.1.1
+ - Feature: Error rate can now be tracked in one minute and one hour buckets.
- 2015-11-27: Version 1.0.1
- New assets and logster logo
- Added favicon
- Added title