logster 0.8.4.6.pre → 0.8.4.7.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74e3d5019a8150cc107b5917c2466c6029bdc914
-  data.tar.gz: 0038b79111731c1b7462390775522ebad7419d66
+  metadata.gz: 9d7bd5fb673384e34d116c5dd45509c905c9a8bc
+  data.tar.gz: 43cdc554929b6de1d025f8097fdeff9f5a6ebbdb
 SHA512:
-  metadata.gz: 8a054e3703b0d7809ef4b702f2b022bd11aa93dbbbac5c081f146f677ee1470c67d85423d564b67b53ab1ee894da085eacd0bea91a1ac13f1aa2b12b89653692
-  data.tar.gz: 2d4e310d6d31dcfd113c6937cc3ab7b04822c46686ee1e0d7a2f70a9c2f9553d04e28a98068365ae4263122d769063f023e765b856a11f4946758ed39e3d7523
+  metadata.gz: d699901b60a63521435e5c2b867dde20589b92bf417c0f50cb4d38dc04b3cdd1a9fa2e3c8d36d894026814007a279ad5f62f2e819f3ab757a417042832102c72
+  data.tar.gz: b5a99a9d5602597aa38dd4182c18bfaaa6b0b1c040940cf9f8e9f90aefe254b42d5b613065309e76fe2c393675a6e69aec3b1ae0d3d614f466230e0927d7ad8d

data/assets/javascript/app.js

@@ -64,9 +64,8 @@ function buildArrayString(array) {
   return '[' + buffer.join(', ') + ']';
 }
 
