logster 2.6.3 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c4722bc20fa59b59150406aa51fce3a83cc4c922332dc42d0e6f288fc3ade4c
-  data.tar.gz: fab3d1bece8a5de7eff3da48fe5b131b4d86e70332017e4eb46b7415e052fa20
+  metadata.gz: 106a0763acb86a917c9a1b2f3a3e80cfc4e9ef789a1904e76499d62ff5f66298
+  data.tar.gz: 74aef16f2994ddde18124e9a914decb094fa275813eb31d396190f4bbd4d4e35
 SHA512:
-  metadata.gz: ee664e54fb5d8ebc459e0b7af99f7e32876de09e4bf0177499956b3243860ff8d8908f75c84c567ff709c39e26204aa7cab67b3627a5ae5eb7f133dfa82a36b2
-  data.tar.gz: bec1f484966140b3dfd98969d065b7b9cb23e3c7f6730148a7c610db9ea72b413327289377b19d41a460e15b20647909fa593abbf859569ba38c5f9e2e75ea3f
+  metadata.gz: ecc9724cc453bbf7c909c7ab9f6857250afc246dd1bc535ad7d29bbb1df7917c8f64b7e64f5a78d686f7118386c4359791fde6d8ca9e945e5f8213e3d76d8466
+  data.tar.gz: ae722de77352b4c355ae7f330d3af1697142394ea63f5a5a67dcfaeb1e6fe9594278e4a0deb2f647a0ba6a89f4297ed16592d421b1b98709991e95160a427f8a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+- 2020-02-26: 2.7.0
+
+  - FEATURE: Make log message max length configurable and bump the default to 2000 (#109)
+
 - 2020-02-17: 2.6.3
 
   - FIX: Respect redis namespace when fetching env using LUA

data/README.md

@@ -48,7 +48,9 @@ Logster can be configured using `Logster.config`:
 
 - `Logster.config.allow_grouping` : Enable grouping of similar messages into one messages with an array of `env` of the grouped messages. Similar messages are messages that have identical backtraces, severity and log message.
 
-- `Logster.config.maximum_message_size_bytes` : set a maximum size for messages. Default value is 10,000. If a message size exceeds this limit, Logster will first remove all occurrences of `gems_dir` (more on this config below) from the backtrace and computes the size again; if the message is still above the limit, Logster will remove as many as character as needed from the backtrace to bring the size below the limit. It's discouraged to set this config to a really low value (e.g. less than 2000) because a message needs a minimum amount of data in order to make sense (the minimum amount varies per message), so the closer the limit is to the mimimum amount of space needed, the more of the backtrace will be removed. Keep this in mind when tweaking this config.
+- `Logster.config.maximum_message_length` : set a maximum length for log messages that are shown inside the `info` tab and in the message rows in the UI. Messages that exceed the specified length will be truncated and an ellipsis will be appended to indicate that the message has been truncated. Default value is 2000.
+
+- `Logster.config.maximum_message_size_bytes` : set a maximum size for message objects. Default value is 10,000. If a message size exceeds this limit, Logster will first remove all occurrences of `gems_dir` (more on this config below) from the backtrace and computes the size again; if the message is still above the limit, Logster will remove as many as character as needed from the backtrace to bring the size below the limit. It's discouraged to set this config to a really low value (e.g. less than 2000) because a message needs a minimum amount of data in order to make sense (the minimum amount varies per message), so the closer the limit is to the mimimum amount of space needed, the more of the backtrace will be removed. Keep this in mind when tweaking this config.
 
 - `Logster.config.max_env_bytes` : set a maximum size for `env`. Default value is 1000. In case `env` is an array of hashes, this limit applies to the individual hashes in the array rather than the whole array. If an `env` hash exceeds this limit, Logster will take the biggest subset of key-value pairs whose size is below the limit. If the hash has a key with the name `time`, it will always be included.
 

data/lib/logster/base_store.rb

@@ -152,6 +152,8 @@ module Logster
       return if (!msg || (String === msg && msg.empty?)) && skip_empty
       return if level && severity < level
 
+      msg = msg.inspect unless String === msg
+      msg = truncate_message(msg)
       message = Logster::Message.new(severity, progname, msg, opts[:timestamp], count: opts[:count])
 
       env = opts[:env] || {}
@@ -245,6 +247,11 @@ module Logster
 
     private
 
+    def truncate_message(msg)
+      cap = Logster.config.maximum_message_length
+      msg.size <= cap ? msg : msg[0...cap] + "..."
+    end
+
     def not_implemented
       raise "Not Implemented"
     end

data/lib/logster/configuration.rb

@@ -17,7 +17,8 @@ module Logster
       :enable_backtrace_links,
       :gems_dir,
       :max_env_bytes,
-      :max_env_count_per_message
+      :max_env_count_per_message,
+      :maximum_message_length
     )
 
     attr_writer :subdirectory
@@ -37,6 +38,7 @@ module Logster
       @project_directories = []
       @enable_backtrace_links = true
       @gems_dir = Gem.dir + "/gems/"
+      @maximum_message_length = 2000
 
       @allow_grouping = false
 

data/lib/logster/message.rb

@@ -4,8 +4,6 @@ require 'digest/sha1'
 require 'securerandom'
 
 module Logster
-  MAX_MESSAGE_LENGTH = 600
-
   class Message
     LOGSTER_ENV = "_logster_env".freeze
     ALLOWED_ENV = %w{
@@ -30,7 +28,7 @@ module Logster
       @timestamp = timestamp || get_timestamp
       @severity = severity
       @progname = progname
-      @message = truncate_message(message)
+      @message = message
       @key = key || SecureRandom.hex
       @backtrace = nil
       @count = count || 1
@@ -57,10 +55,6 @@ module Logster
       h
     end
 
-    def message=(m)
-      @message = truncate_message(m)
-    end
-
     def to_json(opts = nil)
       exclude_env = Hash === opts && opts.delete(:exclude_env)
       JSON.fast_generate(to_h(exclude_env: exclude_env), opts)
@@ -311,12 +305,6 @@ module Logster
       end
     end
 
-    def truncate_message(msg)
-      return msg unless msg
-      msg = msg.inspect unless String === msg
-      msg.size <= MAX_MESSAGE_LENGTH ? msg : msg[0...MAX_MESSAGE_LENGTH] + "..."
-    end
-
     def get_timestamp
       (Time.new.to_f * 1000).to_i
     end

data/lib/logster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logster
-  VERSION = "2.6.3"
+  VERSION = "2.7.0"
 end

data/test/logster/test_base_store.rb

@@ -162,4 +162,18 @@ class TestBaseStore < Minitest::Test
       assert_includes(message.backtrace.lines.first, __method__.to_s)
     end
   end
+
+  def test_log_message_is_truncated_when_above_maximum_message_length
+    orig = Logster.config.maximum_message_length
+    Logster.config.maximum_message_length = 300
+    msg = @store.report(Logger::WARN, '', 'a' * 400)
+    # 3 is the ... at the end to indicate truncated message
+    assert_equal(300 + 3, msg.message.size)
+
+    Logster.config.maximum_message_length = 100
+    msg = @store.report(Logger::WARN, '', 'a' * 200)
+    assert_equal(100 + 3, msg.message.size)
+  ensure
+    Logster.config.maximum_message_length = orig
+  end
 end

data/test/logster/test_message.rb

@@ -146,12 +146,6 @@ class TestMessage < MiniTest::Test
     refute_includes(msg.to_json(exclude_env: true), test_hash.to_json)
   end
 
-  def test_title_is_truncated_when_too_large
-    msg = Logster::Message.new(0, "", "a" * 1000)
-    # 3 is the ... at the end to indicate truncated message
-    assert_equal(600 + 3, msg.message.size)
-  end
-
   def test_drop_redundant_envs
     message = Logster::Message.new(Logger::WARN, '', 'message')
     message.env = [{ a: 4 }] * 10

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.7.0
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler