logster 0.0.13 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c232a36182ddcf075324915beeb9be8be77acb4c
-  data.tar.gz: d761886b1f2ad2942fc1a49b2a17d9fb6069263e
+  metadata.gz: 2cfda323f9ee2749181b885b462d4e6b6398f03b
+  data.tar.gz: d9cf1b6ce77e9c7d74745c253047d39c992a1855
 SHA512:
-  metadata.gz: 35f5c15dc4a5b5f1e71f1d9c088d31e37c42bb7fceb545f44e6d059291dddfae45a5bed19b70edfbc3078bb8dfd0cd51eab050e743ef42718ae036f49c261064
-  data.tar.gz: f49ec022a79e6fab55ea4b0fdbcdd54d6778fa0059193ab325dc88e0b6585b64cb798733612ee2a8846cc6d99d461f3fb8c13248e5b0f28adbf6bf4ad43a0803
+  metadata.gz: bef73cfac1f6232793744b1fcb1807da74088a271bba04b0ad7ad6bca95de46a9d39ed73e23371970afd0c7e045a93c8d538c056b4434fddbed44946fb37064f
+  data.tar.gz: 8bcab70e33821609e020ad951e2453394eafbe2fb11607d3cdb63563898656e0b48aa8227b1edb97e0eef471ef09f4f93a6c802db745676bffd714d7ca6eb2ac

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

