logster 0.8.3 → 0.8.4.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd434bdaf7b3450494fbb5bedbd054c787f5380f
-  data.tar.gz: 80d5efd8cfe47417ef1f8f10166244ec302be26f
+  metadata.gz: 357588b2742ffeef436fe0367522604fccf12668
+  data.tar.gz: 694af6857f570a5ba4a7ceb670407a9a296f29f2
 SHA512:
-  metadata.gz: e020fbe0569c7d982b7de1086eb54c0bf5be41e14a9de8bd045b7ce5ee4ead50c294754380fbf153d2deac1894d81e3c7d32cc207372c5846ea498af206460cb
-  data.tar.gz: 403102d56cc8975d7df6a7a6e189084c89e49bc1447ea45d8b51dc0db407ea189c0114933d9bfa3ea8d4bf82760fa60cce4c0f2b1add3b4b962f062c57c315bb
+  metadata.gz: 14d5ff717da5d8b4c22759846ec5ec71e16a848844762f5417e1769b29de629dfe972c38631b8dad2e31ca357ada9dea387ce63e18c7983027a6dc83a6a9c6cf
+  data.tar.gz: 9453d1b7016dcf744e7d6d79e8ef0eb6b9a2b0df97d6f159ac46fcc2747359762e0a3bdfce2318d55b1b3a29b6b9e4dc6b30850777b0d92ac1faac8f39dda101

data/README.md

@@ -25,6 +25,14 @@ constraints lambda { |req| req.session["admin"] } do
 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])
