semantic_logger 2.13.1 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d1b60df19e53352219ff825835d2d5c804c1733
-  data.tar.gz: 936f580069648c8b91d5f3c589671649da3fc726
+  metadata.gz: 3a000244f5570ff32c8dcc923f066a131abd7cb0
+  data.tar.gz: a9471ed620e7408a195a9292f41730c68ea54e98
 SHA512:
-  metadata.gz: b10df7ef8e1561f90f7f07c3f427cd63b90be885fe1b45f5d01c4a78b01dadda2040e416bd7dfc77d409815505ee0394ee2f47e9a1c4fbfaed495b9c9b3b835c
-  data.tar.gz: 10444abc156d65cd7cab0a788bc5f311b0e1751ec8bf96761ce89d759d9521f91f17b12ea0332f98fd7e247560afba7435fdbf7a9ffaae9461484ebacaef3406
+  metadata.gz: 0667f6ef71190a16d66849493630a43f7dce3e8ae2786b38972f84b992cf3f2081995eb4e01c0d72ee47e0b378b49d844dd5883b561db40831f28d20abbff053
+  data.tar.gz: d81cddd57a426da87b14b4df0b2b212926e0c5b8405be8d103aa518348d4f65f0d8689bf066b6cf189d85e704b77c9929e874fbe6be9318579e6f6651ee85159

data/lib/semantic_logger.rb

@@ -16,6 +16,7 @@ module SemanticLogger
     autoload :Syslog,   'semantic_logger/appender/syslog'
     autoload :NewRelic, 'semantic_logger/appender/new_relic'
     autoload :Splunk,   'semantic_logger/appender/splunk'
+    autoload :Bugsnag,   'semantic_logger/appender/bugsnag'
   end
 
   if defined?(JRuby)

data/lib/semantic_logger/appender/bugsnag.rb

@@ -0,0 +1,81 @@
+=begin
+Bugsnag appender for SemanticLogger
+
+Skips the fatal log level because unrescued exceptions get logged as fatal and will be reported automatically by Bugsnag.
+
+Note: Payload information is not filtered, so take care not to push any sensitive information when logging with tags or a payload.
+
+Example 1
+
+Adding the Bugsnag appender will send :error log entries to Bugsnag with the error severity.
+
+For a Rails application already configured to use SemanticLogger and Bugsnag, create a file called <Rails Root>/config/initializers/bugsnag_appender.rb with the following contents and restart the application:
+
+# Send :error and log messages to Bugsnag
+SemanticLogger.add_appender(SemanticLogger::Appender::Bugsnag.new)
+Rails.logger.info 'SemanticLogger Bugsnag Appender added.'
+
+Example 2
+
+For a non-Rails application, send :info and more severe log entries to a file called application.log and also send :error log entries to Bugsnag.
+
+require 'semantic_logger'
+require 'bugsnag'
+
+# Bugsnag setup
+Bugsnag.configure do |config|
+  config.api_key = 'abc123'
+end
+
+# SemanticLogger setup
+SemanticLogger.default_level = :info
+SemanticLogger.add_appender('application.log')
+SemanticLogger.add_appender(SemanticLogger::Appender::Bugsnag.new)
+logger = SemanticLogger['Example']
+
+# Log some messages
+logger.info  'This is only written to application.log'
+logger.error 'This is written to application.log and will also be sent to Bugsnag as an error event'
+
+# The appender will send payloads to Bugsnag
+logger.error 'Something bad happened', info: 'Related information'
+=end
+
+require 'bugsnag'
+
+class SemanticLogger::Appender::Bugsnag < SemanticLogger::Appender::Base
+  # Allow the level for this appender to be overwritten
+  #   Default: :error
+  #   Note: Not recommended to set the log level to :info, :debug, or :trace as that would flood Bugsnag with Error notices
+  def initialize(level = :error, &block)
+    super(level, &block)
+  end
+
+  # Returns [Hash] of parameters to send to Bugsnag.
+  def default_formatter
+    proc do |log|
+      { :severity => log_level(log), tags: log.tags }.merge(log.payload || {})
+    end
+  end
+
+  # Send an error notification to Bugsnag
+  def log(log)
+    # Only log if level is warn, or error.
+    # We don't want to send fatal as those are already captured by Bugsnag.
+    return false if (level_index > (log.level_index || 0)) || !include_message?(log)
+    return false if log.level == :fatal
+    # Ignore logs coming from Bugsnag itself
+    return false if log.message.to_s.include?(Bugsnag::LOG_PREFIX)
+
+    # For more documentation on the Bugsnag.notify method see:
+    # https://bugsnag.com/docs/notifiers/ruby#sending-handled-exceptions
+    Bugsnag.notify(log.exception || log.message, formatter.call(log))
+    true
+  end
+
+  private
+
+  def log_level(log)
+    log.level.to_s.gsub('warn', 'warning')
+  end
+end

