logster 2.1.2 → 2.2.0

data/lib/examples/sidekiq_logster_reporter.rb

@@ -1,21 +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
+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.rb

@@ -1,54 +1,59 @@
-require 'logster/logger'
-require 'logster/message'
-require 'logster/configuration'
-require 'logster/web'
-require 'logster/ignore_pattern'
-
-if defined? Redis
-  require 'logster/redis_store'
-else
-  STDERR.puts "ERROR: Redis is not loaded, ensure redis gem is required before logster"
-  exit
-end
-
-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
-
-  def self.add_to_env(env, key, value)
-    logster_env = Logster::Message.populate_from_env(env)
-    logster_env[key] = value
-  end
-
-  def self.set_environments(envs)
-    config.environments = envs
-  end
-end
-
-# check logster/configuration.rb for config options
-# Logster.config.environments << :staging
-
-if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
-  require 'logster/rails/railtie'
-end
+require 'logster/logger'
+require 'logster/message'
+require 'logster/configuration'
+require 'logster/web'
+require 'logster/ignore_pattern'
+require 'logster/pattern'
+require 'logster/suppression_pattern'
+require 'logster/cache'
+
+if defined? Redis
+  require 'logster/redis_store'
+else
+  STDERR.puts "ERROR: Redis is not loaded, ensure redis gem is required before logster"
+  exit
+end
+
+module Logster
+  PATTERNS = [SuppressionPattern]
+
+  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
+
+  def self.add_to_env(env, key, value)
+    logster_env = Logster::Message.populate_from_env(env)
+    logster_env[key] = value
+  end
+
+  def self.set_environments(envs)
+    config.environments = envs
+  end
+end
+
+# check logster/configuration.rb for config options
+# Logster.config.environments << :staging
+
+if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
+  require 'logster/rails/railtie'
+end

data/lib/logster/base_store.rb

@@ -1,141 +1,169 @@
-module Logster
-  class BaseStore
-
-    attr_accessor :level, :max_retention, :skip_empty, :ignore
-
-    def initialize
-      @max_retention = 60 * 60 * 24 * 7
-      @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, save_env: true)
-      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, load_env: true)
-      not_implemented
-    end
-
-    # Get a group of messages by their message_keys
-    def bulk_get(message_keys)
-      not_implemented
-    end
-
-    # Get a message's env by its message_key
-    def get_env(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
-
-    def delete(message_key)
-      not_implemented
-    end
-
-    # Clear the protected mark for a message.
-    def unprotect(message_key)
-      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
-
-    # Registers a rate limit on the given severities of logs
-    def register_rate_limit(severities, limit, duration, &block)
-      not_implemented
-    end
-
-    # Checks all the existing rate limiters to check if any has been exceeded
-    def check_rate_limits(severity)
-      not_implemented
-    end
-
-    def report(severity, progname, msg, opts = {})
-      return if (!msg || (String === msg && msg.empty?)) && skip_empty
-      return if level && severity < level
-
-      message = Logster::Message.new(severity, progname, msg, opts[:timestamp], count: opts[:count])
-
-      env = opts[:env] || {}
-      backtrace = opts[:backtrace]
-      if Hash === env && env[:backtrace]
-        # Special - passing backtrace through env
-        backtrace = env.delete(:backtrace)
-      end
-
-      message.populate_from_env(env)
-
-      if backtrace
-        if backtrace.respond_to? :join
-          backtrace = backtrace.join("\n")
-        end
-        message.backtrace = backtrace
-      else
-        message.backtrace = caller.join("\n")
-      end
-
-      return if ignore && ignore.any? { |pattern| message =~ pattern }
-
-      similar = nil
-
-      if Logster.config.allow_grouping
-        key = self.similar_key(message)
-        similar = get(key, load_env: false) if key
-      end
-
-      if similar
-        has_env = !similar.env.nil? && !similar.env.empty?
-        if similar.count < Logster::MAX_GROUPING_LENGTH && !has_env
-          similar.env = get_env(similar.key) || {}
-        end
-        save_env = similar.merge_similar_message(message)
-
-        replace_and_bump(similar, save_env: save_env || has_env)
-        similar
-      else
-        save message
-        message
-      end
-    end
-
-    private
-
-    def not_implemented
-      raise "Not Implemented"
-    end
-  end
-end
+module Logster
+  class BaseStore
+
+    attr_accessor :level, :max_retention, :skip_empty, :ignore, :allow_custom_patterns
+
+    def initialize
+      @max_retention = 60 * 60 * 24 * 7
+      @skip_empty = true
+      @allow_custom_patterns = false
+      @patterns_cache = Logster::Cache.new
+    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, save_env: true)
+      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, load_env: true)
+      not_implemented
+    end
+
+    # Get a group of messages by their message_keys
+    def bulk_get(message_keys)
+      not_implemented
+    end
+
+    # Get a message's env by its message_key
+    def get_env(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
+
+    def delete(message_key)
+      not_implemented
+    end
+
+    # Clear the protected mark for a message.
+    def unprotect(message_key)
+      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
+
+    # Registers a rate limit on the given severities of logs
+    def register_rate_limit(severities, limit, duration, &block)
+      not_implemented
+    end
+
+    # Checks all the existing rate limiters to check if any has been exceeded
+    def check_rate_limits(severity)
+      not_implemented
+    end
+
+    # takes a string as `pattern` and places it under the set `set_name`
+    def insert_pattern(set_name, pattern)
+      not_implemented
+    end
+
+    # takes a string as `pattern` and removes it from the set `set_name`
+    def remove_pattern(set_name, pattern)
+      not_implemented
+    end
+
+    # returns an array of strings each of which must be convertible to regexp
+    def get_patterns(set_name)
+      not_implemented
+    end
+
+    def report(severity, progname, msg, opts = {})
+      return if (!msg || (String === msg && msg.empty?)) && skip_empty
+      return if level && severity < level
+
+      message = Logster::Message.new(severity, progname, msg, opts[:timestamp], count: opts[:count])
+
+      env = opts[:env] || {}
+      backtrace = opts[:backtrace]
+      if Hash === env && env[:backtrace]
+        # Special - passing backtrace through env
+        backtrace = env.delete(:backtrace)
+      end
+
+      message.populate_from_env(env)
+
+      if backtrace
+        if backtrace.respond_to? :join
+          backtrace = backtrace.join("\n")
+        end
+        message.backtrace = backtrace
+      else
+        message.backtrace = caller.join("\n")
+      end
+
+      return if ignore && ignore.any? { |pattern| message =~ pattern }
+
+      if Logster.config.enable_custom_patterns_via_ui || allow_custom_patterns
+        custom_ignore = @patterns_cache.fetch do
+          Logster::SuppressionPattern.find_all(store: self)
+        end
+        return if custom_ignore.any? { |pattern| message =~ pattern }
+      end
+
+      similar = nil
+
+      if Logster.config.allow_grouping
+        key = self.similar_key(message)
+        similar = get(key, load_env: false) if key
+      end
+
+      if similar
+        has_env = !similar.env.nil? && !similar.env.empty?
+        if similar.count < Logster::MAX_GROUPING_LENGTH && !has_env
+          similar.env = get_env(similar.key) || {}
+        end
+        save_env = similar.merge_similar_message(message)
+
+        replace_and_bump(similar, save_env: save_env || has_env)
+        similar
+      else
+        save message
+        message
+      end
+    end
+
+    def clear_suppression_patterns_cache
+      @patterns_cache.clear
+    end
+
+    private
+
+    def not_implemented
+      raise "Not Implemented"
+    end
+  end
+end