-function buildHashString(hash, indent) {
+function buildHashString(hash, recurse) {
   if (!hash) return '';
-  if (!indent) indent = "";
 
   var buffer = [],
       hashes = [];
@@ -74,23 +73,24 @@ function buildHashString(hash, indent) {
     if (v === null) {
       buffer.push('null');
     } else if (Object.prototype.toString.call(v) === '[object Array]') {
-      buffer.push(k + ": " + buildArrayString(v));
+      buffer.push("<tr><td>" + escape(k) + "</td><td>" + escape(buildArrayString(v)) + "</td></tr>");
     } else if (typeof v === "object") {
       hashes.push(k);
     } else {
-      buffer.push(k + ": " + v);
+      buffer.push("<tr><td>" + k + "</td><td>" + v + "</td></tr>");
     }
   });
 
   if (_.size(hashes) > 0) {
     _.each(hashes, function(k1) {
       var v = hash[k1];
-      buffer.push("");
-      buffer.push(k1 + ":");
-      buffer.push(buildHashString(v, indent + "  "));
+      buffer.push("<tr><td></td><td><table>");
+      buffer.push("<td>" + k1 + "</td><td>" + buildHashString(v, true) + "</td>");
+      buffer.push("</table></td></tr>");
     });
   }
-  return indent + buffer.join("\n" + indent);
+  var className = recurse?"": "env-table";
+  return "<table class='"+ className +"'>" + buffer.join("\n") + "</table>";
 }
 
 App.Message = Ember.Object.extend({
@@ -101,6 +101,10 @@ App.Message = Ember.Object.extend({
     this.set("expanded", true);
   },
 
+  solve: function() {
+    return App.ajax("/solve/" + this.get('key'), { type: "PUT" });
+  },
+
   "delete": function() {
     return App.ajax("/message/" + this.get('key'), { type: "DELETE" });
   },
@@ -144,10 +148,16 @@ App.Message = Ember.Object.extend({
     this.set('count', other.get('count'));
   },
 
-  envDebug: function() {
+  canSolve: function() {
+    var backtrace = this.get("backtrace");
+    return this.get("env.application_version") && backtrace && (backtrace.length > 0);
+  }.property(),
+
+  envTable: function() {
     return buildHashString(this.get('env'));
   }.property("env"),
 
+
   rowClass: function() {
     switch (this.get("severity")) {
       case 0:
@@ -185,6 +195,13 @@ App.MessageCollection = Em.Object.extend({
   currentMessage: null,
   total: 0,
 
+  solve: function(message) {
+    var self = this;
+    message.solve().then(function(){
+      self.reload();
+    });
+  },
+
   "delete": function(message){
     var messages = this.get('messages');
     var idx = messages.indexOf(message);
@@ -319,6 +336,23 @@ App.MessageCollection = Em.Object.extend({
 });
 
 
+(function(){
+  $.each(["","webkit","ms","moz","ms"], function(index, prefix){
+      var check = prefix + (prefix === "" ? "hidden" : "Hidden");
+      if(document[check] !== undefined ){
+        hiddenProperty = check;
+      }
+    });
+
+  App.isHidden = function() {
+    if (hiddenProperty !== undefined){
+      return document[hiddenProperty];
+    } else {
+      return !document.hasFocus;
+    }
+  };
+})();
+
 App.IndexRoute = Em.Route.extend({
   model: function(){
     // TODO from preload json?
@@ -338,8 +372,13 @@ App.IndexRoute = Em.Route.extend({
     controller.set("initialized", true);
     model.reload();
 
+    var times = 0;
     this.refreshInterval = setInterval(function(){
-      model.loadMore();
+      times += 1;
+      // refresh a lot less aggressively in background
+      if (!App.isHidden() || (times % 20 === 0)) {
+        model.loadMore();
+      }
     }, 3000);
   },
 
@@ -398,6 +437,11 @@ App.IndexController = Em.Controller.extend({
     removeMessage: function(msg) {
       var messages = this.get('model');
       messages.delete(msg);
+    },
+
+    solveMessage: function(msg) {
+      var messages = this.get('model');
+      messages.solve(msg);
     }
   },
 
@@ -689,6 +733,9 @@ App.MessageInfoComponent = Ember.Component.extend({
     },
     "remove": function(){
       this.sendAction("removeMessage", this.get('currentMessage'));
+    },
+    solve: function() {
+      this.sendAction("solveMessage", this.get('currentMessage'));
     }
   }
 });

data/assets/javascript/components/message-info.hbs

@@ -17,11 +17,11 @@
         <pre>{{currentMessage.backtrace}}</pre>
     {{/tab-contents}}
     {{#if currentMessage.env}}
-      {{#tab-contents name="env" hint="show environment" currentMessage=currentMessage}}
+      {{#tab-contents className="env" name="env" hint="show environment" currentMessage=currentMessage}}
           {{#if showTitle}}
           <h3>Env</h3>
           {{/if}}
-          <pre>{{currentMessage.envDebug}}</pre>
+          {{{currentMessage.envTable}}}
       {{/tab-contents}}
     {{/if}}
   {{/tabbed-section}}
@@ -30,6 +30,10 @@
     <div class='message-actions'>
 
     {{#unless currentMessage.protected}}
+      {{#if currentMessage.canSolve}}
+        <button {{action 'solve'}} class="solve btn danger"><i class='fa fa-check-square-o'></i>Solve</button>
+      {{/if}}
+
       <button {{action 'remove'}} class="delete btn danger"><i class='fa fa-trash-o'></i>Delete</button>
 
       <button {{action 'protect'}} class="protect btn"><i class='fa fa-lock'></i>Protect</button>

data/assets/javascript/templates/index.hbs

@@ -23,7 +23,7 @@
 </div>
 {{panel-resizer}}
 <div id="bottom-panel">
-  {{message-info currentMessage=currentMessage removeMessage="removeMessage"}}
+  {{message-info currentMessage=currentMessage removeMessage="removeMessage" solveMessage="solveMessage"}}
 
   <div class="action-panel">
     <label class="debug">

data/assets/stylesheets/app.css

@@ -7,6 +7,20 @@ pre {
    font-family: 'Roboto Mono', Consolas, Monaco, Ubuntu Mono, monospace;
 }
 
+table.env-table tbody tr td {
+  border-top: none;
+  line-height: 18px;
+  vertical-align: top;
+}
+
+table.env-table, table.env-table table {
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+
+table.env-table td {
+  padding-right: 5px;
+}
 
 tbody tr {
   width: 98%;

data/lib/logster/base_store.rb

@@ -59,6 +59,12 @@ module Logster
       not_implemented
     end
 
+    # Solve a particular message, causing all old messages with matching version and backtrace
+    # to be deleted (report should delete any solved messages when called)
+    def solve(message_key)
+      not_implemented
+    end
+
     def report(severity, progname, msg, opts = {})
       return if (!msg || (String === msg && msg.empty?)) && skip_empty
       return if level && severity < level

data/lib/logster/configuration.rb

@@ -1,6 +1,6 @@
 module Logster
   class Configuration
-    attr_accessor :current_context, :allow_grouping, :environments
+    attr_accessor :current_context, :allow_grouping, :environments, :application_version
     attr_writer :subdirectory
 
     def initialize

data/lib/logster/message.rb

@@ -17,6 +17,7 @@ module Logster
       HTTP_X_REAL_IP
       hostname
       process_id
+      application_version
     }
 
     attr_accessor :timestamp, :severity, :progname, :message, :key, :backtrace, :count, :env, :protected, :first_timestamp
@@ -77,9 +78,16 @@ module Logster
 
     def populate_from_env(env)
       env ||= {}
-      env["hostname"] ||= self.class.hostname
-      env["process_id"] ||= Process.pid
-      @env = Message.populate_from_env(env)
+      @env = Message.populate_from_env(self.class.default_env.merge env)
+    end
+
+    def self.default_env
+      env = {
+        "hostname" => hostname,
+        "process_id" => Process.pid
+      }
+      env["application_version"] = Logster.config.application_version if Logster.config.application_version
+      env
     end
 
     # in its own method so it can be overridden
@@ -92,6 +100,14 @@ module Logster
       Digest::SHA1.hexdigest JSON.fast_generate grouping_hash
     end
 
+    # todo - memoize?
+    def solved_key
+      if  (version=env["application_version"]) &&
+          (backtrace && backtrace.length > 0)
+        Digest::SHA1.hexdigest "#{version} #{backtrace}"
+      end
+    end
+
     def is_similar?(other)
       self.grouping_key == other.grouping_key
     end
@@ -111,7 +127,7 @@ module Logster
             # Not a web request
             return env
           end
-          scrubbed = {}
+          scrubbed = default_env
           request = Rack::Request.new(env)
           params = {}
           request.params.each do |k,v|

data/lib/logster/middleware/viewer.rb

@@ -75,6 +75,18 @@ module Logster
               end
             end
 
+          elsif resource =~ /\/solve\/([0-9a-f]+)$/
+            key = $1
+
+            message = Logster.store.get(key)
+            unless message
+              return [404, {}, ["Message not found"]]
+            end
+
+            Logster.store.solve(key)
+
+            return [301, {"Location" => "#{@logs_path}"}, []]
+
           elsif resource =~ /\/clear$/
             if env[REQUEST_METHOD] != "POST"
               return [405, {}, ["GET not allowed for /clear"]]

data/lib/logster/rails/railtie.rb

@@ -35,6 +35,13 @@ module Logster::Rails
 
       app.middleware.delete ActionDispatch::DebugExceptions
       app.config.colorize_logging = false
+
+      unless Logster.config.application_version
+        git_version = `cd #{Rails.root} && git rev-parse --short HEAD 2> /dev/null`
+        if git_version.present?
+          Logster.config.application_version = git_version.strip
+        end
+      end
     end
   end
 

data/lib/logster/redis_store.rb

@@ -14,6 +14,10 @@ module Logster
 
 
     def save(message)
+      if solved=message.solved_key
+        return true if @redis.hget(solved_key, solved)
+      end
+
       @redis.multi do
         @redis.hset(grouping_key, message.grouping_key, message.key)
         @redis.rpush(list_key, message.key)
@@ -55,6 +59,14 @@ module Logster
       @redis.llen(list_key)
     end
 
+    def solve(message_key)
+      if (message = get(message_key)) && (key = message.solved_key)
+        # add a time so we can expire it
+        @redis.hset(solved_key, key, Time.now.to_f.to_i)
+      end
+      clear_solved
+    end
+
     def latest(opts={})
       limit = opts[:limit] || 50
       severity = opts[:severity]
@@ -102,6 +114,7 @@ module Logster
     end
 
     def clear
+      @redis.del(solved_key)
       @redis.del(list_key)
       keys = @redis.smembers(protected_key) || []
       if keys.empty?
@@ -132,6 +145,7 @@ module Logster
       @redis.del(protected_key)
       @redis.del(hash_key)
       @redis.del(grouping_key)
+      @redis.del(solved_key)
     end
 
     def get(message_key)
@@ -157,8 +171,29 @@ module Logster
       end
     end
 
+    def solved
+      @redis.hkeys(solved_key) || []
+    end
+
     protected
 
+    def clear_solved(count = nil)
+
+      ignores = Set.new(@redis.hkeys(solved_key) || [])
+
+      if ignores.length > 0
+        start = count ? 0 - count : 0
+        message_keys = @redis.lrange(list_key, start, -1 ) || []
+
+        @redis.hmget(hash_key, message_keys).each do |json|
+          message =  Message.from_json(json)
+          if ignores.include? message.solved_key
+            delete message
+          end
+        end
+      end
+    end
+
     def trim
       if @redis.llen(list_key) > max_backlog
         removed_keys = []
@@ -261,6 +296,9 @@ module Logster
 
     end
 
+    def solved_key
+      @solved_key ||= "__LOGSTER__SOLVED_MAP"
+    end
 
     def list_key
       @list_key ||= "__LOGSTER__LATEST"

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.8.4.6.pre"
+  VERSION = "0.8.4.7.pre"
 end

data/test/logster/test_message.rb

@@ -18,7 +18,17 @@ class TestMessage < MiniTest::Test
 
     assert_equal(20, msg1.timestamp)
     assert_equal(10, msg1.first_timestamp)
+  end
+
+  def test_adds_application_version
+    Logster.config.application_version = "abc"
+    msg = Logster::Message.new(0, '', 'test', 10)
+    msg.populate_from_env({})
+
+    assert_equal("abc", msg.env["application_version"])
 
+  ensure
+    Logster.config.application_version = nil
   end
 
 end

data/test/logster/test_redis_store.rb

@@ -235,6 +235,38 @@ class TestRedisStore < Minitest::Test
     assert_equal(1, @store.latest.count)
   end
 
+  def test_solve
+    Logster.config.application_version = "abc"
+
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1")
+    m = @store.report(Logger::WARN, "application", "test error2", backtrace: "backtrace1")
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace2")
+
+    assert_equal(3, @store.latest.count)
+
+    @store.solve(m.key)
+
+    assert_equal(1, @store.latest.count)
+
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1")
+    @store.report(Logger::WARN, "application", "test error1", backtrace: "backtrace1", env: { "application_version" => "xyz"})
+
+    assert_equal(2, @store.latest.count)
+
+  ensure
+    Logster.config.application_version = nil
+  end
+
+  def test_clears_solved
+    m = @store.report(Logger::WARN, "application", "test error2", backtrace: "backtrace1", env: {"application_version" => "abc"})
+    @store.solve(m.key)
+
+    assert_equal(1, @store.solved.length)
+
+    @store.clear
+    assert_equal(0, @store.solved.length)
+  end
+
   def test_env
     env = Rack::MockRequest.env_for("/test").merge({
       "HTTP_HOST" => "www.site.com",
@@ -257,7 +289,13 @@ class TestRedisStore < Minitest::Test
     end
 
     @store.report(Logger::INFO, "test", "test",  env: env)
-    assert_equal(orig, @store.latest.last.env)
+
+    env = @store.latest.last.env
+
+    env.delete "hostname"
+    env.delete "process_id"
+
+    assert_equal(orig, env)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.8.4.6.pre
+  version: 0.8.4.7.pre
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler