sapience 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea749d1ada692854bed97d475a890a6d61b02b5f
-  data.tar.gz: 13638a31642a02168905af47c08b7270b1da27be
+  metadata.gz: 0bbf1f419c40131407dc53eccc467636462c6627
+  data.tar.gz: 2556a1353dfc63228882845c6515b186ef9c7fb4
 SHA512:
-  metadata.gz: 78554ecb82c2aab624b3d1c176ee321c67d642e0c40b25f72a85a029695375e6b391a04fe528a5fe4d9f935123c3451e6cc55249071720a4959e7b54015a07ec
-  data.tar.gz: 81213f5fec58b6653d66e00bf96774e4dcbb265b63b7be0d0ff542fbd69424b3e4a7090cadf9bfbe8dc80caa96aba205dbbe0baecf5e81a814c8203eba5fd65c
+  metadata.gz: 2cbd70840bd75008f69b8501dc12dd1dc4b64f7fc338beff143a2ea4bba3f9358a298e1b84d34bc32124b38a8b7f84e3f5b0ca6230a772ebb5d1a51332ecfde7
+  data.tar.gz: 9101d5a36a37c8061eea06d930c2a55161ca2d44d75c687d7e5a9d48127dd81ceeebac358e8d0859db9887455da361adc71daac6af5111621cd877fc1e3132b0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.0.2
+
+- Require `app_name` to be configured. Either set it with the environment variable `SAPIENCE_APP_NAME` or provided it when configuring the application.
+- Fixes problems with Datadog namespace always being nil.
+
 ## v1.0.1
 
 - Fix loading configuration outside of Rack application

data/README.md

@@ -52,11 +52,13 @@ end
 
 The sapience configuration can be controlled by a `config/sapience.yml` file or if you like us have many projects that use the same configuration you can create your own gem with a shared config. Have a look at [reevoo/reevoo_sapience-rb](https://github.com/reevoo/reevoo_sapience-rb)
 
+The `app_name` is required to be configured. Sapience will fail on startup if app_name isn't configured properly.
+
 ```ruby 
 Sapience.configure do |config|
   config.default_level   = :info
   config.backtrace_level = :error
-  config.application     = "my-app"
+  config.app_name        = "my_app"
   config.appenders       = [
     { stream: { io: STDOUT, formatter: :color } },
     { sentry: { dsn: "https://username:password@app.getsentry.com/00000" } },
@@ -200,6 +202,11 @@ Formatters can be specified by using the key `formatter: :camelized_formatter_na
 
 `bin/tests`
 
+## Environment variables
+
+`SAPIENCE_APP_NAME` - If you want to provide an application name for sapience
+`SAPIENCE_ENV` - For applications that don't use rack or rails
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/reevoo/sapience. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/docker-compose.yml

@@ -56,6 +56,7 @@ services:
     depends_on:
       - rabbitmq
     environment:
+      SAPIENCE_APP_NAME: rails_app
       AMQP: amqp://sapience:tests@rabbitmq:5672
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 
@@ -68,4 +69,5 @@ services:
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rspec
     environment:
+      SAPIENCE_APP_NAME: grape_app
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

data/lib/sapience/appender/datadog.rb

@@ -38,12 +38,7 @@ module Sapience
       end
 
       def provider
-        @_provider ||= begin
-          statsd           = ::Datadog::Statsd.new(@uri.host, @uri.port, tags: @tags)
-          path             = @uri.path.chomp("/")
-          statsd.namespace = path.sub("/", "") if path != ""
-          statsd
-        end
+        @_provider ||= ::Datadog::Statsd.new(@uri.host, @uri.port, dog_options)
       end
 
       # Send an error notification to sentry
@@ -109,6 +104,19 @@ module Sapience
       def event(title, text, options = {})
         provider.event(title, text, options)
       end
+
+      def namespace
+        ns = Sapience.app_name
+        ns << ".#{Sapience.environment}" if Sapience.environment
+        ns
+      end
+
+      def dog_options
+        {
+          namespace: namespace,
+          tags: @tags,
+        }
+      end
     end
   end
 end

data/lib/sapience/appender/sentry.rb

@@ -35,9 +35,9 @@ module Sapience
       #     Name of this host to appear in log messages.
       #     Default: Sapience.config.host
       #
-      #   application: [String]
+      #   app_name: [String]
       #     Name of this application to appear in log messages.
-      #     Default: Sapience.config.application
+      #     Default: Sapience.app_name
       def initialize(options = {}, &block)
         validate_options!(options)
 
@@ -46,7 +46,6 @@ module Sapience
           config.dsn  = options.delete(:dsn)
           config.tags = { environment: Sapience.environment }
         end
-
         super(options, &block)
       end
 
@@ -57,10 +56,11 @@ module Sapience
       end
 
       # Send an error notification to sentry
-      def log(log)
+      def log(log) # rubocop:disable AbcSize
         return false unless should_log?(log)
 
         context = formatter.call(log, self)
+
         if log.exception
           context.delete(:exception)
           Raven.capture_exception(log.exception, context)

data/lib/sapience/base.rb

@@ -150,9 +150,8 @@ module Sapience
       Sapience::Formatters::Default.new
     end
 
-    # Allow application name to be set globally or per subscriber
-    def application
-      Sapience.config.application
+    def app_name
+      Sapience.app_name
     end
 
     # Allow host name to be set globally or per subscriber

data/lib/sapience/configuration.rb

@@ -8,12 +8,11 @@ module Sapience
   class Configuration
     attr_reader :default_level, :backtrace_level, :backtrace_level_index
     attr_writer :host
-    attr_accessor :application, :ap_options, :appenders, :log_executor
+    attr_accessor :app_name, :ap_options, :appenders, :log_executor
 
     SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
       log_level:   :info,
-      application: "Sapience",
       host:        nil,
       ap_options:  { multiline: false },
       appenders:   [{ stream: { io: STDOUT, formatter: :color } }],
@@ -28,8 +27,8 @@ module Sapience
       validate_log_executor!(@options[:log_executor])
       self.default_level   = @options[:log_level].to_sym
       self.backtrace_level = @options[:log_level].to_sym
-      self.application     = @options[:application]
       self.host            = @options[:host]
+      self.app_name        = @options[:app_name]
       self.ap_options      = @options[:ap_options]
       self.appenders       = @options[:appenders]
       self.log_executor    = @options[:log_executor]

data/lib/sapience/formatters/raw.rb

@@ -4,7 +4,7 @@ module Sapience
     class Raw < Base
       # Returns log messages in Hash format
       def call(log, logger)
-        log.to_h(log_host ? logger.host : nil, log_application ? logger.application : nil)
+        log.to_h(log_host ? logger.host : nil, log_application ? logger.app_name : nil)
       end
     end
   end

data/lib/sapience/log.rb

@@ -153,7 +153,7 @@ module Sapience
     end
 
     # Returns [Hash] representation of this log entry
-    def to_h(host = Sapience.config.host, application = Sapience.config.application) # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity, LineLength
+    def to_h(host = Sapience.config.host, app_name = Sapience.app_name) # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity, LineLength
       # Header
       h               = {
         name:        name,
@@ -163,9 +163,9 @@ module Sapience
         level:       level,
         level_index: level_index,
       }
-      h[:host]        = host if host
-      h[:application] = application if application
-      file, line      = file_name_and_line
+      h[:host]     = host if host
+      h[:app_name] = app_name if app_name
+      file, line   = file_name_and_line
       if file
         h[:file] = file
         h[:line] = line.to_i

data/lib/sapience/sapience.rb

@@ -8,7 +8,7 @@ require "English"
 # Sapience.configure do |config|
 #   config.default_level   = ENV.fetch('SAPIENCE_DEFAULT_LEVEL') { :info }.to_sym
 #   config.backtrace_level = ENV.fetch('SAPIENCE_BACKTRACE_LEVEL') { :info }.to_sym
-#   config.application     = 'TestApplication'
+#   config.app_name        = 'TestApplication'
 #   config.host            = ENV.fetch('SAPIENCE_HOST', nil)
 #   config.ap_options      = { multiline: false }
 #   config.appenders       = [
@@ -20,12 +20,18 @@ require "English"
 
 # rubocop:disable ClassVars
 module Sapience
-  UnknownClass = Class.new(NameError)
+  UnknownClass   = Class.new(NameError)
+  AppNameMissing = Class.new(NameError)
+  TestException  = Class.new(StandardError)
   @@configured = false
 
   # Logging levels in order of most detailed to most severe
   LEVELS = [:trace, :debug, :info, :warn, :error, :fatal].freeze
-  DEFAULT_ENV = "default".freeze
+  DEFAULT_ENV       = "default".freeze
+  RACK_ENV          = "RACK_ENV".freeze
+  RAILS_ENV         = "RAILS_ENV".freeze
+  SAPIENCE_APP_NAME = "SAPIENCE_APP_NAME".freeze
+  SAPIENCE_ENV      = "SAPIENCE_ENV".freeze
 
   # TODO: Should we really always read from file?
   # What if someone wants to configure sapience with a block
@@ -44,7 +50,9 @@ module Sapience
   end
 
   def self.default_options(options = {})
-    warn "No configuration for environment #{environment}. Using 'default'"
+    unless environment =~ /default|rspec/
+      warn "No configuration for environment #{environment}. Using 'default'"
+    end
     options[DEFAULT_ENV]
   end
 
@@ -52,6 +60,8 @@ module Sapience
     @@config = nil
     @@logger = nil
     @@metrics = nil
+    @@environment = nil
+    @@app_name = nil
     @@configured = false
     clear_tags!
     reset_appenders!
@@ -61,23 +71,56 @@ module Sapience
     @@appenders = Concurrent::Array.new
   end
 
+  # TODO: Default to SAPIENCE_ENV (if present it should be returned first)
   def self.environment
-    ENV.fetch("RAILS_ENV") do
-      ENV.fetch("RACK_ENV") do
-        if defined?(::Rails) && ::Rails.respond_to?(:env)
-          ::Rails.env
-        else
-          puts "Sapience is going to use default configuration"
-          DEFAULT_ENV
+    @@environment ||=
+      ENV.fetch(SAPIENCE_ENV) do
+        ENV.fetch(RAILS_ENV) do
+          ENV.fetch(RACK_ENV) do
+            if defined?(::Rails) && ::Rails.respond_to?(:env)
+              ::Rails.env
+            else
+              warn "Sapience is going to use default configuration"
+              DEFAULT_ENV
+            end
+          end
         end
       end
+  end
+
+  def self.app_name
+    @@app_name ||= begin
+      appname = ENV.fetch(SAPIENCE_APP_NAME) do
+        config.app_name
+      end
+      namify(appname)
     end
   end
 
+  def self.namify(appname, sep = "_")
+    return unless appname.is_a?(String)
+    return unless appname.length > 0
+
+    # Turn unwanted chars into the separator
+    appname = appname.dup
+    appname.gsub!(/[^a-z0-9\-_]+/i, sep)
+    unless sep.nil? || sep.empty?
+      re_sep = Regexp.escape(sep)
+      # No more than one of the separator in a row.
+      appname.gsub!(/#{re_sep}{2,}/, sep)
+      # Remove leading/trailing separator.
+      appname.gsub!(/^#{re_sep}|#{re_sep}$/, "")
+    end
+    appname.downcase
+  end
+  private_class_method :namify
+
+
   # TODO: Maybe when configuring with a block we should create a new config?
   # See the TODO note on .config for more information
   def self.configure(force: false)
     yield config if block_given?
+    fail AppNameMissing, "app_name is not configured. See documentation for more information" unless app_name
     return config if configured? && force == false
     reset_appenders!
     add_appenders(*config.appenders)
@@ -249,7 +292,9 @@ module Sapience
   end
 
   def self.test_exception(level = :error)
-    Sapience[self].public_send(level, Exception.new("Sapience Test Exception"))
+    fail Sapience::TestException, "Sapience Test Exception"
+  rescue Sapience::TestException => ex
+    Sapience[self].public_send(level, ex)
   end
 
   # Wait until all queued log messages have been written and flush all active

data/lib/sapience/subscriber.rb

@@ -5,7 +5,7 @@ module Sapience
   class Subscriber < Sapience::Base
     # Every logger has its own formatter
     attr_accessor :formatter
-    attr_writer :application, :host
+    attr_writer :app_name, :host
 
     extend Sapience::Descendants
 
@@ -33,9 +33,9 @@ module Sapience
       Sapience::Formatters::Default.new
     end
 
-    # Allow application name to be set globally or per subscriber
-    def application
-      @application || Sapience.config.application
+    # Allow app_name to be set globally or per subscriber
+    def app_name
+      @app_name || Sapience.app_name
     end
 
     # Allow host name to be set globally or per subscriber
@@ -67,18 +67,18 @@ module Sapience
     #     Name of this host to appear in log messages.
     #     Default: Sapience.config.host
     #
-    #   application: [String]
-    #     Name of this application to appear in log messages.
-    #     Default: Sapience.config.application
+    #   app_name: [String]
+    #     Name of this app_name to appear in log messages.
+    #     Default: Sapience.app_name
     def initialize(options = {}, &block)
       # Backward compatibility
-      options      = { level: options } unless options.is_a?(Hash)
-      options      = options.dup
-      level        = options.delete(:level)
-      filter       = options.delete(:filter)
-      @formatter   = extract_formatter(options.delete(:formatter), &block)
-      @application = options.delete(:application)
-      @host        = options.delete(:host)
+      options     = { level: options } unless options.is_a?(Hash)
+      options     = options.dup
+      level       = options.delete(:level)
+      filter      = options.delete(:filter)
+      @formatter  = extract_formatter(options.delete(:formatter), &block)
+      @app_name   = options.delete(:app_name)
+      @host       = options.delete(:host)
       fail(ArgumentError, "Unknown options: #{options.inspect}") if options.size > 0
 
       # Subscribers don't take a class name, so use this class name if an subscriber

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.0)
+    sapience (1.0.1)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -54,7 +54,7 @@ GEM
     ice_nine (0.11.2)
     json (1.8.3)
     method_source (0.8.2)
-    minitest (5.9.0)
+    minitest (5.9.1)
     multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -137,4 +137,4 @@ DEPENDENCIES
   simplecov-json
 
 BUNDLED WITH
-   1.12.5
+   1.13.1

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.0)
+    sapience (1.0.1)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -53,7 +53,7 @@ GEM
     ice_nine (0.11.2)
     json (2.0.2)
     method_source (0.8.2)
-    minitest (5.9.0)
+    minitest (5.9.1)
     multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -134,4 +134,4 @@ DEPENDENCIES
   simplecov-json
 
 BUNDLED WITH
-   1.12.5
+   1.13.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mikael Henriksson