data/lib/semantic_logger/loggable.rb

@@ -31,9 +31,7 @@ module SemanticLogger
 
     def self.included(base)
       base.class_eval do
-        # Thread safe class variable initialization
-        include SyncAttr
-
+        # Thread safe logger class variable initializer
         sync_cattr_reader :logger do
           SemanticLogger[self]
         end

data/lib/semantic_logger/semantic_logger.rb

@@ -196,10 +196,17 @@ module SemanticLogger
     end if log_level_signal
 
     Signal.trap(thread_dump_signal) do
-      logger = SemanticLogger['Ruby Thread Dump']
+      logger = SemanticLogger['Thread Dump']
       Thread.list.each do |thread|
-        backtrace = thread.backtrace ? thread.backtrace.join("\n") : ''
-        logger.warn "#{thread.name}\n#{backtrace}"
+        next if thread == Thread.current
+        message = thread.name
+        if backtrace = thread.backtrace
+          message += "\n"
+          message << backtrace.join("\n")
+        end
+        tags = thread[:semantic_logger_tags]
+        tags = tags.nil? ? [] : tags.clone
+        logger.tagged(tags) { logger.warn(message) }
       end
     end if thread_dump_signal
 

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "2.13.1"
+  VERSION = "2.14.0"
 end

data/test/appender_bugsnag_test.rb

@@ -0,0 +1,61 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'test_helper'
+
+# Unit Test for SemanticLogger::Appender::Bugsnag
+#
+class AppenderBugsnagTest < Minitest::Test
+  context SemanticLogger::Appender::Bugsnag do
+    setup do
+      @appender = SemanticLogger::Appender::Bugsnag.new(:warn)
+      @message  = 'AppenderBugsnagTest log message'
+    end
+
+    (SemanticLogger::LEVELS - [:warn, :error]).each do |level|
+      should "not send :#{level} notifications to Bugsnag" do
+        message = hash = nil
+        Bugsnag.stub(:notify, -> msg, h { message = msg; hash = h }) do
+          @appender.send(level, "AppenderBugsnagTest #{level.to_s} message")
+        end
+        assert_nil message
+        assert_nil hash
+      end
+    end
+
+    should "send error notifications to Bugsnag with severity" do
+      message = hash = nil
+      Bugsnag.stub(:notify, -> msg, h { message = msg; hash = h }) do
+        @appender.error @message
+      end
+      assert_equal @message, message
+      assert_equal 'error', hash[:severity]
+    end
+
+    should 'send warn notifications to Bugsnag replace warn severity with warning' do
+      message = hash = nil
+      Bugsnag.stub(:notify, -> msg, h { message = msg; hash = h }) do
+        @appender.warn @message
+      end
+      assert_equal @message, message
+      assert_equal 'warning', hash[:severity]
+    end
+
+    should 'send notification to Bugsnag with custom attributes' do
+      message = hash = nil
+      Bugsnag.stub(:notify, -> msg, h { message = msg; hash = h }) do
+        @appender.error @message, {:key1 => 1, :key2 => 'a'}
+      end
+      assert_equal @message, message
+      assert_equal(1, hash[:key1], hash)
+      assert_equal('a', hash[:key2], hash)
+    end
+
+    should 'send notification to Bugsnag with exception' do
+      message = hash = nil
+      error = RuntimeError
+      Bugsnag.stub(:notify, -> msg, h { message = msg; hash = h }) do
+        @appender.error error
+      end
+      assert_equal error, message
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 2.13.1
+  version: 2.14.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sync_attr
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thread_safe
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 description: Next generation logging system for Ruby to support highly concurrent,
-  high throughput, low latency systems
+  high throughput, low latency enterprise systems
 email:
 - reidmo@gmail.com
 executables: []
