sapience 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a40c5a391a0e2ad10aa755042de77d26d213e054
-  data.tar.gz: 6b6a3e456552d94c7ee960a5e165a8758ad671f1
+  metadata.gz: a722559880d7ab264e869789ea245af17428cdc8
+  data.tar.gz: 0a5c1e3ef75a2dc780d8386ed9dcdef6d10bc930
 SHA512:
-  metadata.gz: 19e50f5df3d0c2e851be3c83bffe2531f7d6307076944d074674a064bb840704645290212ac07bef382560cc39ad3228d805248b1a05933f82e6119db95123ce
-  data.tar.gz: f657142dd62de8b75a2ae17794956a6906f2fbf784b38e29e39e7505c592489483abc1cbfef61761868ce952379820a4070b69850e1201ef036c5924729507dd
+  metadata.gz: 09475a5b6fd7e09dc0c4a0aee0104564aeb47fe871e4663c33676081dc259e68f6c1dbf2dd97e29e79bbf287ae35bf7dec6c7f6d41e7808e426305b6eca3b15c
+  data.tar.gz: daf34c9424b3df997775e6196b4b3d500bb56071e366c061983553aa9e491a6fbc0ba795764e73d19ad2549c36aa4437b18204e386dc1021755cba3bebb22b81

data/lib/sapience/appender/datadog.rb

@@ -11,6 +11,8 @@ end
 module Sapience
   module Appender
     class Datadog < Sapience::Subscriber
+      VALIDATION_MESSAGE = "Statsd only supports udp. Example: 'udp://localhost:8125'".freeze
+
       # Create Appender
       #
       # Parameters:
@@ -32,7 +34,6 @@ module Sapience
         url   = options.delete(:url) || "udp://localhost:8125"
         @tags = options.delete(:tags)
         @uri  = URI.parse(url)
-        fail('Statsd only supports udp. Example: "udp://localhost:8125"') if @uri.scheme != "udp"
         super(options, &block)
       end
 
@@ -40,8 +41,13 @@ module Sapience
         @_provider ||= ::Datadog::Statsd.new(@uri.host, @uri.port, dog_options)
       end
 
+      def valid?
+        @uri.scheme == "udp"
+      end
+
       # Send an error notification to sentry
       def log(log)
+        return false unless valid?
         metric = log.metric
         return false unless metric
 
@@ -58,33 +64,41 @@ module Sapience
         if block_given?
           start = Time.now
           yield
+          return false unless valid?
           provider.timing(metric, ((Time.now - start) * 1000).floor, options)
         else
+          return false unless valid?
           provider.timing(metric, duration, options)
         end
       end
 
       def increment(metric, options = {})
+        return false unless valid?
         provider.increment(metric, options)
       end
 
       def decrement(metric, options = {})
+        return false unless valid?
         provider.decrement(metric, options)
       end
 
       def histogram(metric, amount, options = {})
+        return false unless valid?
         provider.histogram(metric, amount, options)
       end
 
       def gauge(metric, amount, options = {})
+        return false unless valid?
         provider.gauge(metric, amount, options)
       end
 
       def count(metric, amount, options = {})
+        return false unless valid?
         provider.count(metric, amount, options)
       end
 
       def time(metric, options = {}, &block)
+        return false unless valid?
         provider.time(metric, options, &block)
       end
 
@@ -93,6 +107,7 @@ module Sapience
       end
 
       def event(title, text, options = {})
+        return false unless valid?
         provider.event(title, text, options)
       end
 

data/lib/sapience/appender/sentry.rb

@@ -13,6 +13,8 @@ end
 module Sapience
   module Appender
     class Sentry < Sapience::Subscriber
+      VALIDATION_MESSAGE = "DSN is not valid, please add appender with :dsn key or set SENTRY_DSN".freeze # rubocop:disable LineLength
+      URI_REGEXP = URI::DEFAULT_PARSER.regexp[:ABS_URI]
       # Create Appender
       #
       # Parameters
@@ -42,8 +44,9 @@ module Sapience
         validate_options!(options)
 
         options[:level] ||= :error