@@ -1,21 +1,15 @@
 <div class="message-info">
   {{#tabbed-section}}
-    {{#tab-contents name="info" hint="show info"}}
+    {{#tab-contents name="info" hint="show info" currentMessage=currentMessage}}
       <pre>{{currentMessage.message}}</pre>
-      {{#if currentMessage}}
-        <a {{bind-attr href=currentMessage.shareUrl}} class="share">Share</a>
-        <a {{bind-attr href=currentMessage.protectUrl}} class="save">
-          {{#if currentMessage.protected}}
-              Unprotect
-          {{else}}
-              Protect
-          {{/if}}
-        </a>
-      {{/if}}
     {{/tab-contents}}
-    {{#tab-contents name="backtrace" hint="show backtrace"}}<pre>{{currentMessage.backtrace}}</pre>{{/tab-contents}}
+    {{#tab-contents name="backtrace" hint="show backtrace" currentMessage=currentMessage}}
+        <pre>{{currentMessage.backtrace}}</pre>
+    {{/tab-contents}}
     {{#if currentMessage.env}}
-      {{#tab-contents name="env" hint="show environment"}}<pre>{{currentMessage.envDebug}}</pre>{{/tab-contents}}
+      {{#tab-contents name="env" hint="show environment" currentMessage=currentMessage}}
+          <pre>{{currentMessage.envDebug}}</pre>
+      {{/tab-contents}}
     {{/if}}
   {{/tabbed-section}}
 </div>

data/assets/javascript/components/tab-contents.handlebars

@@ -1 +1,11 @@
 {{yield}}
+{{#if currentMessage}}
+    <a {{bind-attr href=currentMessage.shareUrl}} class="share">Share</a>
+    <a {{bind-attr href=currentMessage.protectUrl}} class="save">
+      {{#if currentMessage.protected}}
+          Unprotect
+      {{else}}
+          Protect
+      {{/if}}
+    </a>
+{{/if}}

data/assets/javascript/templates/index.handlebars

@@ -10,7 +10,7 @@
     <tbody>
     {{#if model.moreBefore}}
       <tr {{action showMoreBefore}} class="show-more">
-        <td colspan=4>{{model.totalBefore}} more</td>
+        <td colspan=3>{{model.totalBefore}} more</td>
       </tr>
     {{/if}}
     {{each model.messages itemViewClass="App.MessageView"}}

data/lib/examples/sidekiq_logster_reporter.rb

@@ -0,0 +1,21 @@
+class SidekiqLogsterReporter
+  def call(ex, context={})
+    # Pass context to Logster
+    fake_env = {}
+    context.each do |key, value|
+      Logster.add_to_env(fake_env, key, value)
+    end
+
+    text = "Job exception: #{ex}\n"
+    if ex.backtrace
+      Logster.add_to_env(fake_env, :backtrace, ex.backtrace)
+    end
+
+    Thread.current[Logster::Logger::LOGSTER_ENV] = fake_env
+    Logster.logger.error(text)
+  rescue => e
+    Logster.logger.fatal("Failed to log exception #{ex} #{hash}\nReason: #{e.class} #{e}\n#{e.backtrace.join("\n")}")
+  ensure
+    Thread.current[Logster::Logger::LOGSTER_ENV] = nil
+  end
+end

data/lib/logster/message.rb

@@ -85,6 +85,13 @@ module Logster
       end
     end
 
+    def <=>(other)
+      time = self.timestamp <=> other.timestamp
+      return time if time && time != 0
+
+      self.key <=> other.key
+    end
+
     protected
 
     def get_timestamp

data/lib/logster/middleware/viewer.rb

@@ -39,8 +39,10 @@ module Logster
             # accl redirect is going to be trouble, ensure its bypassed
             env['sendfile.type'] = ''
             @fileserver.call(env)
+
           elsif resource.start_with?("/messages.json")
             serve_messages(Rack::Request.new(env))
+
           elsif resource =~ /\/(un)?protect\/([0-9a-f]+)$/
             off = $1 == "un"
             key = $2
@@ -88,8 +90,10 @@ module Logster
               preload = preload_json({"/show/#{key}.json" => message})
               [200, {"Content-Type" => "text/html; charset=utf-8"}, [body(preload)]]
             end
+
           elsif resource == "/"
             [200, {"Content-Type" => "text/html; charset=utf-8"}, [body(preload_json)]]
+
           else
             [404, {}, ["Not found"]]
           end

data/lib/logster/redis_store.rb

@@ -21,7 +21,7 @@ module Logster
       return if level && severity < level
       return if @ignore && @ignore.any?{|pattern| message =~ pattern}
 
-      message = Logster::Message.new(severity, progname, message)
+      message = Logster::Message.new(severity, progname, message, (opts && opts[:timestamp]))
 
       if opts && backtrace = opts[:backtrace]
         message.backtrace = backtrace
@@ -109,9 +109,23 @@ module Logster
         protected = @redis.mapped_hmget(hash_key, *keys)
         @redis.del(hash_key)
         @redis.mapped_hmset(hash_key, protected)
+
+        sorted = protected
+          .values
+          .map { |string| Message.from_json(string) }
+          .sort
+          .map(&:key)
+
+        @redis.pipelined do
+          sorted.each do |message_key|
+            @redis.rpush(list_key, message_key)
+          end
+        end
       end
     end
 
+    # Delete everything, included protected messages
+    # (use in tests)
     def clear_all
       @redis.del(list_key)
       @redis.del(protected_key)

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.0.13"
+  VERSION = "0.1.0"
 end

data/test/examples/test_sidekiq_reporter_example.rb

@@ -0,0 +1,31 @@
+require_relative '../test_helper'
+require 'logster/logger'
+require 'logger'
+require 'examples/sidekiq_logster_reporter'
+
+class TestSidekiqReporter < MiniTest::Test
+
+  def setup
+    Logster.store = @store = Logster::TestStore.new
+    Logster.logger = @logger = Logster::Logger.new(Logster.store)
+  end
+
+  def test_sidekiq_handler_example
+    handler = SidekiqLogsterReporter.new
+    error = nil
+    begin
+      raise TypeError.new
+    rescue => e
+      error = e
+    end
+
+    handler.call(error, code: "Test", something_important: "Foo", params: { article_id: 20 })
+
+    error = Logster.store.reported[0]
+
+    assert(error.backtrace != nil)
+    assert_equal("Job exception: TypeError\n", error.message)
+    assert_equal("Test", error.env[:code])
+    assert_equal(20, error.env[:params][:article_id])
+  end
+end

data/test/logster/test_logger.rb

@@ -24,6 +24,4 @@ class TestLogger < Minitest::Test
     assert_match(/W,.*boom/, io.string)
 
   end
-
 end
-

data/test/logster/test_redis_store.rb

@@ -10,7 +10,7 @@ class TestRedisStore < Minitest::Test
   end
 
   def teardown
-    @store.clear
+    @store.clear_all
   end
 
   def test_latest
@@ -121,26 +121,35 @@ class TestRedisStore < Minitest::Test
   end
 
   def test_clear
-    10.times do
-      @store.report(Logger::WARN, "test", "A")
+    @store.max_backlog = 25
+    a_message = @store.report(Logger::WARN, "test", "A", timestamp: Time.now - (24*60*60))
+    @store.protect a_message.key
+    20.times do
+      @store.report(Logger::WARN, "test", "B")
     end
-    # Protected messages are not deleted
-    b_message = @store.report(Logger::WARN, "test", "B")
-    @store.protect b_message.key
-    c_message = @store.report(Logger::WARN, "test", "C")
+    c_message = @store.report(Logger::WARN, "test", "C", timestamp: Time.now + (24*60*60))
+    @store.protect c_message.key
+    d_message = @store.report(Logger::WARN, "test", "D")
     10.times do
-      @store.report(Logger::WARN, "test", "D")
+      @store.report(Logger::WARN, "test", "E")
     end
 
     latest = @store.latest
-    assert_equal(22, latest.length)
+    assert_equal(25, latest.length)
 
     @store.clear
 
+    # Protected messages are still accessible by their key
+    assert_equal("C", @store.get(c_message.key).message)
+    # Unprotected messages are gone
+    assert_nil(@store.get(d_message.key))
+
+    # The latest list is rebuilt with protected messages, earliest first
+    # Including messages that previously fell off (A)
     latest = @store.latest
-    assert_equal(0, latest.length)
-    assert_equal("B", @store.get(b_message.key).message)
-    assert_nil(@store.get(c_message.key))
+    assert_equal(2, latest.length)
+    assert_equal("A", latest[0].message)
+    assert_equal("C", latest[1].message)
   end
 
   def test_hash_cleanup

data/test/test_helper.rb

@@ -12,7 +12,28 @@ class Logster::TestStore
     @reported = []
   end
 
-  def report(*args)
-    @reported << args
+  def report(severity, progname, message, opts = nil)
+    opts ||= {}
+    env = opts[:env]
+    backtrace = opts[:backtrace]
+    if env && !backtrace
+      backtrace = env[:backtrace]
+    end
+
+    message = Logster::Message.new(severity, progname, message)
+
+    if backtrace
+      message.backtrace = backtrace
+    else
+      message.backtrace = caller.join("\n")
+    end
+
+    if env
+      message.populate_from_env(env)
+    end
+
+    @reported << message
+
+    message
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.1.0
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,6 +124,7 @@ files:
 - assets/javascript/templates/show.handlebars
 - assets/stylesheets/app.css
 - bower.json
+- lib/examples/sidekiq_logster_reporter.rb
 - lib/logster.rb
 - lib/logster/configuration.rb
 - lib/logster/logger.rb
@@ -136,6 +137,7 @@ files:
 - lib/logster/version.rb
 - lib/logster/web.rb
 - logster.gemspec
+- test/examples/test_sidekiq_reporter_example.rb
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_logger.rb
@@ -167,6 +169,7 @@ signing_key:
 specification_version: 4
 summary: UI for viewing logs in Rack
 test_files:
+- test/examples/test_sidekiq_reporter_example.rb
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_logger.rb