sapience 0.1.1 → 0.1.2

data/lib/sapience/sapience.rb

@@ -12,7 +12,7 @@ require "socket"
 #   config.appenders       = [
 #     { file: { io: STDOUT, formatter: :color } },
 #     { statsd: { url: 'udp://localhost:2222' } },
-#     { sentry: { dsn: 'ASDFASDF' } },
+#     { sentry: { dsn: 'https://foobar:443' } },
 #   ]
 # end
 
@@ -27,17 +27,46 @@ module Sapience
   LEVELS = [:trace, :debug, :info, :warn, :error, :fatal]
 
   def self.config
-    @@config ||= Configuration.new
+    @@config ||= begin
+      config = ConfigLoader.load_from_file
+      env = config[environment]
+      unless env
+        puts "Missing configuration for #{environment} environment. Sapience is going to use default configuration"
+        env = config.fetch("default")
+      end
+      Configuration.new(env)
+    end
+  end
+
+  def self.reset!
+    @@config = nil
+    @@logger = nil
+    @@metrix = nil
+    reset_appenders!
+  end
+
+  def self.reset_appenders!
+    @@appenders = Concurrent::Array.new
+  end
+
+  def self.environment
+    ENV.fetch("RAILS_ENV") do
+      ENV.fetch("RACK_ENV") do
+        ::Rails.env if defined?(::Rails) && ::Rails.respond_to?(:env)
+      end
+    end
   end
 
   def self.configure
-    yield @@config
+    yield config if block_given?
 
     config.appenders.each do |appender|
       appender.each do |name, options|
         add_appender(name, options)
       end
     end
+
+    config
   end
 
   # Return a logger for the supplied class or class_name
@@ -123,24 +152,36 @@ 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)
     fail ArgumentError, "options should be a hash" unless options.is_a?(Hash)
+    options.deep_symbolize_keys!
     appender_class = constantize_symbol(appender)
     appender       = appender_class.new(options)
     @@appenders << appender
 
     # Start appender thread if it is not already running
     Sapience::Logger.start_appender_thread
-    Sapience::Logger.logger = appender if appender.is_a?(Sapience::Appender::File)
+    Sapience.logger = appender if appender.is_a?(Sapience::Appender::File)
+    Sapience.metrix = appender if appender.is_a?(Sapience::Appender::Datadog)
     appender
   end
 
+
   # Remove an existing appender
   # Currently only supports appender instances
+  # TODO: Make it possible to remove appenders by type
+  # Maybe create a concurrent collection that allows this by inheriting from concurrent array.
   def self.remove_appender(appender)
     @@appenders.delete(appender)
   end
 
+  # Remove specific appenders or all existing
+  def self.remove_appenders(appenders = @@appenders)
+    appenders.each do |appender|
+      remove_appender(appender)
+    end
+  end
+
   # Returns [Sapience::Subscriber] a copy of the list of active
   # appenders for debugging etc.
   # Use Sapience.add_appender and Sapience.remove_appender
@@ -149,6 +190,22 @@ module Sapience
     @@appenders.clone
   end
 
+  def self.metrix=(metrix)
+    @@metrix = metrix
+  end
+
+  def self.metrix
+    @@metrix ||= Sapience.add_appender(:datadog)
+  end
+
+  def self.logger=(logger)
+    @@logger = Sapience::Logger.logger = logger
+  end
+
+  def self.logger
+    @@logger ||= Sapience::Logger.logger
+  end
+
   # Wait until all queued log messages have been written and flush all active
   # appenders
   def self.flush
@@ -170,63 +227,6 @@ module Sapience
     Sapience::Logger.start_appender_thread
   end
 
