logster 0.8.4.8.pre → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97dfd5d5c1a3b852d2e795946477ebacac564a69
-  data.tar.gz: ca14f6b9facad0859f6597340fdd9aaa88b108b4
+  metadata.gz: 1b6667903d7ea941ef28292bc3e3344e399e1b35
+  data.tar.gz: 024bdf71269ded5bfe341455d5451d0357631796
 SHA512:
-  metadata.gz: 88eb64ef943e78d291d697ffc0eba5ede288b7b16112d02cfb7095c5b3d0eb6f3fc7a1adc2ff1ea50db47799be8ef97065192d69630e19c1fd1d3987872ef34b
-  data.tar.gz: 9f16529049cd7a374722a3d94d9c3037201dc69e16692b6be861fe460aa2f15bc57bf5b6e3e23cf4528f34d1014d1ad80450e89836a4b712a5360984a2d2faf8
+  metadata.gz: 08fae884b5a23abd1291f42e4d05e1ceecdbab9a5d0ab5049c3a4ca88ee18488497f3be6fe7f26bae672f66b1fa1eb94d35dd065107105c08f1305e379c03aab
+  data.tar.gz: e0224e2901ff506330d5fe547ae8c2206ceccc52e1d9a15ee1c593368cfc36fc7b7ac6892747bb83dc9a938fa9b2c6e3d03d107202f03f7cb604649c89b8e53c

data/README.md

@@ -1,10 +1,12 @@
-# Logster
+![logster logo](https://raw.githubusercontent.com/discourse/logster/master/assets/images/logster-logo.png)
 
-A web log viewer and logging framework for Rack applications
+Logster is an embedded Ruby "exception reporting service" admins can view on live websites, at `http://example.com/logs`
 
-## [Live Demo](http://logster.info/logs)
+## Interface
 
-![logster](http://i.imgur.com/cvfcQpv.png)
+![Screenshot](https://raw.githubusercontent.com/discourse/logster/master/assets/images/logster-screenshot.png)
+
+Play with a live demo at [logster.info/logs](http://logster.info/logs).
 
 ## Installation
 
@@ -34,13 +36,12 @@ Logster.set_environments([:development, :staging, :production])
 ```
 
 ### Note
-If you are seeing error
-'No such middleware to insert before: ActionDispatch::DebugExceptions' after installing logster,
-then you are using a conflicting gem like better_errors.
+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.
 
-### mount using warden (devise)
+### Mount using warden (devise)
 ```
   admin_constraint = lambda do |request|
     request.env['warden'].authenticate? and request.env['warden'].user.admin?
@@ -57,13 +58,6 @@ Out of the box, logster will use the default redis connection, to customise, in
 Logster.store = Logster::RedisStore.new(redis_connection)
 ```
 
-## Usage
-
-The concept is to have an embedded "exception reporting service" admins can view on live sites.
-
-Logs will be visible by default at `http://sitename.com/logs`
-
-
 ## Thanks
 
 Logster UI is built using [Ember.js](http://emberjs.com/)
@@ -78,53 +72,87 @@ Logster UI is built using [Ember.js](http://emberjs.com/)
 
 # CHANGELOG
 
-- 2014-05-07: Started changelog :)
-- 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-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-12: Version 0.0.6
-  - Add referer to env
-- 2014-05-13: Version 0.0.7
-  - Add support for javascript exception logging
-- 2014-05-13: Version 0.0.8
-  - Fix pacakging binstubs by mistake
-- 2014-05-13: Version 0.0.9
-  - Stray debugger message removed, add window.location logging to js
-- 2014-05-24: Version 0.0.10
-  - Correct context for error reporting
-  - Clean up backtraces of reported exceptions
-  - Report params in env tab
-- 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
+- 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-08-05: Version 0.1.3
-  - Automatically include ignore filter
-- 2014-08-08: Version 0.1.4
-  - Fix crash in ignore filter
-- 2014-08-10: Version 0.1.5
-  - Fix crash in Rails 3
-- 2014-08-13: Version 0.1.6
-  - Simplify install process
-  - Fix crash on 404 in /logs dir
-- 2015-02-27: Version 0.1.7
-  - Fix invalid request on ?test
-- 2015-04-16: Version 0.8.0
-  - Improve formatting of /show page
-  - Big version bump cause it is quite stable
-- 2015-05-01: Version 0.8.1
-  - Don't crash out logging routine if redis is down or stderr is closed
-- 2015-06-10: Version 0.8.2
-  - Add hostname and process_id to env on all messages
-- 2015-06-16: Version 0.8.3
-  - Chained loggers now respect chain ignore
-  - Add hostname and process_id to env on all messages
+
+- 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/assets/javascript/app.js

@@ -50,6 +50,21 @@ App.Router.map(function() {
   this.route("show", { path: "/show/:id" });
 });
 
+var entityMap = {
+    "&": "&",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': '&quot;',
+    "'": '&#39;',
+    "/": '&#x2F;'
+  };
+
+function escapeHtml(string) {
+  return String(string).replace(/[&<>"'\/]/g, function (s) {
+    return entityMap[s];
+  });
+}
+
 function buildArrayString(array) {
   var buffer = [];
   _.each(array, function(v) {
@@ -58,7 +73,7 @@ function buildArrayString(array) {
     } else if (Object.prototype.toString.call(v) === '[object Array]') {
       buffer.push(buildArrayString(v));
     } else {
-      buffer.push(escape(v.toString()));
+      buffer.push(escapeHtml(v.toString()));
     }
   });
   return '[' + buffer.join(', ') + ']';
@@ -70,10 +85,11 @@ function buildHashString(hash, recurse) {
   var buffer = [],
       hashes = [];
   _.each(hash, function(v, k) {
+
     if (v === null) {
       buffer.push('null');
     } else if (Object.prototype.toString.call(v) === '[object Array]') {
-      buffer.push("<tr><td>" + escape(k) + "</td><td>" + buildArrayString(v) + "</td></tr>");
+      buffer.push("<tr><td>" + escapeHtml(k) + "</td><td>" + buildArrayString(v) + "</td></tr>");
     } else if (typeof v === "object") {
       hashes.push(k);
     } else {

data/lib/logster/message.rb

@@ -101,10 +101,14 @@ module Logster
     end
 
     # todo - memoize?
-    def solved_key
-      if  (version=env["application_version"]) &&
+    def solved_keys
+      if  (versions=env["application_version"]) &&
           (backtrace && backtrace.length > 0)
-        Digest::SHA1.hexdigest "#{version} #{backtrace}"
+        versions = [versions] if String === versions
+
+        versions.map do |version|
+          Digest::SHA1.hexdigest "#{version} #{backtrace}"
+        end
       end
     end
 

data/lib/logster/redis_store.rb

@@ -14,8 +14,10 @@ module Logster
 
 
     def save(message)
-      if solved=message.solved_key
-        return true if @redis.hget(solved_key, solved)
+      if keys=message.solved_keys
+        keys.each do |solved|
+          return true if @redis.hget(solved_key, solved)
+        end
       end
 
       @redis.multi do
@@ -60,9 +62,11 @@ module Logster
     end
 
     def solve(message_key)
-      if (message = get(message_key)) && (key = message.solved_key)
+      if (message = get(message_key)) && (keys = message.solved_keys)
         # add a time so we can expire it
-        @redis.hset(solved_key, key, Time.now.to_f.to_i)
+        keys.each do |s_key|
+          @redis.hset(solved_key, s_key, Time.now.to_f.to_i)
+        end
       end
       clear_solved
     end
@@ -187,7 +191,7 @@ module Logster
 
         @redis.hmget(hash_key, message_keys).each do |json|
           message =  Message.from_json(json)
-          if ignores.include? message.solved_key
+          unless (ignores & message.solved_keys).empty?
             delete message
           end
         end

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.8.4.8.pre"
+  VERSION = "0.9.9"
 end

data/test/fake_data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'redis'
+gem 'logster', path: '../../'

data/test/fake_data/generate.rb

@@ -0,0 +1,10 @@
+require 'redis'
+require 'logster'
+
+Logster.config.allow_grouping = true
+Logster.config.application_version = "ABC123"
+Logster.store = Logster::RedisStore.new
+
+10.times do
+  Logster.store.report(Logger::WARN, "application", "test warning", backtrace: "method1\nmethod2", env: {something: ["hello world", "hello places"], another: {thing: "something else"}})
+end

data/test/logster/test_redis_store.rb

@@ -257,6 +257,24 @@ class TestRedisStore < Minitest::Test
     Logster.config.application_version = nil
   end
 
+  def test_solve_grouped
+    Logster.config.allow_grouping = true
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1", env: { "application_version" => "xyz"})
+    m = @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1", env: { "application_version" => "efg"})
+
+    assert_equal(1, @store.latest.count)
+
+    @store.solve(m.key)
+
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1", env: { "application_version" => "xyz"})
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1", env: { "application_version" => "efg"})
+
+    assert_equal(0, @store.latest.count)
+
+  ensure
+    Logster.config.allow_grouping = false
+  end
+
   def test_clears_solved
     m = @store.report(Logger::WARN, "application", "test error2", backtrace: "backtrace1", env: {"application_version" => "abc"})
     @store.solve(m.key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.8.4.8.pre
+  version: 0.9.9
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,11 @@ files:
 - assets/fonts/fontawesome-webfont.ttf
 - assets/fonts/fontawesome-webfont.woff
 - assets/fonts/fontawesome-webfont.woff2
+- assets/images/logster-apple-touch.png
+- assets/images/logster-favicon.png
+- assets/images/logster-logo.png
+- assets/images/logster-logo.psd
+- assets/images/logster-screenshot.png
 - assets/javascript/app.js
 - assets/javascript/components/message-info.hbs
 - assets/javascript/components/message-row.hbs
@@ -148,6 +153,8 @@ files:
 - lib/logster/web.rb
 - logster.gemspec
 - test/examples/test_sidekiq_reporter_example.rb
+- test/fake_data/Gemfile
+- test/fake_data/generate.rb
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_base_store.rb
@@ -172,9 +179,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -183,6 +190,8 @@ specification_version: 4
 summary: UI for viewing logs in Rack
 test_files:
 - test/examples/test_sidekiq_reporter_example.rb
+- test/fake_data/Gemfile
+- test/fake_data/generate.rb
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_base_store.rb