+```
+
 ### Note
 If you are seeing error
 'No such middleware to insert before: ActionDispatch::DebugExceptions' after installing logster,
@@ -62,7 +70,7 @@ Logster UI is built using [Ember.js](http://emberjs.com/)
 
 ## Contributing
 
-1. Fork it ( https://github.com/SamSaffron/logster/fork )
+1. Fork it ( https://github.com/discourse/logster/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/assets/javascript/app.js

@@ -50,6 +50,49 @@ App.Router.map(function() {
   this.route("show", { path: "/show/:id" });
 });
 
+function buildArrayString(array) {
+  var buffer = [];
+  _.each(array, function(v) {
+    if (v === null) {
+      buffer.push('null');
+    } else if (Object.prototype.toString.call(v) === '[object Array]') {
+      buffer.push(buildArrayString(v));
+    } else {
+      buffer.push(v.toString());
+    }
+  });
+  return '[' + buffer.join(', ') + ']';
+}
+
+function buildHashString(hash, indent) {
+  if (!hash) return '';
+  if (!indent) indent = "";
+
+  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(k + ": " + buildArrayString(v));
+    } else if (typeof v === "object") {
+      hashes.push(k);
+    } else {
+      buffer.push(k + ": " + v);
+    }
+  });
+
+  if (_.size(hashes) > 0) {
+    _.each(hashes, function(k1) {
+      var v = hash[k1];
+      buffer.push("");
+      buffer.push(k1 + ":");
+      buffer.push(buildHashString(v, indent + "  "));
+    });
+  }
+  return indent + buffer.join("\n" + indent);
+}
+
 App.Message = Ember.Object.extend({
 
   MAX_LEN: 200,
@@ -67,6 +110,10 @@ App.Message = Ember.Object.extend({
     return App.ajax("/unprotect/" + this.get('key'), { type: "DELETE" });
   },
 
+  showCount: function() {
+    return this.get('count') > 1;
+  }.property('count'),
+
   hasMore: function() {
     var message = this.get("message");
     var expanded = this.get("expanded");
@@ -92,32 +139,13 @@ App.Message = Ember.Object.extend({
     return message;
   }.property("message", "expanded"),
 
-  envDebug: function() {
-    var env = this.get("env");
-    if (env) {
-      var buffer = [],
-          hashes = [];
-      _.each(env, function(v, k) {
-        if (typeof v === "object") {
-          hashes.push(k);
-        } else {
-          buffer.push(k + ": " + v);
-        }
-      });
-
-      if (_.size(hashes) > 0) {
-        _.each(hashes, function(k1) {
-          v1 = env[k1];
-          buffer.push("");
-          buffer.push(k1 + ":");
-          _.each(v1, function(v2, k2) {
-            buffer.push("  " + k2 + ": " + v2);
-          })
-        });
-      }
-      return buffer.join("\n");
-    }
+  updateFromObject: function(other) {
+    // XXX Only updatable property is count right now
+    this.set('count', other.get('count'));
+  },
 
+  envDebug: function() {
+    return buildHashString(this.get('env'));
   }.property("env"),
 
   rowClass: function() {
@@ -154,6 +182,7 @@ App.Message = Ember.Object.extend({
 App.MessageCollection = Em.Object.extend({
 
   messages: Em.A(),
+  currentMessage: null,
   total: 0,
 
   load: function(opts) {
@@ -190,6 +219,18 @@ App.MessageCollection = Em.Object.extend({
           if (opts.before) {
             messages.unshiftObjects(newRows);
           } else {
+            newRows.forEach(function(nmsg) {
+              messages.forEach(function(emsg, idx) {
+                if (emsg.key == nmsg.key) {
+                  messages.removeObject(emsg);
+                  if (self.get('currentMessage') === emsg) {
+                    // TODO would updateFromJson() work here?
+                    self.set('currentMessage', nmsg);
+                    nmsg.set('selected', emsg.get('selected'));
+                  }
+                }
+              });
+            });
             messages.addObjects(newRows);
           }
         }
@@ -293,11 +334,18 @@ App.ShowRoute = Em.Route.extend({
 });
 
 App.IndexController = Em.Controller.extend({
+
+  currentMessage: Em.computed.alias('model.currentMessage'),
+
   actions: {
     expandMessage: function(message){
       message.expand();
     },
 
+    selectMessage: function(message) {
+      this.set('currentMessage', message);
+    },
+
     showMoreBefore: function(){
       this.get('model').showMoreBefore();
     },
@@ -468,9 +516,9 @@ App.MessageView = Em.View.extend({
 
   classNameBindings: ["context.rowClass", ":message-row", "context.selected:selected"],
 
-  click: function(){
+  click: function() {
     var old = this.get("controller.currentMessage");
-    if(old){
+    if (old) {
       old.set("selected",false);
     }
     this.set("context.selected", true);

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

@@ -2,7 +2,11 @@
   {{#tabbed-section}}
     {{#tab-contents name="info" hint="show info" currentMessage=currentMessage}}
       {{#if showTitle}}
-      <h3>Message</h3>
+      <h3>Message
+        {{#if currentMessage.showCount}}
+          ({{currentMessage.count}} copies reported)
+        {{/if}}
+      </h3>
       {{/if}}
       <pre>{{currentMessage.message}}</pre>
     {{/tab-contents}}

data/assets/javascript/templates/message.handlebars

@@ -1,4 +1,8 @@
-<td class="severity">{{{glyph}}}</td>
+<td class="severity">{{{glyph}}}
+{{#if showCount}}
+<span class='count'>{{count}}</span>
+{{/if}}
+</td>
 <td class="message-body">
   <div class="message">
     {{displayMessage}}

data/assets/stylesheets/app.css

@@ -36,7 +36,7 @@ td.time {
   vertical-align: top;
 }
 .message {
-  font-family: Consolas, mono;
+  font-family: Consolas, Monaco, Ubuntu Mono, monospace;
   font-size: 13px;
   overflow: hidden;
   white-space: nowrap;
@@ -45,7 +45,7 @@ td.time {
 }
 
 th.severity{
-  width: 30px;
+  width: 35px;
 }
 
 th.time{
@@ -55,18 +55,38 @@ th.time{
 .fatal{
   color: #E00;
 }
+.fatal .count {
+  background-color: #E00;
+}
 
 .error {
   color: #9F6000;
 }
+.error .count {
+  background-color: #9F6000;
+}
 
-.warn{
+.warn {
   color: #66000C;
 }
+.warn .count {
+  background-color: #66000C;
+}
 
-.debug{
+.debug {
   color: #777;
 }
+.debug .count {
+  background-color: #666;
+}
+
+.count {
+  color: #FFF;
+  border-radius: 3px;
+  padding: 0 4px;
+  float: right;
+  margin-right: 6px;
+}
 
 .action-panel .search input {
   border: 1px solid #DDD;

data/lib/logster.rb

@@ -40,9 +40,14 @@ module Logster
     logster_env = Logster::Message.populate_from_env(env)
     logster_env[key] = value
   end
+
+  def self.set_environments(envs)
+    @config.environments = envs
+  end
 end
 
-Logster.config.current_context = lambda{ |env, &block| block.call }
+# check logster/configuration.rb for config options
+# Logster.config.environments << :staging
 
 if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
   require 'logster/rails/railtie'

data/lib/logster/base_store.rb

@@ -10,30 +10,48 @@ module Logster
       @skip_empty = true
     end
 
+    # Save a new message at the front of the latest list.
     def save(message)
       not_implemented
     end
 
+    # Modify the saved message to the given one (identified by message.key) and bump it to the top of the latest list
+    def replace_and_bump(message)
+      not_implemented
+    end
+
+    # Check if another message with the same grouping_key is already stored.
+    # Returns the similar message's message.key
+    def similar_key(message)
+      not_implemented
+    end
+
+    # The number of messages currently stored.
     def count
       not_implemented
     end
 
+    # Delete all unprotected messages in the store.
     def clear
       not_implemented
     end
 
+    # Delete all messages, including protected messages.
     def clear_all
       not_implemented
     end
 
+    # Get a message by its message_key
     def get(message_key)
       not_implemented
     end
 
+    # Mark a message as protected; i.e. it is not deleted by the #clear method
     def protect(message_key)
       not_implemented
     end
 
+    # Clear the protected mark for a message.
     def unprotect(message_key)
       not_implemented
     end
@@ -65,9 +83,23 @@ module Logster
 
       return if ignore && ignore.any? { |pattern| message =~ pattern}
 
-      save message
+      similar = nil
 
-      message
+      if Logster.config.allow_grouping
+        key = self.similar_key(message)
+        similar = get key if key
+      end
+
+      if similar
+        similar.count += 1
+        similar.merge_similar_message(message)
+
+        replace_and_bump similar
+        similar
+      else
+        save message
+        message
+      end
     end
 
     private

data/lib/logster/configuration.rb

@@ -1,5 +1,22 @@
 module Logster
   class Configuration
-    attr_accessor :subdirectory, :current_context
+    attr_accessor :current_context, :allow_grouping, :environments
+    attr_writer :subdirectory
+
+    def initialize
+      # lambda |env,block|
+      @current_context = lambda{ |_, &block| block.call }
+      @environments = [:development, :production]
+      @subdirectory = nil
+
+      @allow_grouping = false
+      if defined?(::Rails) && Rails.env.production?
+        @allow_grouping = true
+      end
+    end
+
+    def subdirectory
+      @subdirectory || '/logs'
+    end
   end
 end

data/lib/logster/message.rb

@@ -1,4 +1,9 @@
+require 'digest/sha1'
+
 module Logster
+
+  MAX_GROUPING_LENGTH = 50
+
   class Message
     LOGSTER_ENV = "_logster_env".freeze
     ALLOWED_ENV = %w{
@@ -69,6 +74,26 @@ module Logster
       @env = Message.populate_from_env(env)
     end
 
+    # in its own method so it can be overridden
+    def grouping_hash
+      return { message: self.message, severity: self.severity, backtrace: self.backtrace }
+    end
+
+    # todo - memoize?
+    def grouping_key
+      Digest::SHA1.hexdigest JSON.fast_generate grouping_hash
+    end
+
+    def is_similar?(other)
+      self.grouping_key == other.grouping_key
+    end
+
+    def merge_similar_message(other)
+      other_env = JSON.load JSON.fast_generate other.env
+      other_env.keys.each do |env_key|
+        self.env[env_key] = Message.env_merge_helper(self.env[env_key], other_env[env_key])
+      end
+    end
 
     def self.populate_from_env(env)
       env[LOGSTER_ENV] ||= begin
@@ -82,6 +107,8 @@ module Logster
           request.params.each do |k,v|
             if k.include? "password"
               params[k] = "[redacted]"
+            elsif Array === v
+              params[k] = v[0..20]
             else
               params[k] = v && v[0..100]
             end
@@ -121,5 +148,48 @@ module Logster
     def get_timestamp
       (Time.new.to_f * 1000).to_i
     end
+
+    private
+
+    def self.env_merge_helper(self_value, other_value)
+      other_value = other_value.to_s if Symbol === other_value
+
+      if (Hash === self_value || self_value.nil?) && (Hash === other_value || other_value.nil?) && (!self_value.nil? || !other_value.nil?)
+        # one or both is a hash but not neither -> recurse on the keys
+        self_value = {} unless self_value
+        other_value = {} unless other_value
+        shared_keys = self_value.keys | (other_value.keys rescue [])
+        shared_keys.each do |key|
+          self_value[key] = env_merge_helper(self_value[key], other_value[key])
+        end
+        self_value
+      elsif self_value.is_a?(Array) && !other_value.is_a?(Array)
+        # Already have grouped data, so append to array (it's actually a set)
+        self_value << other_value unless self_value.include?(other_value) || self_value.length >= Logster::MAX_GROUPING_LENGTH
+        self_value
+      elsif !self_value.is_a?(Array)
+        if self_value == other_value
+          self_value
+        else
+          [self_value, other_value]
+        end
+      else
+        # They're both arrays.
+        # Three cases:
+        # self = [1,2,3] and other = [1,2,4] -> make into array of array
+        # self = [] and other = [1,2,4] -> make into array of array
+        # self = [[1,2,3], [1,2,5]] and other = [1,2,4] -> append to array
+        if self_value.length > 0 && self_value[0].is_a?(Array)
+          self_value << other_value unless self_value.include?(other_value) || self_value.length >= Logster::MAX_GROUPING_LENGTH
+          self_value
+        else
+          if self_value == other_value
+            self_value
+          else
+            [self_value, other_value]
+          end
+        end
+      end
+    end
   end
 end

data/lib/logster/middleware/reporter.rb

@@ -7,7 +7,7 @@ module Logster
 
       def initialize(app, config={})
         @app = app
-        @error_path = (Logster.config.subdirectory || '/logs') + '/report_js_error'
+        @error_path = Logster.config.subdirectory + '/report_js_error'
       end
 
       def call(env)

data/lib/logster/middleware/viewer.rb

@@ -11,7 +11,7 @@ module Logster
       def initialize(app)
         @app = app
 
-        @logs_path = Logster.config.subdirectory || "/logs"
+        @logs_path = Logster.config.subdirectory
         @path_regex = Regexp.new("^(#{@logs_path}$)|^(#{@logs_path}(/.*))$")
         @store = Logster.store or raise ArgumentError.new("store")
 

data/lib/logster/rails/railtie.rb

@@ -5,7 +5,7 @@ module Logster::Rails
   end
 
   def self.set_logger(config)
-    return unless Rails.env.development? || Rails.env.production?
+    return unless Logster.config.environments.include?(Rails.env.to_sym)
 
     require 'logster/middleware/debug_exceptions'
     require 'logster/middleware/reporter'
@@ -22,7 +22,7 @@ module Logster::Rails
 
 
   def self.initialize!(app)
-    return unless Rails.env.development? || Rails.env.production?
+    return unless Logster.config.environments.include?(Rails.env.to_sym)
 
     if Logster::Logger === Rails.logger
       app.middleware.insert_before ActionDispatch::ShowExceptions, Logster::Middleware::Reporter

data/lib/logster/redis_store.rb

@@ -13,21 +13,41 @@ module Logster
     end
 
     def save(message)
-      # multi for integrity
+      # TODO this whole method should be atomic lol, but it hasn't bitten me yet
       @redis.multi do
         @redis.hset(hash_key, message.key, message.to_json)
+        @redis.hset(grouping_key, message.grouping_key, message.key)
         @redis.rpush(list_key, message.key)
       end
 
-      # TODO make it atomic
       if @redis.llen(list_key) > max_backlog
         removed_key = @redis.lpop(list_key)
         if removed_key && !@redis.sismember(protected_key, removed_key)
-          @redis.hdel(hash_key, removed_key)
+          rmsg = get removed_key
+          @redis.hdel(hash_key, rmsg.key)
+          @redis.hdel(grouping_key, rmsg.grouping_key)
         end
       end
     end
 
+    def replace_and_bump(message)
+      # TODO make it atomic
+      exists = @redis.hexists(hash_key, message.key)
+      return false unless exists
+
+      @redis.multi do
+        @redis.hset(hash_key, message.key, message.to_json)
+        @redis.lrem(list_key, -1, message.key)
+        @redis.rpush(list_key, message.key)
+      end
+
+      true
+    end
+
+    def similar_key(message)
+      @redis.hget(grouping_key, message.grouping_key)
+    end
+
     def count
       @redis.llen(list_key)
     end
@@ -108,6 +128,7 @@ module Logster
       @redis.del(list_key)
       @redis.del(protected_key)
       @redis.del(hash_key)
+      @redis.del(grouping_key)
     end
 
     def get(message_key)
@@ -233,5 +254,9 @@ module Logster
     def protected_key
       @saved_key ||= "__LOGSTER__SAVED"
     end
+
+    def grouping_key
+      @grouping_key ||= "__LOGSTER__GMAP"
+    end
   end
 end

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.8.3"
+  VERSION = "0.8.4.pre"
 end

data/logster.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sam.saffron@gmail.com"]
   spec.summary       = %q{UI for viewing logs in Rack}
   spec.description   = %q{UI for viewing logs in Rack}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/discourse/logster"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject{|f| f.start_with?("bower_components") || f.start_with?("website") || f.start_with?("bin") }

data/vendor/assets/javascripts/logster.js.erb

@@ -30,7 +30,7 @@
       err.stacktrace = errorObj.stack;
     }
 
-    $.ajax("<%= Logster.config.subdirectory || '/logs' %>" + "/report_js_error", {
+    $.ajax("<%= Logster.config.subdirectory %>" + "/report_js_error", {
       data: err,
       type: "POST",
       cache: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4.pre
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,7 +148,7 @@ files:
 - test/logster/test_redis_store.rb
 - test/test_helper.rb
 - vendor/assets/javascripts/logster.js.erb
-homepage: ''
+homepage: https://github.com/discourse/logster
 licenses:
 - MIT
 metadata: {}
@@ -163,9 +163,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5