-  # Add signal handlers for Sapience
-  #
-  # Two signal handlers will be registered by default:
-  #
-  # 1. Changing the log_level:
-  #
-  #   The log level can be changed without restarting the process by sending the
-  #   log_level_signal, which by default is 'USR2'
-  #
-  #   When the log_level_signal is raised on this process, the global default log level
-  #   rotates through the following log levels in the following order, starting
-  #   from the current global default level:
-  #     :warn, :info, :debug, :trace
-  #
-  #   If the current level is :trace it wraps around back to :warn
-  #
-  # 2. Logging a Ruby thread dump
-  #
-  #   When the signal is raised on this process, Sapience will write the list
-  #   of threads to the log file, along with their back-traces when available
-  #
-  #   It is recommended to name any threads you create in the application, by
-  #   calling the following from within the thread itself:
-  #      Thread.current.name = 'My Worker'
-  #
-  #
-  # Note:
-  #   To only register one of the signal handlers, set the other to nil
-  # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity
-  def self.add_signal_handler(log_level_signal = "USR2", thread_dump_signal = "TTIN", _gc_log_microseconds = 100_000)
-    Signal.trap(log_level_signal) do
-      index     = (default_level == :trace) ? LEVELS.find_index(:error) : LEVELS.find_index(default_level)
-      new_level = LEVELS[index - 1]
-      self["Sapience"].warn "Changed global default log level to #{new_level.inspect}"
-      self.default_level = new_level
-    end if log_level_signal
-
-    Signal.trap(thread_dump_signal) do
-      logger = Sapience["Thread Dump"]
-      Thread.list.each do |thread|
-        next if thread == Thread.current
-        message = thread.name
-        if (backtrace = thread.backtrace)
-          message += "\n"
-          message << backtrace.join("\n")
-        end
-        tags = thread[:sapience_tags]
-        tags = tags.nil? ? [] : tags.clone
-        logger.tagged(tags) { logger.warn(message) }
-      end
-    end if thread_dump_signal
-
-    true
-  end
-
-  # rubocop:enable AbcSize, CyclomaticComplexity, PerceivedComplexity
-
   # If the tag being supplied is definitely a string then this fast
   # tag api can be used for short lived tags
   def self.fast_tag(tag)
@@ -327,20 +327,21 @@ module Sapience
     Thread.current[:sapience_silence] = current_index
   end
 
-  private
-
-  @@appenders = Concurrent::Array.new
+  reset_appenders!
 
   def self.constantize_symbol(symbol, namespace = "Sapience::Appender")
     klass = "#{namespace}::#{camelize(symbol.to_s)}"
-    begin
-      if RUBY_VERSION.to_i >= 2
-        Object.const_get(klass)
-      else
-        klass.split("::").inject(Object) { |o, name| o.const_get(name) } # rubocop:disable SingleLineBlockParams
-      end
-    rescue NameError
-      raise(ArgumentError, "Could not convert symbol: #{symbol} to a class in: #{namespace}. Looking for: #{klass}")
+    constantize(klass)
+  rescue NameError
+    raise(ArgumentError, "Could not convert symbol: #{symbol} to a class in: #{namespace}. Looking for: #{klass}")
+  end
+
+  def self.constantize(class_name)
+    return class_name unless class_name.is_a?(String)
+    if RUBY_VERSION.to_i >= 2
+      Object.const_get(class_name)
+    else
+      class_name.split("::").inject(Object) { |o, name| o.const_get(name) } # rubocop:disable SingleLineBlockParams
     end
   end
 

data/lib/sapience/subscriber.rb

@@ -96,10 +96,13 @@ module Sapience
     # - Any object that responds to :call
     # - If none of the above apply, then the supplied block is returned as the formatter.
     # - Otherwise an instance of the default formatter is returned.
-    def extract_formatter(formatter, &block) # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable CyclomaticComplexity, AbcSize, PerceivedComplexity
+    def extract_formatter(formatter, &block)
       case
       when formatter.is_a?(Symbol)
         Sapience.constantize_symbol(formatter, "Sapience::Formatters").new
+      when formatter.is_a?(String)
+        Sapience.constantize_symbol(formatter, "Sapience::Formatters").new
       when formatter.is_a?(Hash) && formatter.size > 0
         fmt, options = formatter.first
         Sapience.constantize_symbol(fmt.to_sym, "Sapience::Formatters").new(options)
@@ -113,6 +116,7 @@ module Sapience
         default_formatter
       end
     end
+    # rubocop:enable CyclomaticComplexity, AbcSize, PerceivedComplexity
 
     SUBSCRIBER_OPTIONS = [:level, :formatter, :filter, :application, :host].freeze
 

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/sapience.rb

