logster 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab6df8f8f3acb188c5c06f1a5a191f8f2a737575
-  data.tar.gz: 9c28f65b32c19ce9b3f4d52667689812c0ea14cf
+  metadata.gz: 2dad3528f0f66416dd6be075bc89aa5a143a6cc0
+  data.tar.gz: 6d187ba9d934f8fc1ba770cb1edf67c1e2d22fbc
 SHA512:
-  metadata.gz: 7bbbb4fccfa6b6512694b3e52ad0ac7d107b555c54af0365676ac1e56e704573780912206fbc5acddd6d413c205c953eaddd110b928550db40d5a2138fc2b1a2
-  data.tar.gz: 678e0f79da17b9e00c03b4df43aa13df8f6bf8da7e9923ab751cac13bd7f26e563687a4c63f9bb9a21204f38a4fc3b360f8c7dba90af90070817ee9d8fc59f0d
+  metadata.gz: 3fc3c01b210b3ca0d0b039971122fdce7654b8c59f91cb6ff01dc2ec255f3af7688faf46db7988c3c95f7b3aa7341274dfbc3689628ce871cfea4a0602870d99
+  data.tar.gz: 50271d90874e29781082f723017f121745793ef36fcf7c886b53da7e69549a8bdb53998c3d70088c46e08d917aafdcf67b420e1800e09fee2c212535658a3ccd

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 TODO: Write your name
+Copyright (c) 2014 Sam Saffron
 
 MIT License
 

data/README.md

@@ -2,6 +2,8 @@
 
 A web log viewer and logging framework for Rack applications
 