@@ -49,10 +49,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/LogGC.java
-- lib/LogGC_1.java
 - lib/semantic_logger.rb
 - lib/semantic_logger/appender/base.rb
+- lib/semantic_logger/appender/bugsnag.rb
 - lib/semantic_logger/appender/file.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/new_relic.rb
@@ -67,6 +66,7 @@ files:
 - lib/semantic_logger/logger.rb
 - lib/semantic_logger/semantic_logger.rb
 - lib/semantic_logger/version.rb
+- test/appender_bugsnag_test.rb
 - test/appender_file_test.rb
 - test/appender_mongodb_test.rb
 - test/appender_new_relic_test.rb
@@ -99,11 +99,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Scalable, next generation logging for Ruby
+summary: Scalable, next generation enterprise logging for Ruby
 test_files:
+- test/appender_bugsnag_test.rb
 - test/appender_file_test.rb
 - test/appender_mongodb_test.rb
 - test/appender_new_relic_test.rb

data/lib/LogGC.java

@@ -1,26 +0,0 @@
-            //get all the info and pretty print it
-            duration =
-            //System.out.println("GcInfo CompositeType: " + info.getGcInfo().getCompositeType());
-            //System.out.println("GcInfo MemoryUsageAfterGc: " + info.getGcInfo().getMemoryUsageAfterGc());
-            //System.out.println("GcInfo MemoryUsageBeforeGc: " + info.getGcInfo().getMemoryUsageBeforeGc());
-
-            //Get the information about each memory space, and pretty print it
-            Map<String, MemoryUsage> membefore = info.getGcInfo().getMemoryUsageBeforeGc();
-            Map<String, MemoryUsage> mem = info.getGcInfo().getMemoryUsageAfterGc();
-            for (Entry<String, MemoryUsage> entry : mem.entrySet()) {
-              String name = entry.getKey();
-              MemoryUsage memdetail = entry.getValue();
-              long memInit = memdetail.getInit();
-              long memCommitted = memdetail.getCommitted();
-              long memMax = memdetail.getMax();
-              long memUsed = memdetail.getUsed();
-              MemoryUsage before = membefore.get(name);
-              long beforepercent = ((before.getUsed() * 1000L) / before.getCommitted());
-              long percent = ((memUsed * 1000L) / before.getCommitted()); //>100% when it gets expanded
-
-              System.out.print(name + (memCommitted == memMax ? "(fully expanded)" : "(still expandable)") + "used: " + (beforepercent / 10) + "." + (beforepercent % 10) + "%->" + (percent / 10) + "." + (percent % 10) + "%(" + ((memUsed / 1048576) + 1) + "MB) / ");
-            }
-            System.out.println();
-            totalGcDuration += info.getGcInfo().getDuration();
-            long percent = totalGcDuration * 1000L / info.getGcInfo().getEndTime();
-            System.out.println("GC cumulated overhead " + (percent / 10) + "." + (percent % 10) + "%");

data/lib/LogGC_1.java

@@ -1,68 +0,0 @@
-//
-// http://docs.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/GarbageCollectionNotificationInfo.html
-public class LogGC {
-
-  public static void installGCMonitoring() {
-    //get all the GarbageCollectorMXBeans - there's one for each heap generation
-    //so probably two - the old generation and young generation
-    List<GarbageCollectorMXBean> gcbeans = java.lang.management.ManagementFactory.getGarbageCollectorMXBeans();
-    //Install a notifcation handler for each bean
-    for (GarbageCollectorMXBean gcbean : gcbeans) {
-      System.out.println(gcbean);
-      NotificationEmitter emitter = (NotificationEmitter) gcbean;
-      //use an anonymously generated listener for this example
-      // - proper code should really use a named class
-      NotificationListener listener = new NotificationListener() {
-        //keep a count of the total time spent in GCs
-        long totalGcDuration = 0;
-
-        //implement the notifier callback handler
-        @Override
-        public void handleNotification(Notification notification, Object handback) {
-          //we only handle GARBAGE_COLLECTION_NOTIFICATION notifications here
-          if (notification.getType().equals(GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION)) {
-            //get the information associated with this notification
-            GarbageCollectionNotificationInfo info = GarbageCollectionNotificationInfo.from((CompositeData) notification.getUserData());
-            //get all the info and pretty print it
-            long duration = info.getGcInfo().getDuration();
-            String gctype = info.getGcAction();
-            if ("end of minor GC".equals(gctype)) {
-              gctype = "Young Gen GC";
-            } else if ("end of major GC".equals(gctype)) {
-              gctype = "Old Gen GC";
-            }
-            System.out.println();
-            System.out.println(gctype + ": - " + info.getGcInfo().getId() + " " + info.getGcName() + " (from " + info.getGcCause() + ") " + duration + " microseconds; start-end times " + info.getGcInfo().getStartTime() + "-" + info.getGcInfo().getEndTime());
-            //System.out.println("GcInfo CompositeType: " + info.getGcInfo().getCompositeType());
-            //System.out.println("GcInfo MemoryUsageAfterGc: " + info.getGcInfo().getMemoryUsageAfterGc());
-            //System.out.println("GcInfo MemoryUsageBeforeGc: " + info.getGcInfo().getMemoryUsageBeforeGc());
-
-            //Get the information about each memory space, and pretty print it
-            Map<String, MemoryUsage> membefore = info.getGcInfo().getMemoryUsageBeforeGc();
-            Map<String, MemoryUsage> mem = info.getGcInfo().getMemoryUsageAfterGc();
-            for (Entry<String, MemoryUsage> entry : mem.entrySet()) {
-              String name = entry.getKey();
-              MemoryUsage memdetail = entry.getValue();
-              long memInit = memdetail.getInit();
-              long memCommitted = memdetail.getCommitted();
-              long memMax = memdetail.getMax();
-              long memUsed = memdetail.getUsed();
-              MemoryUsage before = membefore.get(name);
-              long beforepercent = ((before.getUsed() * 1000L) / before.getCommitted());
-              long percent = ((memUsed * 1000L) / before.getCommitted()); //>100% when it gets expanded
-
-              System.out.print(name + (memCommitted == memMax ? "(fully expanded)" : "(still expandable)") + "used: " + (beforepercent / 10) + "." + (beforepercent % 10) + "%->" + (percent / 10) + "." + (percent % 10) + "%(" + ((memUsed / 1048576) + 1) + "MB) / ");
-            }
-            System.out.println();
-            totalGcDuration += info.getGcInfo().getDuration();
-            long percent = totalGcDuration * 1000L / info.getGcInfo().getEndTime();
-            System.out.println("GC cumulated overhead " + (percent / 10) + "." + (percent % 10) + "%");
-          }
-        }
-      };
-
-      //Add the listener
-      emitter.addNotificationListener(listener, null, null);
-    }
-  }
-}