+        @sentry_dsn = options.delete(:dsn)
         Raven.configure do |config|
-          config.dsn  = options.delete(:dsn)
+          config.dsn = @sentry_dsn
           config.tags = { environment: Sapience.environment }
         end
         super(options, &block)
@@ -51,12 +54,19 @@ module Sapience
 
       def validate_options!(options = {})
         fail ArgumentError, "Options should be a Hash" unless options.is_a?(Hash)
-        dsn_valid = options[:dsn].to_s =~ URI::DEFAULT_PARSER.regexp[:ABS_URI]
-        fail ArgumentError, "The :dsn key (#{options[:dsn]}) is not a valid URI" unless dsn_valid
+      end
+
+      def valid?
+        (sentry_dsn =~ URI_REGEXP) != nil
+      end
+
+      def sentry_dsn
+        (@sentry_dsn || ENV["SENTRY_DSN"]).to_s
       end
 
       # Send an error notification to sentry
       def log(log) # rubocop:disable AbcSize
+        return false unless valid?
         return false unless should_log?(log)
 
         context = formatter.call(log, self)

data/lib/sapience/appender/stream.rb

@@ -5,7 +5,7 @@
 module Sapience
   module Appender
     class Stream < Sapience::Subscriber
-
+      VALIDATION_MESSAGE = "stream is not writable".freeze
       # Create a Stream Logger appender instance.
       #
       # Parameters
@@ -95,6 +95,10 @@ module Sapience
         @log
       end
 
+      def valid?
+        !@log.closed?
+      end
+
       def ensure_folder_exist
         return if ::File.exist?(@file_name)
 

data/lib/sapience/appender/wrapper.rb

@@ -55,6 +55,10 @@ module Sapience
       end
       # rubocop:enable LineLength
 
+      def valid?
+        !@logger.nil?
+      end
+
       # Pass log calls to the underlying Rails, log4j or Ruby logger
       #  trace entries are mapped to debug since :trace is not supported by the
       #  Ruby or Rails Loggers

data/lib/sapience/logger.rb

@@ -13,6 +13,7 @@ module Sapience
       return unless appender_thread
       appender_thread << lambda do
         Sapience.appenders.each do |appender|
+          next unless appender.valid?
           begin
             logger.trace "Appender thread: Flushing appender: #{appender.class.name}"
             appender.flush
@@ -30,13 +31,13 @@ module Sapience
       return unless appender_thread
       appender_thread << lambda do
         Sapience.appenders.each do |appender|
+          next unless appender.valid?
           begin
             close_appender(appender)
           rescue StandardError => exc
             logger.error "Appender thread: Failed to close appender: #{appender.inspect}", exc
           end
         end
-
         logger.trace "Appender thread: All appenders flushed"
       end
     end
@@ -70,6 +71,16 @@ module Sapience
       true
     end
 
+    def self.start_invalid_appenders_task
+      @@invalid_appenders_task = Concurrent::TimerTask.new(execution_interval: 120, timeout_interval: 5) do
+        Sapience.appenders.each do |appender|
+          next if appender.valid?
+          logger.warn { "#{appender.class} is not valid. #{appender::VALIDATION_MESSAGE}" }
+        end
+      end
+      invalid_appenders_task.execute
+    end
+
     # Returns true if the appender_thread is active
     def self.appender_thread_active?
       @@appender_thread && @@appender_thread.running?
@@ -82,6 +93,10 @@ module Sapience
       @@appender_thread
     end
 
+    def self.invalid_appenders_task
+      @@invalid_appenders_task
+    end
+
     # Allow the internal logger to be overridden from its default to STDERR
     #   Can be replaced with another Ruby logger or Rails logger, but never to
     #   Sapience::Logger itself since it is for reporting problems
@@ -122,6 +137,7 @@ module Sapience
       return add(log, message, progname, &block) unless log.is_a?(Sapience::Log)
       @@appender_thread << lambda do
         Sapience.appenders.each do |appender|
+          next unless appender.valid?
           begin
             appender.log(log)
           rescue StandardError => exc

data/lib/sapience/sapience.rb

