logster 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5e9decebe1a9a3e0d342200b5ece0d9447fd3bf7e27eb51ef34b26e1a1bbb9
-  data.tar.gz: 1a07e2040921e6dad703a03d43a1e8eb6394a24061237b6515b53e0a82cc0b99
+  metadata.gz: 1b8b547dcfd6fb1cc5d425ad2b7399eff92e9531d3d9bf1f32f83d51934382ec
+  data.tar.gz: 282e506df1fe66e9ba573c52c5af6321527679e7a3ec35c3c3c5d5e283f32590
 SHA512:
-  metadata.gz: 7f4d6c0dc19e829e25a0e5b7df21661137a60a43b5e646f7160bfae4f0e58709a46890d49ad11576956af992dd6122a69dc67bf15305a5826df9c71439e3cbe8
-  data.tar.gz: 1ff7baa54f12266289573a6481860f1e193b3695d4287086e35416a1a630068a5d24cd7a232e1d2f4705fa892abc3a7d580994df27318a836ea2f8b6556f5559
+  metadata.gz: 011d87d3746ad752d68d04c526b3ac6181ca5f1c4342f37d2c049f541cf641d52fcd3e5c8a0e9085949a7de11b46cd001d2a12fd79d1be0cbce204b1bb90f6e7
+  data.tar.gz: ed50cb5333f2b85f698cebb9e2bc380247421b21e384c886c20889d8c90839222deed925908cc8f1888abaf6303f487fdeac1e13b365967ff2e74b4b5fe28014

data/.gitignore

@@ -1,18 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.byebug_history
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.byebug_history

data/.travis.yml

@@ -1,15 +1,15 @@
-language: ruby
-
-matrix:
-  fast_finish: true
-
-rvm:
-  - 2.3.4
-
-services:
-  - redis-server
-
-before_install:
-  - gem install bundler
-
-sudo: false
+language: ruby
+
+matrix:
+  fast_finish: true
+
+rvm:
+  - 2.3.4
+
+services:
+  - redis-server
+
+before_install:
+  - gem install bundler
+
+sudo: false

data/CHANGELOG.md

@@ -1,137 +1,140 @@
-# CHANGELOG
-
-- 2018-11-09: Version 1.3.1
-  - Feature: auto scrub invalid messages reported to logger
-
-- 2018-11-09: Version 1.3.0
-  - Feature: upgrade Ember to 3.5.1
-  - Feature: remove inline JS for CSP compliance
-
-- 2018-08-13: Version 1.2.10
-  - Feature: expose chained loggers in Logster::Logger
-
-- 2017-10-27: Version 1.2.8
-  - Fix: `Logster::Middleware::DebugExceptions` is passed a request in Rails 5 instead of the env.
-
-- 2017-01-30: Version 1.2.7
-  - Feature: Add override_level to Logster::Logger allowing for threadsafe logger override
-
-- 2016-10-24: Version 1.2.6
-  - Fix: Check if `Rails.env` is defined when using Logster in a none Rails project.
-
-- 2016-07-11: Version 1.2.5
-  - Fix: Chained `Logster::Logger` logger now receives backtrace as well.
-
-- 2016-05-05: Version 1.2.4
-  - Fix: XSS in log message show if attacker can inject script into ENV
-
-- 2016-05-05: Version 1.2.3
-  - Fix: clear_all now also clears rate limits
-  - Fix: protect against corrupt data in redis during clear
-
-- 2016-03-22: Version 1.2.2
-  - Fix: Conflicting attributes and method name for `Logster::RedisStore#rate_limits`.
-  - Fix: Rate limit checker was tracking limits too early. It should only track when a message has been bumped or saved.
-
-- 2016-03-22: Version 1.2.1
-  - Feature: Add method to retrieve current rate from rate limiters.
-  - Feature: Make `RedisStore#rate_limits` readable.
-  - Feature: Make `RedisRateLimiter#callback` and `RedisRateLimiter#duration` readable.
-
-- 2016-03-18: Version 1.2.0
-  - Fix: Move Redis configuration into RedisStore.
-  - Feature: Allow `RedisStore#redis_prefix` to either be a String or a Proc.
-
-- 2016-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
-  - Use rails logger instead of invoking store
-
-- 2015-08-18: Version 0.9.9
-  - This marks the largest release of Logster to date, it has been in production use for quite a while, hence the version bump.
-  - Feature: automatically group errors in production mode, can be manually controlled via Logster.config.allow_grouping
-  - Feature: automatically track application version, can be manually controlled via Logster.config.application_version
-  - Feature: Font Awesome icons used throughout
-  - Feature: Ember upgrade to 1.13
-  - Feature: you can now "solve" a class of errors, if error has an application_version and backtrace. Once an error is solved it will no longer be reported for the "solved" application_versions
-  - Feature: allow users to delete a single error
-  - UX: use table for env
-  - Feature: display "protected" state of message in list
-  - Feature: use local times as opposed to relative times in time column
-  - UX: use Google Roboto font as opposed to system fonts
-  - UX: remove pointless titles from log table
-  - Feature: If Logster is in a background tab only poll once every 60 seconds (as opposed to 3)
-  - Fix: protect/unprotect redirected to show page
-
-- 2015-06-16: Version 0.8.3
-  - Chained loggers now respect chain ignore
-  - Add hostname and process_id to env on all messages
-
-- 2015-06-10: Version 0.8.2
-  - Add hostname and process_id to env on all messages
-
-- 2015-05-01: Version 0.8.1
-  - Don't crash out logging routine if redis is down or stderr is closed
-
-- 2015-04-16: Version 0.8.0
-  - Improve formatting of /show page
-  - Big version bump cause it is quite stable
-
-- 2015-02-27: Version 0.1.7
-  - Fix invalid request on ?test
-
-- 2014-08-05: Version 0.1.3
-  - Automatically include ignore filter
-
-- 2014-08-13: Version 0.1.6
-  - Simplify install process
-  - Fix crash on 404 in /logs dir
-
-- 2014-08-10: Version 0.1.5
-  - Fix crash in Rails 3
-
-- 2014-08-08: Version 0.1.4
-  - Fix crash in ignore filter
-
-- 2014-07-17: Version 0.1.1
-  - Refactored report method into base_store.rb - will be easier to make a new log store
-  - Add link in UI to clear all (non-protected) logs
-  - Add example of submitting logs from Sidekiq jobs
-  - Show Protect/Share links on all tabs
-  - Render hashes provided via Logster.add_to_env
-
-- 2014-07-04: Version 0.0.12
-  - Feature: Able to share logs, at /logs/show/(hexdigits)
-  - Add protecting logs, so they aren't deleted when old (for use with sharing)
-  - Restructured Redis data model
-
-- 2014-05-24: Version 0.0.10
-  - Correct context for error reporting
-  - Clean up backtraces of reported exceptions
-
-- 2014-05-13: Version 0.0.9
-  - Stray debugger message removed, add window.location logging to js
-
-- 2014-05-13: Version 0.0.8
-  - Fix pacakging binstubs by mistake
-
-- 2014-05-13: Version 0.0.7
-  - Add support for javascript exception logging
-
-- 2014-05-12: Version 0.0.6
-  - Add referer to env
-
-- 2014-05-12: Version 0.0.5
-  - Feature: We now log basic rack environment with the messages
-  - Add your own with Logster.add_to_env(env, key, value)
-
-- 2014-05-07: Version 0.0.4
-  - Feature: Ability to ignore patterns with Logster.store.ignore = [/regex/]
-  - Feature: Store backtraces, allow people to view them in the GUI
-
-- 2014-05-07: Started changelog :)
-  - Report params in env tab
+# CHANGELOG
+
+- 2018-12-25: Version 1.3.2
+  - UX: improve usability on mobile
+
+- 2018-11-09: Version 1.3.1
+  - Feature: auto scrub invalid messages reported to logger
+
+- 2018-11-09: Version 1.3.0
+  - Feature: upgrade Ember to 3.5.1
+  - Feature: remove inline JS for CSP compliance
+
+- 2018-08-13: Version 1.2.10
+  - Feature: expose chained loggers in Logster::Logger
+
+- 2017-10-27: Version 1.2.8
+  - Fix: `Logster::Middleware::DebugExceptions` is passed a request in Rails 5 instead of the env.
+
+- 2017-01-30: Version 1.2.7
+  - Feature: Add override_level to Logster::Logger allowing for threadsafe logger override
+
+- 2016-10-24: Version 1.2.6
+  - Fix: Check if `Rails.env` is defined when using Logster in a none Rails project.
+
+- 2016-07-11: Version 1.2.5
+  - Fix: Chained `Logster::Logger` logger now receives backtrace as well.
+
+- 2016-05-05: Version 1.2.4
+  - Fix: XSS in log message show if attacker can inject script into ENV
+
+- 2016-05-05: Version 1.2.3
+  - Fix: clear_all now also clears rate limits
+  - Fix: protect against corrupt data in redis during clear
+
+- 2016-03-22: Version 1.2.2
+  - Fix: Conflicting attributes and method name for `Logster::RedisStore#rate_limits`.
+  - Fix: Rate limit checker was tracking limits too early. It should only track when a message has been bumped or saved.
+
+- 2016-03-22: Version 1.2.1
+  - Feature: Add method to retrieve current rate from rate limiters.
+  - Feature: Make `RedisStore#rate_limits` readable.
+  - Feature: Make `RedisRateLimiter#callback` and `RedisRateLimiter#duration` readable.
+
+- 2016-03-18: Version 1.2.0
+  - Fix: Move Redis configuration into RedisStore.
+  - Feature: Allow `RedisStore#redis_prefix` to either be a String or a Proc.
+
+- 2016-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
+  - Use rails logger instead of invoking store
+
+- 2015-08-18: Version 0.9.9
+  - This marks the largest release of Logster to date, it has been in production use for quite a while, hence the version bump.
+  - Feature: automatically group errors in production mode, can be manually controlled via Logster.config.allow_grouping
+  - Feature: automatically track application version, can be manually controlled via Logster.config.application_version
+  - Feature: Font Awesome icons used throughout
+  - Feature: Ember upgrade to 1.13
+  - Feature: you can now "solve" a class of errors, if error has an application_version and backtrace. Once an error is solved it will no longer be reported for the "solved" application_versions
+  - Feature: allow users to delete a single error
+  - UX: use table for env
+  - Feature: display "protected" state of message in list
+  - Feature: use local times as opposed to relative times in time column
+  - UX: use Google Roboto font as opposed to system fonts
+  - UX: remove pointless titles from log table
+  - Feature: If Logster is in a background tab only poll once every 60 seconds (as opposed to 3)
+  - Fix: protect/unprotect redirected to show page
+
+- 2015-06-16: Version 0.8.3
+  - Chained loggers now respect chain ignore
+  - Add hostname and process_id to env on all messages
+
+- 2015-06-10: Version 0.8.2
+  - Add hostname and process_id to env on all messages
+
+- 2015-05-01: Version 0.8.1
+  - Don't crash out logging routine if redis is down or stderr is closed
+
+- 2015-04-16: Version 0.8.0
+  - Improve formatting of /show page
+  - Big version bump cause it is quite stable
+
+- 2015-02-27: Version 0.1.7
+  - Fix invalid request on ?test
+
+- 2014-08-05: Version 0.1.3
+  - Automatically include ignore filter
+
+- 2014-08-13: Version 0.1.6
+  - Simplify install process
+  - Fix crash on 404 in /logs dir
+
+- 2014-08-10: Version 0.1.5
+  - Fix crash in Rails 3
+
+- 2014-08-08: Version 0.1.4
+  - Fix crash in ignore filter
+
+- 2014-07-17: Version 0.1.1
+  - Refactored report method into base_store.rb - will be easier to make a new log store
+  - Add link in UI to clear all (non-protected) logs
+  - Add example of submitting logs from Sidekiq jobs
+  - Show Protect/Share links on all tabs
+  - Render hashes provided via Logster.add_to_env
+
+- 2014-07-04: Version 0.0.12
+  - Feature: Able to share logs, at /logs/show/(hexdigits)
+  - Add protecting logs, so they aren't deleted when old (for use with sharing)
+  - Restructured Redis data model
+
+- 2014-05-24: Version 0.0.10
+  - Correct context for error reporting
+  - Clean up backtraces of reported exceptions
+
+- 2014-05-13: Version 0.0.9
+  - Stray debugger message removed, add window.location logging to js
+
+- 2014-05-13: Version 0.0.8
+  - Fix pacakging binstubs by mistake
+
+- 2014-05-13: Version 0.0.7
+  - Add support for javascript exception logging
+
+- 2014-05-12: Version 0.0.6
+  - Add referer to env
+
+- 2014-05-12: Version 0.0.5
+  - Feature: We now log basic rack environment with the messages
+  - Add your own with Logster.add_to_env(env, key, value)
+
+- 2014-05-07: Version 0.0.4
+  - Feature: Ability to ignore patterns with Logster.store.ignore = [/regex/]
+  - Feature: Store backtraces, allow people to view them in the GUI
+
+- 2014-05-07: Started changelog :)
+  - Report params in env tab

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rack-log-viewer.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-log-viewer.gemspec
+gemspec

data/Guardfile

@@ -1,8 +1,8 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :minitest do
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
-end
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2014 Sam Saffron
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2014 Sam Saffron
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,99 +1,99 @@
-![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/website/images/logster-screenshot.png)
-
-Play with a live demo at [logster.info/logs](http://logster.info/logs).
-
-## Installation
-
-Add these lines to your application's Gemfile:
-
-    gem 'redis'
-    gem 'logster'
-
-And then execute:
-
-    $ bundle
-
-Make logster web available add the following to your `routes.rb`:
-
-```
-constraints lambda { |req| req.session["admin"] } do
-  mount Logster::Web => "/logs"
-end
-```
-
-By default, logster will only run in development and production environments.
-
-To run logster in other environments, in `config/application.rb`
-
-```
-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` or `web-console`.
-
-To avoid this error, make sure logster is added behind those conflicting gems in your Gemfile.
-
-### Mount using warden (devise)
-```
-  admin_constraint = lambda do |request|
-    request.env['warden'].authenticate? and request.env['warden'].user.admin?
-  end
-
-  constraints admin_constraint do
-    mount Logster::Web, at: "/logs"
-  end
-```
-
-Out of the box, logster will use the default redis connection, to customise, in `config/application.rb`
-
-```
-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:
-```
-if Rails.env.production?
-    Rails.logger.extend(ActiveSupport::Logger.broadcast(Logster.logger))
-end
-```
-
-## Thanks
-
-Logster UI is built using [Ember.js](http://emberjs.com/)
-
-## Contributing
-
-1. Fork it ( https://github.com/discourse/logster/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Run `cd client-app && npm install`
-4. Run `rake client_dev` to start Sinatra server (port 9292) and Ember server (port 4200). Use Ember server for hot reload for client code.
-5. Once you're done making changes, run `./build_client_app.sh` to make and copy a production build to the assets folder. (Shutting down the rake task will do this step automatically for you)
-6. Commit your changes (`git commit -am 'Add some feature'`)
-7. Push to the branch (`git push origin my-new-feature`)
-8. Create a new Pull Request
+![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/website/images/logster-screenshot.png)
+
+Play with a live demo at [logster.info/logs](http://logster.info/logs).
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    gem 'redis'
+    gem 'logster'
+
+And then execute:
+
+    $ bundle
+
+Make logster web available add the following to your `routes.rb`:
+
+```
+constraints lambda { |req| req.session["admin"] } do
+  mount Logster::Web => "/logs"
+end
+```
+
+By default, logster will only run in development and production environments.
+
+To run logster in other environments, in `config/application.rb`
+
+```
+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` or `web-console`.
+
+To avoid this error, make sure logster is added behind those conflicting gems in your Gemfile.
+
+### Mount using warden (devise)
+```
+  admin_constraint = lambda do |request|
+    request.env['warden'].authenticate? and request.env['warden'].user.admin?
+  end
+
+  constraints admin_constraint do
+    mount Logster::Web, at: "/logs"
+  end
+```
+
+Out of the box, logster will use the default redis connection, to customise, in `config/application.rb`
+
+```
+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:
+```
+if Rails.env.production?
+    Rails.logger.extend(ActiveSupport::Logger.broadcast(Logster.logger))
+end
+```
+
+## Thanks
+
+Logster UI is built using [Ember.js](http://emberjs.com/)
+
+## Contributing
+
+1. Fork it ( https://github.com/discourse/logster/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run `cd client-app && npm install`
+4. Run `rake client_dev` to start Sinatra server (port 9292) and Ember server (port 4200). Use Ember server for hot reload for client code.
+5. Once you're done making changes, run `./build_client_app.sh` to make and copy a production build to the assets folder. (Shutting down the rake task will do this step automatically for you)
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new Pull Request