+## [Live Demo](http://logster.info/logs)
+
 ![logster](http://i.imgur.com/cvfcQpv.png)
 
 ## Installation
@@ -19,7 +21,7 @@ Logster will wire up `/logs` path in your Rails app in **development** mode only
 
 ## Usage
 
-Logster is in current development, at the moment the focus is on a decent tool for dev. Once that is complete production mode will be build.
+Logster is in current development, at the moment the focus is on a decent tool for dev. Once that is complete production mode will be built.
 
 The concept is to have an embedded "exception reporting service" admins can view on live sites.
 
@@ -36,3 +38,7 @@ Logster UI is built using [Ember.js](http://emberjs.com/)
 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
+
+- 2014-05-07: Started changelog :)

data/assets/javascript/app.js

@@ -101,6 +101,15 @@ App.MessageCollection = Em.Object.extend({
       filter: this.get("filter").join("_")
     };
 
+    search = this.get("search");
+    if (!_.isEmpty(search)) {
+      data.search = search;
+      var regexSearch = this.get("regexSearch");
+      if(regexSearch) {
+        data.regex_search = "true";
+      }
+    }
+
     if(opts.before){
       data.before = opts.before;
     }
@@ -162,6 +171,23 @@ App.MessageCollection = Em.Object.extend({
     });
   },
 
+  regexSearch: function() {
+    search = this.get("search");
+    if( search &&
+        search.length > 2 &&
+        search[0] === "/"
+      ){
+      var match = search.match(/\/(.*)\/(.*)/);
+      if(match && match.length === 3){
+        try {
+          return new RegExp(match[1], match[2]);
+        } catch(err) {
+          // don't care
+        }
+      }
+    }
+  }.property("search"),
+
   toMessages: function(messages){
     return messages.map(function(m){
         return App.Message.create(m);
@@ -182,7 +208,8 @@ App.IndexRoute = Em.Route.extend({
       "showInfo": true,
       "showWarn": true,
       "showErr": true,
-      "showFatal": true
+      "showFatal": true,
+      "search": ''
     });
     controller.set("initialized", true);
     model.reload();
@@ -228,6 +255,19 @@ App.IndexController = Em.Controller.extend({
       "showFatal"
     ),
 
+  searchChanged: function(){
+    var search = this.get("search");
+    var model = this.get("model");
+    model.set("search", search);
+
+    if(this.get("initialized")){
+      model.reload();
+    }
+  }.observes(
+      "search"
+    ),
+
+
   checkIfAtBottom: function(){
     if (this.checkedBottom) {
       return;

data/assets/javascript/templates/index.handlebars

@@ -44,5 +44,8 @@
       {{input type="checkbox" checked=showFatal}}
       Fatal
     </label>
+    <label class="search">
+      {{input type="textfield" placeholder="Search" value=search}}
+    </label>
   </div>
 </div>

data/assets/stylesheets/app.css

@@ -68,7 +68,14 @@ th.time{
   color: #777;
 }
 
+.search input {
+  border: 1px solid #DDD;
+  padding: 3px;
+}
 
+.regex input {
+  margin-left: 2px !important;
+}
 
 tr.show-more {
   text-align: center;
@@ -155,7 +162,7 @@ tr.show-more {
 }
 .action-panel input {
   position: relative;
-  top: 2px;
+  top: -1px;
   margin-left: 20px;
 }
 

data/lib/logster.rb

@@ -1,7 +1,31 @@
 require 'logster/logger'
 require 'logster/message'
+require 'logster/configuration'
 
 module Logster
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger
+  end
+
+  def self.store=(store)
+    @store=store
+  end
+
+  def self.store
+    @store
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
 end
 
 if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3

data/lib/logster/configuration.rb

@@ -0,0 +1,5 @@
+module Logster
+  class Configuration
+    attr_accessor :authorize_callback, :subdirectory
+  end
+end

data/lib/logster/logger.rb

@@ -9,11 +9,26 @@ module Logster
       @store = store
     end
 
+    def chain(logger)
+      @chained ||= []
+      @chained << logger
+    end
+
     def add(severity, message, progname, &block)
       if severity < @level
         return true
       end
 
+      if @chained
+        i = 0
+        # micro optimise for logging
+        while i < @chained.length
+          # TODO double yielding blocks
+          @chained[i].add(severity, message, progname, &block)
+          i += 1
+        end
+      end
+
       progname ||= @progname
       if message.nil?
         if block_given?
@@ -24,7 +39,7 @@ module Logster
         end
       end
 
-     @store.report(severity, progname, message)
+      @store.report(severity, progname, message)
 
     end
   end

data/lib/logster/middleware/viewer.rb

@@ -5,23 +5,32 @@ module Logster
     class Viewer
 
       PATH_INFO = "PATH_INFO".freeze
+      SCRIPT_NAME = "SCRIPT_NAME".freeze
 
-      def initialize(app, config)
+      def initialize(app)
         @app = app
-        @logs_path = config[:path] || "/logs"
-        @path_regex = Regexp.new("(#{@logs_path}$)|(#{@logs_path}(/.*))$")
 
-        @store = config[:store] or raise ArgumentError.new("store")
+        @logs_path = Logster.config.subdirectory || "/logs"
+        @path_regex = Regexp.new("^(#{@logs_path}$)|^(#{@logs_path}(/.*))$")
+        @store = Logster.store or raise ArgumentError.new("store")
 
         @assets_path = File.expand_path("../../../../assets", __FILE__)
         @fileserver = Rack::File.new(@assets_path)
+        @authorize_callback = Logster.config.authorize_callback
       end
 
       def call(env)
         path = env[PATH_INFO]
+        script_name = env[SCRIPT_NAME]
+
+        if script_name && script_name.length > 0
+          path = script_name + path
+        end
 
         if resource = resolve_path(path)
 
+          return @app.call(env) if @authorize_callback && !@authorize_callback.call(env)
+
           if resource =~ /\.js$|\.handlebars$|\.css$/
             env[PATH_INFO] = resource
             @fileserver.call(env)
@@ -50,6 +59,11 @@ module Logster
           opts[:severity] = filter
         end
 
+        if search = req["search"]
+          search = (parse_regex(search) || search) if req["regex_search"] == "true"
+          opts[:search] = search
+        end
+
         payload = {
           messages: @store.latest(opts),
           total: @store.count
@@ -59,6 +73,14 @@ module Logster
         [200, {"Content-Type" => "application/json"}, [json]]
       end
 
+      def parse_regex(string)
+        if string =~ /\/(.+)\/(.*)/
+          s = $1
+          flags = Regexp::IGNORECASE if $2 && $2.include?("i")
+          Regexp.new(s, flags) rescue nil
+        end
+      end
+
       def resolve_path(path)
         if path =~ @path_regex
           $3 || "/"

data/lib/logster/rails/railtie.rb

@@ -1,26 +1,34 @@
 module Logster::Rails
 
   def self.set_logger(config)
-    return unless Rails.env.development?
+    return unless Rails.env.development? || Rails.env.production?
 
     if defined?(Redis)
       require 'logster/middleware/viewer'
       require 'logster/redis_store'
 
-      store = Logster::RedisStore.new
+      store = Logster.store ||= Logster::RedisStore.new
+      store.level = Logger::Severity::WARN if Rails.env.production?
+
       logger = Logster::Logger.new(store)
+      logger.chain(::Rails.logger)
+      logger.level = ::Rails.logger.level
 
-      ::Rails.logger = config.logger = logger
+      Logster.logger = ::Rails.logger = config.logger = logger
     else
       Rails.logger.warn "Not loading logster, Redis missing"
     end
   end
 
   def self.initialize!(app)
-    return unless Rails.env.development?
+    return unless Rails.env.development? || Rails.env.production?
 
     if Logster::Logger === Rails.logger
-      app.middleware.use Logster::Middleware::Viewer, store: Rails.logger.store
+      if Rails.env.development?
+        # in production you must mount in routes.rb
+        # or by inserting middleware
+        app.middleware.use Logster::Middleware::Viewer
+      end
 
       app.config.colorize_logging = false
     end

data/lib/logster/redis_store.rb

@@ -3,7 +3,8 @@ require 'json'
 module Logster
   class RedisStore
 
-    attr_accessor :max_backlog, :dedup, :max_retention, :skip_empty
+    attr_accessor :level, :redis, :max_backlog,
+                  :dedup, :max_retention, :skip_empty
 
     def initialize(redis = nil)
       @redis = redis || Redis.new
@@ -16,6 +17,7 @@ module Logster
 
     def report(severity, progname, message)
       return if (!message || (String === message && message.empty?)) && skip_empty
+      return if level && severity < level
 
       message = Message.new(severity, progname, message)
       @redis.rpush(list_key, message.to_json)
@@ -37,46 +39,11 @@ module Logster
       severity = opts[:severity]
       before = opts[:before]
       after = opts[:after]
-      start = -limit
-      finish = -1
-
-      if before || after
-        # inefficient may change to sorted list, also timing issues
-        found = nil
-        find = before || after
-
-        while !found
-          items = @redis.lrange(list_key, start, finish)
-
-          break unless items && items.length > 0
+      search = opts[:search]
 
-          found = items.index do |i|
-            Message.from_json(i).key == find
-          end
+      start, finish = find_location(before, after, limit)
 
-          if items.length < limit
-            found += limit - items.length if found
-            break
-          end
-          break if found
-          start -= limit
-          finish -= limit
-        end
-
-        if found
-          if before
-            offset = -(limit - found)
-          else
-            offset = found + 1
-          end
-
-          start += offset
-          finish += offset
-
-          finish = -1 if finish > -1
-          return [] if start > -1
-        end
-      end
+      return [] unless start && finish
 
       results = []
 
@@ -91,6 +58,8 @@ module Logster
           row = Message.from_json(s)
           break if before && before == row.key
           row = nil if severity && !severity.include?(row.severity)
+
+          row = filter_search(row, search)
           temp << row if row
         end
 
@@ -115,6 +84,62 @@ module Logster
 
     protected
 
+    def find_location(before, after, limit)
+      start = -limit
+      finish = -1
+
+      return [start,finish] unless before || after
+
+      # inefficient may change to sorted list, also timing issues
+      found = nil
+      find = before || after
+
+      while !found
+        items = @redis.lrange(list_key, start, finish)
+
+        break unless items && items.length > 0
+
+        found = items.index do |i|
+          Message.from_json(i).key == find
+        end
+
+        if items.length < limit
+          found += limit - items.length if found
+          break
+        end
+        break if found
+        start -= limit
+        finish -= limit
+      end
+
+      if found
+        if before
+          offset = -(limit - found)
+        else
+          offset = found + 1
+        end
+
+        start += offset
+        finish += offset
+
+        finish = -1 if finish > -1
+        return nil if start > -1
+      end
+
+      [start, finish]
+    end
+
+    def filter_search(row, search)
+      return row unless row && search
+
+      if Regexp === search
+        row if row.message =~ search
+      elsif row.message.include?(search)
+        row
+      end
+
+    end
+
 
     def list_key
       @list_key ||= "__LOGSTER__LOG"

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/logster/middleware/test_viewer.rb

@@ -5,18 +5,46 @@ require 'logster/middleware/viewer'
 
 class TestViewer < Minitest::Test
 
+  class BrokenApp
+    def call(env)
+      [500, {}, ["broken"]]
+    end
+  end
+
+  def setup
+    Logster.store = Logster::RedisStore.new
+  end
+
   def teardown
+    Logster.config.subdirectory = nil
+    Logster.config.authorize_callback = nil
+    Logster.store = nil
   end
 
   def viewer
     @viewer ||= begin
-                  store = Logster::RedisStore.new
-                  Logster::Middleware::Viewer.new(nil, store: store, path: "/logsie")
+                  Logster.config.subdirectory = "/logsie"
+                  Logster::Middleware::Viewer.new(nil)
                 end
   end
 
+  def test_authorize_callback
+    Logster.config.authorize_callback = lambda{ |env|
+      env["authorized"]
+    }
+
+    viewer = Logster::Middleware::Viewer.new(BrokenApp.new)
+    status, _  = viewer.call({"PATH_INFO" => "/logs"})
+    assert_equal(500, status)
+
+    status, _  = viewer.call({"PATH_INFO" => "/logs", "authorized" => true})
+    assert_equal(200, status)
+  end
+
   def test_path_resolution
     assert_nil(viewer.send(:resolve_path, "/logs"))
+    assert_nil(viewer.send(:resolve_path, "/admin/logsie"))
+    assert_nil(viewer.send(:resolve_path, "/admin/logsie/bla"))
     assert_equal("/",viewer.send(:resolve_path, "/logsie"))
     assert_equal("/",viewer.send(:resolve_path, "/logsie/"))
     assert_equal("/hello/world",viewer.send(:resolve_path, "/logsie/hello/world"))
@@ -31,4 +59,8 @@ class TestViewer < Minitest::Test
     assert_equal(200, result)
   end
 
+  def test_regex_parse
+    assert_equal(/hello/i, viewer.send(:parse_regex, '/hello/i'))
+  end
+
 end

data/test/logster/test_logger.rb

@@ -0,0 +1,29 @@
+require_relative '../test_helper'
+require 'logster/logger'
+require 'logger'
+
+class NullStore
+  def report(severity,progname,message)
+  end
+end
+
+class TestLogger < Minitest::Test
+
+  def setup
+    @logger = Logster::Logger.new(NullStore.new)
+  end
+
+  def teardown
+  end
+
+  def test_chain
+    io = StringIO.new
+    @logger.chain Logger.new(io)
+    @logger.warn "boom"
+
+    assert_match(/W,.*boom/, io.string)
+
+  end
+
+end
+

data/test/logster/test_redis_store.rb

@@ -109,4 +109,28 @@ class TestRedisStore < Minitest::Test
     assert_equal(1, latest.length);
   end
 
+  def test_search
+    @store.report(Logger::INFO, "test", "A")
+    @store.report(Logger::INFO, "test", "B")
+
+    messages = @store.latest
+    assert_equal(2, messages.length)
+
+    latest = @store.latest(search: "B")
+
+    assert_equal(1, latest.length)
+  end
+
+  def test_regex_search
+    @store.report(Logger::INFO, "test", "pattern_1")
+    @store.report(Logger::INFO, "test", "pattern_2")
+
+    messages = @store.latest
+    assert_equal(2, messages.length)
+
+    latest = @store.latest(search: /^pattern_[1]$/)
+
+    assert_equal(1, latest.length)
+  end
+
 end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
-require 'logster'
-require 'redis'
 require 'minitest'
 require 'minitest/unit'
 require 'minitest/autorun'
 require 'minitest/pride'
+require 'logster'
+require 'redis'
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - assets/javascript/templates/message.handlebars
 - assets/stylesheets/app.css
 - lib/logster.rb
+- lib/logster/configuration.rb
 - lib/logster/logger.rb
 - lib/logster/message.rb
 - lib/logster/middleware/reporter.rb
@@ -128,6 +129,7 @@ files:
 - lib/logster/version.rb
 - logster.gemspec
 - test/logster/middleware/test_viewer.rb
+- test/logster/test_logger.rb
 - test/logster/test_redis_store.rb
 - test/test_helper.rb
 homepage: ''
@@ -156,5 +158,6 @@ specification_version: 4
 summary: UI for viewing logs in Rack
 test_files:
 - test/logster/middleware/test_viewer.rb
+- test/logster/test_logger.rb
 - test/logster/test_redis_store.rb
 - test/test_helper.rb