@@ -11,8 +11,11 @@ require "sapience/formatters/default"
 require "sapience/formatters/color"
 require "sapience/formatters/json"
 
+require "sapience/config_loader"
 require "sapience/configuration"
+require "sapience/configuration/grape"
 require "sapience/ansi_colors"
+require "sapience/core_ext/hash"
 require "sapience/core_ext/thread"
 require "sapience/base"
 require "sapience/log"
@@ -23,7 +26,7 @@ require "sapience/subscriber"
 require "sapience/appender/file"
 require "sapience/appender/sentry"
 require "sapience/appender/wrapper"
-require "sapience/appender/statsd"
+require "sapience/appender/datadog"
 
 # @formatter:on
 

data/sapience.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Mikael Henriksson", "Alex Malkov"]
   spec.email         = ["mika@reevoo.com", "alex.malkov@reevoo.com"]
 
-  spec.summary       = "Write a short summary, because Rubygems requires one."
-  spec.description   = "Write a longer description or delete this line."
-  spec.homepage      = "https://sapience.github.io"
+  spec.summary       = "Hasslefree autoconfiguration for logging, metrics and exception collection."
+  spec.description   = "Hasslefree autoconfiguration for logging, metrics and exception collection."
+  spec.homepage      = "https://github.com/reevoo/sapience"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "concurrent-ruby"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
@@ -36,4 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-json"
   spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "gem-release"
 end

data/test_app/Gemfile

@@ -14,7 +14,7 @@ gem "puma", "~> 3.0"
 
 # Use Capistrano for deployment
 # gem 'capistrano-rails', group: :development
-gem "sapience", path: "../"
+gem "sapience", path: "../", require: "sapience/rails"
 gem "sentry-raven"
 gem "statsd-ruby"
 
@@ -32,5 +32,9 @@ group :development do
   gem "listen", "~> 3.0.5"
 end
 
+group :test do
+  gem "rspec-its"
+end
+
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/test_app/Rakefile

@@ -1,6 +1,10 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
 require_relative "config/application"
 
 Rails.application.load_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/test_app/app/controllers/posts_controller.rb

@@ -24,7 +24,7 @@ class PostsController < ApplicationController
     @post = Post.new(post_params)
 
     if @post.save
-      redirect_to @post, notice: 'Post was successfully created.'
+      redirect_to @post, notice: "Post was successfully created."
     else
       render :new
     end
@@ -33,7 +33,7 @@ class PostsController < ApplicationController
   # PATCH/PUT /posts/1
   def update
     if @post.update(post_params)
-      redirect_to @post, notice: 'Post was successfully updated.'
+      redirect_to @post, notice: "Post was successfully updated."
     else
       render :edit
     end
@@ -42,17 +42,18 @@ class PostsController < ApplicationController
   # DELETE /posts/1
   def destroy
     @post.destroy
-    redirect_to posts_url, notice: 'Post was successfully destroyed.'
+    redirect_to posts_url, notice: "Post was successfully destroyed."
   end
 
   private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_post
-      @post = Post.find(params[:id])
-    end
 
-    # Only allow a trusted parameter "white list" through.
-    def post_params
-      params.require(:post).permit(:title, :body, :author_id)
-    end
+  # Use callbacks to share common setup or constraints between actions.
+  def set_post
+    @post = Post.find(params[:id])
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def post_params
+    params.require(:post).permit(:title, :body, :author_id)
+  end
 end

data/test_app/config/application.rb

@@ -9,7 +9,6 @@ require "action_controller/railtie"
 require "action_mailer/railtie"
 require "action_view/railtie"
 require "action_cable/engine"
-require "sapience/rails"
 # require "sprockets/railtie"
 # require "rails/test_unit/railtie"
 

data/test_app/spec/controllers/posts_controller_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require "rails_helper"
 
 RSpec.describe PostsController, type: :controller do
   specify do

data/test_app/spec/fixtures/sapience.yml

@@ -0,0 +1,14 @@
+---
+default:
+  log_level: error
+  appenders:
+    - file:
+        file_name: log/error.log
+        formatter: default
+
+test:
+  log_level: fatal
+  appenders:
+    - file:
+        file_name: log/fatal.log
+        formatter: json

data/test_app/spec/helpers/posts_helper_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require "rails_helper"
 
 # Specs in this file have access to a helper object that includes
 # the PostsHelper. For example:

data/test_app/spec/integration/sapience_spec.rb

@@ -0,0 +1,14 @@
+require "rails_helper"
+require "fileutils"
+
+describe Sapience, "rails integration", :integration do
+  context "with a sapience.yml present in config/" do
+    describe ".config" do
+      subject(:config) { Sapience.config }
+      its(:default_level) { is_expected.to eq(:fatal) }
+      its(:default_level_index) { is_expected.to eq(5) }
+      its(:backtrace_level) { is_expected.to eq(:fatal) }
+      its(:backtrace_level_index) { is_expected.to eq(5) }
+    end
+  end
+end

data/test_app/spec/models/post_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require "rails_helper"
 
 RSpec.describe Post, type: :model do
   pending "add some examples to (or delete) #{__FILE__}"

data/test_app/spec/models/user_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require "rails_helper"
 
 RSpec.describe User, type: :model do
   pending "add some examples to (or delete) #{__FILE__}"

data/test_app/spec/rails_helper.rb

@@ -5,6 +5,7 @@ require File.expand_path("../../config/environment", __FILE__)
 abort("The Rails environment is running in production mode!") if Rails.env.production?
 require "spec_helper"
 require "rspec/rails"
+require "rspec/its"
 
 Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
 
@@ -20,4 +21,18 @@ RSpec.configure do |config|
 
   config.infer_spec_type_from_file_location!
   config.filter_rails_from_backtrace!
+  config.before(:each) do
+    Sapience.reset!
+  end
+
+  config.before(:suite) do
+    FileUtils.cp(
+      Rails.root.join("spec/fixtures/sapience.yml"),
+      Rails.root.join("config/sapience.yml"),
+    )
+  end
+
+  config.after(:suite) do
+    FileUtils.rm(Rails.root.join("config/sapience.yml"))
+  end
 end

data/test_app/spec/requests/posts_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require "rails_helper"
 
 RSpec.describe "Posts", type: :request do
   describe "GET /posts" do

data/test_app/spec/routing/posts_routing_spec.rb

@@ -2,38 +2,36 @@ require "rails_helper"
 
 RSpec.describe PostsController, type: :routing do
   describe "routing" do
-
     it "routes to #index" do
-      expect(:get => "/posts").to route_to("posts#index")
+      expect(get: "/posts").to route_to("posts#index")
     end
 
     it "routes to #new" do
-      expect(:get => "/posts/new").to route_to("posts#new")
+      expect(get: "/posts/new").to route_to("posts#new")
     end
 
     it "routes to #show" do
-      expect(:get => "/posts/1").to route_to("posts#show", :id => "1")
+      expect(get: "/posts/1").to route_to("posts#show", id: "1")
     end
 
     it "routes to #edit" do
-      expect(:get => "/posts/1/edit").to route_to("posts#edit", :id => "1")
+      expect(get: "/posts/1/edit").to route_to("posts#edit", id: "1")
     end
 
     it "routes to #create" do
-      expect(:post => "/posts").to route_to("posts#create")
+      expect(post: "/posts").to route_to("posts#create")
     end
 
     it "routes to #update via PUT" do
-      expect(:put => "/posts/1").to route_to("posts#update", :id => "1")
+      expect(put: "/posts/1").to route_to("posts#update", id: "1")
     end
 
     it "routes to #update via PATCH" do
-      expect(:patch => "/posts/1").to route_to("posts#update", :id => "1")
+      expect(patch: "/posts/1").to route_to("posts#update", id: "1")
     end
 
     it "routes to #destroy" do
-      expect(:delete => "/posts/1").to route_to("posts#destroy", :id => "1")
+      expect(delete: "/posts/1").to route_to("posts#destroy", id: "1")
     end
-
   end
 end

data/test_app/spec/spec_helper.rb

@@ -7,54 +7,10 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
   config.filter_run_when_matching :focus
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
   config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  # Use the documentation formatter for detailed output,
-  # unless a formatter has already been configured
-  # (e.g. via a command-line flag).
   config.default_formatter = "doc" if config.files_to_run.one?
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  # config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
   Kernel.srand config.seed
 end