@@ -208,27 +208,29 @@ module Sapience
   #   logger = Sapience['Example']
   #   logger.info "Hello World"
   #   logger.debug("Login time", user: 'Joe', duration: 100, ip_address: '127.0.0.1')
-  def self.add_appender(appender, options = {}, _deprecated_level = nil, &_block)
+  def self.add_appender(appender, options = {}, _deprecated_level = nil, &_block) # rubocop:disable AbcSize
     fail ArgumentError, "options should be a hash" unless options.is_a?(Hash)
     options = options.dup.deep_symbolize_keyz!
     appender_class = constantize_symbol(appender)
-    validate_appender!(appender_class)
+    validate_appender_class!(appender_class)
 
     appender       = appender_class.new(options)
+    warn "appender #{appender} with (#{options.inspect}) is not valid" unless appender.valid?
     @@appenders << appender
 
     # Start appender thread if it is not already running
     Sapience::Logger.start_appender_thread
+    Sapience::Logger.start_invalid_appenders_task
     Sapience.logger = appender if appender.is_a?(Sapience::Appender::Stream)
     Sapience.metrics = appender if appender.is_a?(Sapience::Appender::Datadog)
     appender
   end
 
-  def self.validate_appender!(appender)
-    return if known_appenders.include?(appender)
+  def self.validate_appender_class!(appender_class)
+    return if known_appenders.include?(appender_class)
 
     fail NotImplementedError,
-      "Unknown appender '#{appender}'. Supported appenders are (#{known_appenders.join(", ")})"
+      "Unknown appender '#{appender_class}'. Supported appenders are (#{known_appenders.join(", ")})"
   end
 
   def self.known_appenders

data/lib/sapience/subscriber.rb

@@ -19,6 +19,24 @@ module Sapience
       # NOOP
     end
 
+    # TODO: Implement this mehtod in all appenders
+    # TODO: Output relevant message when appender isn't valid
+    # TODO: Check this valid? method before using appender, output above error message if not valid?
+    # TODO: Wait with adding appenders until they are needed solve this by below
+    # TODO: Implement possibility of finding and deleting appenders by env
+    def valid?
+      fail NotImplementedError, "needs to be implemented in appender"
+    end
+
+    # TODO: Implement a format string with class name and interesting values
+    # see:
+    #   - https://www.rubysteps.com/articles/2015/customize-your-ruby-classes-with-to-s-and-inspect/
+    #   - http://stackoverflow.com/questions/9524698/override-to-s-while-keeping-output-of-inspect
+    #   - http://stackoverflow.com/questions/2625667/why-do-this-ruby-object-have-both-to-s-and-inspect-methods-that-appear-to-do-the
+    def to_s
+      name
+    end
+
     def name
       self.class.name
     end

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/test_apps/grape/gemfiles/grape_0.16.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.3)
+    sapience (1.0.5)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -22,7 +22,7 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
     coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
@@ -32,7 +32,7 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     dogstatsd-ruby (2.0.0)
-    enumerable-lazy (0.0.1)
+    enumerable-lazy (0.0.2)
     equalizer (0.0.11)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
@@ -81,7 +81,7 @@ GEM
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -94,7 +94,7 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     ruby-progressbar (1.8.1)
-    sentry-raven (2.0.1)
+    sentry-raven (2.0.2)
       faraday (>= 0.7.6, < 0.10.x)
     simplecov (0.12.0)
       docile (~> 1.1.0)

data/test_apps/grape/gemfiles/grape_0.17.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.3)
+    sapience (1.0.5)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -21,7 +21,7 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
     coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
@@ -31,7 +31,7 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     dogstatsd-ruby (2.0.0)
-    enumerable-lazy (0.0.1)
+    enumerable-lazy (0.0.2)
     equalizer (0.0.11)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
@@ -80,7 +80,7 @@ GEM
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -93,7 +93,7 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     ruby-progressbar (1.8.1)
-    sentry-raven (2.0.1)
+    sentry-raven (2.0.2)
       faraday (>= 0.7.6, < 0.10.x)
     simplecov (0.12.0)
       docile (~> 1.1.0)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby