sapience 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b51a1bdbf72bc1ea60b09d75b32a6f78f0ed143
-  data.tar.gz: 87a7710812da15bc3cdb80eb2cdedd1681658cd8
+  metadata.gz: f84d8de78da549a144e13e50a0f34efbd7e26db0
+  data.tar.gz: b48b0a0375b29077acf0d67641e635d9d61c92c1
 SHA512:
-  metadata.gz: 25c9ac8836d07d4ec09623176e2b12b603be340073b7061f42d28e9378dfc853a8ea4fa667f31d2a544b3d7afe02508459f47759867f6a1dc32277862d18fb6b
-  data.tar.gz: a52fbcd6f66d607db46b44b074ff943b066a5fd88c5f03916745f395f9032334acd4839a9d612948fdd21e416e987beb424981ac6076f7e0d45935b7e02554d0
+  metadata.gz: c4dde48558b0a55c5206ac82c812cfa57ca564bb6ddd52bd995420d8de3b3052a0cc5b2bd6bc1240065495003f479900a7c7c2abbe9b571d75764041b9728f20
+  data.tar.gz: 758c6d40530957d4e0fa6448a0b2d827bca2f232a3f5eebefab4a73c86ced2406eebde5ea6b2981d13452a547ccfb3fc3f80383df78fbf9136c454542a123d24

data/.simplecov

@@ -1,13 +1,17 @@
 require "simplecov-json"
+require "codeclimate-test-reporter"
 require "coveralls"
-Coveralls.wear!
 
-SimpleCov.refuse_coverage_drop
+CodeClimate::TestReporter.start
+SimpleCov.maximum_coverage_drop 1
 
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::JSONFormatter,
+  CodeClimate::TestReporter::Formatter,
+  Coveralls::SimpleCov::Formatter,
 ]
+
 SimpleCov.start do
   add_filter "/spec/"
   add_filter "/bin/"

data/.travis.yml

@@ -1,27 +1,10 @@
-sudo: false
+sudo: required
 language: ruby
-cache: bundler
-before_install:
-  - rvm get head
-  - gem update --system
-  - gem install bundler
-install:
-  - bundle install -j8 -r3
+services:
+  - docker
 script:
-  - if [[ "${STYLE}" = "true" ]]; then bundle exec rake reevoocop; fi;
-  - bundle exec rspec spec
-rvm:
-  - jruby-9.0.5.0
-  - rbx-3.9
-  - 2.2.4
-env: STYLE=false
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: 2.3.1
-      env: STYLE=true
-
-addons:
-  code_climate:
-    repo_token:
+  - docker-compose run rspec
+  - docker-compose run test_app
+notifications:
+  slack:
+    secure: apFwkfBQ+3NDJgcLNCHQori9qtr6ePaN3Xx7Sy7NVWwYm9BHNxoX/FN8/hxR63JjXrf1C0hK0FLQ0TiA0BN9PgEEIecg78BvWUwMClDDiwhyYN3H0Bbg35PUFtgDIrOGpu/TYlxNmdHEDYEAxaWsl9wSds8pAJsN6m7VTjGfBwJUDcOiM4L1eRpbp7smPqOjmuQFuOJnO8YkPb+6nUfz53cJrMRUdha89Vgmvnw6cP4/Ms1TsL3vKmMSVbGGh/6WNKPjU6IbuUjwlsh6a9xWxQOk6Wnis/Z+kA+T0XbLMuTLLmzRDuql1tjJeMPi+wukmK1a7GjpPkpkzAgwLQ/CkjTBfIRbMyaBYSuAciuOY8PDtCcT4WLwEvdZbkFmhAdSr1RYxIBpONVfZ/5DT3bpk71+O74OIBqxG6NmkiZ0B6u9/KxbnIINLVAcVaqsN8sdSqWlWKzPm45BfGPXGjmGGgIVFU31rs+W5Zs7IYMNUjZxabYKIv9TsBONbogfbcoGZA+rWWUnQdjypNWJS9wyQDvJ4btxqy8YhDfaV6gF30Un5JcAggMutzKJiYi+qAeh0uN3/9XoXV2N6XBnh58h8ny1NY+0vklWhtFGR1wfFAqkDskvCIZabSeJ5bFM6FtNbNKq9tYciS+eAO1vEYQVDFt9eY2uZF2mFDKRnEegHMU=

data/CODE_OF_CONDUCT.md

@@ -35,7 +35,7 @@ This code of conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at mikael@zoolutions.se. All
+reported by contacting a project maintainer at developers@reevoo.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. Maintainers are
 obligated to maintain confidentiality with regard to the reporter of an

data/Gemfile

@@ -5,8 +5,8 @@ gemspec
 
 gem "pry-nav"
 gem "sentry-raven"
-gem "statsd-ruby"
-gem "minitest_to_rspec"
-gem "transpec"
-gem "codeclimate", require: false
-gem 'coveralls', require: false
+gem "dogstatsd-ruby"
+gem "rails", "~> 5.0.0.1"
+gem "grape"
+gem "active_model_serializers", "~> 0.10.0"
+gem "rspec-wait"

data/README.md

@@ -1,36 +1,167 @@
 # Sapience
 
-[![Code Climate](https://codeclimate.com/github/reevoo/sapience-rb/badges/gpa.svg)](https://codeclimate.com/github/reevoo/sapience-rb)[![Test Coverage](https://codeclimate.com/github/reevoo/sapience-rb/badges/coverage.svg)](https://codeclimate.com/github/reevoo/sapience-rb/coverage)[![Issue Count](https://codeclimate.com/github/reevoo/sapience-rb/badges/issue_count.svg)](https://codeclimate.com/github/reevoo/sapience-rb)
+**Hasslefree autoconfiguration for logging, metrics and exception collection.**
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sapience`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/reevoo/sapience-rb.svg?branch=TECH-4%2FConfiguration-DSL)](https://travis-ci.org/reevoo/sapience-rb)[![Code Climate](https://codeclimate.com/github/reevoo/sapience-rb/badges/gpa.svg)](https://codeclimate.com/github/reevoo/sapience-rb)[![Test Coverage](https://codeclimate.com/github/reevoo/sapience-rb/badges/coverage.svg)](https://codeclimate.com/github/reevoo/sapience-rb/coverage)[![Issue Count](https://codeclimate.com/github/reevoo/sapience-rb/badges/issue_count.svg)](https://codeclimate.com/github/reevoo/sapience-rb)
 
-TODO: Delete this and the text above, and describe your gem
+## Background
 
-## Installation
+We searched long and hard for a way to control our logging, error collection and metrics from a single place. The closest we could find that does everything we need is [Semantic Logger](https://github.com/rocketjob/semantic_logger). Unfortunately we couldn't find a good way to control the settings for our projects and would have had to spread our configuration over different initializers and rails configurations for each project. There was no easy way to gain that top level control over the configuration.
 
-Add this line to your application's Gemfile:
+This project aims to make it easier to centralize the configuration of these three areas by handling the configuration a little differently.
+
+We have taken a hug deal of inspiration from the amazing [Semantic Logger](https://github.com/rocketjob/semantic_logger) and implemented something similar to [Rubocop](https://github.com/bbatsov/rubocop) for handling and overriding how to find configuration. If you want some inspiration for how we do something similar for our projects for Rubocop check: [Reevoocop](https://github.com/reevoo/reevoocop).
+
+## Setup
+
+First of all we need to require the right file for the project. There are currently two frameworks supported (rails and grape).
+
+### Rails  
+
+```ruby
+gem "sapience-rb", require: "sapience/rails"
+```
+
+### Grape 
+
+```ruby
+gem "sapience-rb", require: "sapience/grape"
+```
+
+
+### Configuration
+
+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)
+
+```ruby 
+Sapience.configure do |config|
+  config.default_level   = :info
+  config.backtrace_level = :error
+  config.application     = "my-app"
+  config.appenders       = [
+    { file: { io: STDOUT, formatter: :color } },
+    { sentry: { dsn: "https://username:password@app.getsentry.com/00000" } },
+    { datadog: { url: "udp://localhost:8125" } },
+  ]
+end
+```
+
+Sapience provides a default configuration that will be used unless another file or configuration is specified. You can provide a custom 
+
+```yaml
+---
+default:
+  log_level: info
+  appenders:
+    - file:
+        io: STDOUT
+        formatter: color
+
+test:
+  log_level: warn
+  appenders:
+    - file:
+        file_name: log/test.log
+        formatter: color
+
+development:
+  log_level: debug
+  appenders:
+    - file:
+        file_name: log/development.log
+        formatter: color
+
+production:
+  log_level: warn
+  appenders:
+    - file:
+        file_name: log/production.log
+        formatter: json
+```
+
+## Appenders
+
+One of the things that did not suite us so well with the Semantic Logger approach was that they made a distinction between metrics and appenders. In our view anything that should potentially log something somewhere should be treated as an appender.
+
+There are a number of appenders that all listen to different events and act on its data. It is possible to specify the `level` and `backtrace_level` for each appender by providing (example) `level: :error` to the add_appender method.
+
+
+### File
+
+File appenders are basically a log stream. You can add as many file appenders as you like logging to different locations. 
+
+```ruby
+Sapience.add_appender(:file, file_name: "log/sapience.log", formatter: :json)
+Sapience.add_appender(:file, io: STDOUT, formatter: :color, level: :trace)
+```
+
+### Sentry
+
+The sentry appender handles sending errors to sentry. It's backtrace and log level can be configured by for instance `level: :info` and `backtrace_level: :debug`. The `level` configuration tells sentry to log starting at that level while the `backtrace_level` tells sentry to only collect backtrace starting at that level.
 
 ```ruby
-gem 'sapience'
+Sapience.add_appender(
+  :sentry, 
+  dsn: "https://username:password@app.getsentry.com/00000", 
+  level: :error, 
+  backtrace_level: :error
+)
 ```
 
-And then execute:
+### Datadog
+
+Datadog is a slightly modified version of statsd. On top of the standard statsd API it has support for events.
+
+```ruby
+Sapience.add_appender(:datadog, url: "udp://localhost:8125")
+```
+
+The appender will then be listening to anything that is logged with a `metric: "company/project/metric-name"` key. Details about the API can be found in [dogstatsd-ruby](https://github.com/DataDog/dogstatsd-ruby).
+
+The appender can also be used directly through: `Sapience.metrix`
+
+```ruby
+metrix = Sapience.metrix
+metrix.timing("company/project/metric-name", 100)
+metrix.increment("company/project/metric-name", 10)
+metrix.decrement("company/project/metric-name", 5)
+metrix.histogram("company/project/metric-name", 2_500)
+metrix.gauge("company/project/metric-name", 1_000, {})
+metrix.event("company/project/metric-name", "description about event", {})
+metrix.batch do 
+  metrix.event("company/project/metric-name", "description about event", {})
+  metrix.increment("company/project/another-metric-name", 2)
+end
+```
+
+
+### Wrapper
+
+The wrapper is useful when you already have a logger you want to use but want to use Sapience. The wrapper appender will when called use the logger provided to store the log data.
+
+```ruby
+Sapience.add_appender(:wrapper, logger: Logger.new(STDOUT))
+```
+
+## Formatters
+
+Formatters can be specified by using the key `formatter: :camelized_formatter_name`. **Note**: Only the File appender supports custom formatters.
 
-    $ bundle
+### Color
 
-Or install it yourself as:
+`formatter: :color` - gives colorized output. Useful for `test` and `development` environments.
 
-    $ gem install sapience
+### Default 
 
-## Usage
+`formatter: :default` - logs a string. Inspired by how access logs for Nginx are logged.
 
-TODO: Write usage instructions here
+### JSON 
 
-## Development
+`formatter: :json` - logs are saved as a single line json. Useful for production like environments.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### RAW 
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`formatter: :raw` - logs are saved as a single line ruby hash. Useful for production like environments and is used internally for the Sentry appender.
 
 ## Contributing
 

data/Rakefile

@@ -10,4 +10,5 @@ begin
   end
 rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
-task default: [:reevocop, :spec]
+
+task default: [:reevoocop, :spec]

data/config/default.yml

@@ -0,0 +1,29 @@
+---
+default:
+  log_level: info
+  appenders:
+    - file:
+        io: STDOUT
+        formatter: color
+
+test:
+  log_level: warn
+  appenders:
+    - file:
+        file_name: log/test.log
+        formatter: color
+
+development:
+  log_level: debug
+  appenders:
+    - file:
+        file_name: log/development.log
+        formatter: color
+
+production:
+  log_level: warn
+  appenders:
+    - file:
+        file_name: log/production.log
+        formatter: json
+

data/dev-entrypoint.sh

@@ -0,0 +1,10 @@
+#! /bin/bash
+
+# The Docker App Container's development entrypoint.
+# This is a script used by the project's Docker development environment to
+# setup the app containers and databases upon runnning.
+set -e
+
+# 5: Check or install the app dependencies via Bundler:
+bundle check || bundle install --jobs 8 --retry 5
+exec "$@"

data/docker-compose.yml

@@ -0,0 +1,42 @@
+version: '2'
+volumes:
+  gems:
+    driver: local
+
+services:
+  rails:
+    image: ruby:2.3
+    cpu_shares: 4
+    # Specify the directory from where all commands sent to the container will be
+    # issued to where the code is mounted:
+    working_dir: /usr/src/app
+
+    # Keep the stdin open, so we can attach to our app container's process
+    # and do things such as byebug, etc:
+    stdin_open: true
+
+    # Enable sending signals (CTRL+C, CTRL+P + CTRL+Q) into the container:
+    tty: true
+    volumes:
+      # Mount our app code directory (".") into our app containers at the
+      # "/usr/src/app" folder:
+      - .:/usr/src/app
+
+      # Mount the 'gems' volume on the folder that stores bundled gems:
+      - gems:/usr/local/bundle
+  rspec:
+    extends:
+      service: rails
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec rake
+    environment:
+      PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+  test_app:
+    extends:
+      service: rails
+    working_dir: /usr/src/app/test_app
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec rspec
+    environment:
+      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

@@ -0,0 +1,100 @@
+require "uri"
+begin
+  require "dogstatsd-ruby"
+rescue LoadError
+  raise 'Gem dogstatsd-ruby is required for logging metrics. Please add the gem "dogstatsd-ruby" to your Gemfile.'
+end
+
+# Example:
+#   Sapience.add_appender(:datadog, {url: "udp://localhost:2222"})
+#
+module Sapience
+  module Appender
+    class Datadog < Sapience::Subscriber
+      # Create Appender
+      #
+      # Parameters:
+      #   level: :trace
+      #   url: [String]
+      #     Valid URL to post to.
+      #     Example:
+      #       udp://localhost:8125
+      #     Example, send all metrics to a particular namespace:
+      #       udp://localhost:8125/namespace
+      #     Default: udp://localhost:8125
+      #   tags: [String]
+      #     Example:
+      #       tag1:true
+      # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity
+
+      def initialize(options = {}, &block)
+        fail("Options should be a Hash") unless options.is_a?(Hash)
+        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
+
+      def provider
+        @_provider ||= begin
+          statsd           = ::Statsd.new(@uri.host, @uri.port, tags: @tags)
+          path             = @uri.path.chomp("/")
+          statsd.namespace = path.sub("/", "") if path != ""
+          statsd
+        end
+      end
+
+      # Send an error notification to sentry
+      def log(log)
+        metric = log.metric
+        return false unless metric
+
+        if log.duration
+          timing(metric, log.duration)
+        else
+          amount = (log.metric_amount || 1).round
+          if amount < 0
+            decrement(metric, amount.abs)
+          else
+            increment(metric, amount)
+          end
+        end
+        true
+      end
+
+      def timing(metric, duration)
+        provider.timing(metric, duration)
+      end
+
+      def increment(metric, amount = 1)
+        provider.batch do
+          amount.times { provider.increment(metric) }
+        end
+      end
+
+      def decrement(metric, amount = 1)
+        provider.batch do
+          amount.times { provider.decrement(metric) }
+        end
+      end
+
+      def histogram(metric, amount)
+        provider.histogram(metric, amount)
+      end
+
+      def gauge(metric, amount, hash)
+        provider.gauge(metric, amount, hash)
+      end
+
+      def batch
+        yield provider
+      end
+
+      def event(title, text, options = {})
+        provider.event(title, text, options)
+      end
+    end
+  end
+end

data/lib/sapience/appender/file.rb

@@ -58,35 +58,24 @@ module Sapience
       #
       #    logger =  Sapience['test']
       #    logger.info 'Hello World'
-      def initialize(options = {}, deprecated_level = nil, deprecated_filter = nil, &block)
-        # Old style arguments: (file_name, level=nil, filter=nil, &block)
-        options =
-          if options.is_a?(Hash)
-            options.dup
-          else
-            file_name = options
-            opts      = {}
-            if file_name.respond_to?(:write) && file_name.respond_to?(:close)
-              opts[:io] = file_name
-            else
-              opts[:file_name] = file_name
-            end
-            opts[:level]  = deprecated_level if deprecated_level
-            opts[:filter] = deprecated_filter if deprecated_filter
-            opts
-          end
+      # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity
+      def initialize(options = {}, &block)
+        unless options[:io] || options[:file_name]
+          fail "Sapience::Appender::File missing mandatory parameter :file_name or :io"
+        end
 
-        if io = options.delete(:io)
-          @log = io
+        opts = options.dup
+        if (io = opts.delete(:io))
+          @log = Sapience.constantize(io)
         else
-          @file_name = options.delete(:file_name)
-          fail "Sapience::Appender::File missing mandatory parameter :file_name or :io" unless @file_name
+          @file_name = opts.delete(:file_name)
           reopen
         end
 
         # Set the log level and formatter if supplied
-        super(options, &block)
+        super(opts, &block)
       end
+      # rubocop:enable AbcSize, CyclomaticComplexity, PerceivedComplexity
 
       # After forking an active process call #reopen to re-open
       # open the file handles etc to resources

data/lib/sapience/appender/sentry.rb

@@ -9,64 +9,70 @@ end
 # Example:
 #   Sapience.add_appender(:sentry, {})
 #
-class Sapience::Appender::Sentry < Sapience::Subscriber
-  # Create Appender
-  #
-  # Parameters
-  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
-  #     Override the log level for this appender.
-  #     Default: :error
-  #
-  #   formatter: [Object|Proc|Symbol|Hash]
-  #     An instance of a class that implements #call, or a Proc to be used to format
-  #     the output from this appender
-  #     Default: Use the built-in formatter (See: #call)
-  #
-  #   filter: [Regexp|Proc]
-  #     RegExp: Only include log messages where the class name matches the supplied.
-  #     regular expression. All other messages will be ignored.
-  #     Proc: Only include log messages where the supplied Proc returns true
-  #           The Proc must return true or false.
-  #
-  #   host: [String]
-  #     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
-  def initialize(options = {}, &block)
-    options         = options.is_a?(Hash) ? options.dup : { level: options }
-    options[:level] ||= :error
+# rubocop:disable Style/ClassAndModuleChildren
+module Sapience
+  module Appender
+    class Sentry < Sapience::Subscriber
+      # Create Appender
+      #
+      # Parameters
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: :error
+      #
+      #   formatter: [Object|Proc|Symbol|Hash]
+      #     An instance of a class that implements #call, or a Proc to be used to format
+      #     the output from this appender
+      #     Default: Use the built-in formatter (See: #call)
+      #
+      #   filter: [Regexp|Proc]
+      #     RegExp: Only include log messages where the class name matches the supplied.
+      #     regular expression. All other messages will be ignored.
+      #     Proc: Only include log messages where the supplied Proc returns true
+      #           The Proc must return true or false.
+      #
+      #   host: [String]
+      #     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
+      def initialize(options = {}, &block)
+        fail("Options should be a Hash") unless options.is_a?(Hash)
+        options[:level] ||= :error
+        Raven.configure do |config|
+          config.dsn = options.delete(:dsn)
+        end
+        super(options, &block)
+      end
 
-    super(options, &block)
-  end
-
-  # Send an error notification to sentry
-  def log(log)
-    return false unless should_log?(log)
+      # Send an error notification to sentry
+      def log(log)
+        return false unless should_log?(log)
 
-    context = formatter.call(log, self)
-    if log.exception
-      context.delete(:exception)
-      Raven.capture_exception(log.exception, context)
-    else
-      message = {
-        error_class:   context.delete(:name),
-        error_message: context.delete(:message),
-        context: context,
-      }
-      message[:backtrace] = log.backtrace if log.backtrace
-      Raven.capture_message(message[:error_message], message)
-    end
-    true
-  end
+        context = formatter.call(log, self)
+        if log.exception
+          context.delete(:exception)
+          Raven.capture_exception(log.exception, context)
+        else
+          message = {
+            error_class:   context.delete(:name),
+            error_message: context.delete(:message),
+            context: context,
+          }
+          message[:backtrace] = log.backtrace if log.backtrace
+          Raven.capture_message(message[:error_message], message)
+        end
+        true
+      end
 
-  private
+      private
 
-  # Use Raw Formatter by default
-  def default_formatter
-    Sapience::Formatters::Raw.new
+      # Use Raw Formatter by default
+      def default_formatter
+        Sapience::Formatters::Raw.new
+      end
+    end
   end
-
 end