alephant-logger 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de780cad17918478c874e67e2b92f664e4be91ee
-  data.tar.gz: aaa9ae2aca771d382386706ada2cceb59171249e
+  metadata.gz: 64032058c0749b0c64d5032d751481b4ca84b442
+  data.tar.gz: 73684eaf331ef5d93818846ba82300dfb9480738
 SHA512:
-  metadata.gz: 2dee305aad70a33dc38ac5f64e9ba51851298bb16e42d3be030b6827d14546bb951a492fcb0b93c98d342150b848a952191ce2019f9cd5f645c42e69c59d06cc
-  data.tar.gz: 41753b2edd992d33a8c330e75035deb733b514c16760bd7dd95b00f952230c3ff40a5d47d1975f185d48424dd93504977c8695d3e2197fee31cf643e4b5ce684
+  metadata.gz: 392a50cf2e51c7e53d7a2e013969d6f9c19f8d543eaa7e01c29599b6fa087d79264c31f1d3d414e976ff60339f7374f63de455f080a54c0a35ffb56f6912b731
+  data.tar.gz: 9a9389935f96c1b6e019a8399046bedb6951dc860d78b1df16ed0768e9f57ea89c16d0a5cea07264103ea4991d7f5a6a7bda45a7bf767a53788e207db162df18

data/.ruby-version

@@ -1 +1 @@
-jruby-1.7.9
+jruby-1.7

data/README.md

@@ -1,93 +1,61 @@
 # Alephant::Logger
 
-Logger functionality for Alephant
+Logger functionality for BBC News' [Alephant](https://github.com/BBC-News/alephant) framework.
 
 [![Build
-Status](https://travis-ci.org/BBC-News/alephant-logger.png)](https://travis-ci.org/BBC-News/alephant-logger)
-
-[![Gem Version](https://badge.fury.io/rb/alephant-logger.png)](http://badge.fury.io/rb/alephant-logger)
+Status](https://travis-ci.org/BBC-News/alephant-logger.png)](https://travis-ci.org/BBC-News/alephant-logger) [![Gem Version](https://badge.fury.io/rb/alephant-logger.png)](http://badge.fury.io/rb/alephant-logger)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'alephant-logger'
+```
+gem 'alephant-logger'
+```
 
 And then execute:
 
+```
 $ bundle
+```
 
 Or install it yourself as:
 
+```
 $ gem install alephant-logger
+```
 
 ## Usage
 
 ```rb
-require 'alephant/logger'
-
-# Using the standard logger
-class IncludesLogger
-  include Alephant::Logger
-
-  def calls_logger
-    logger.warn "MUCH WARN. WOW."
-  end
-end
-
-# Sets a logger
-class SetsLogger
-  include Alephant::Logger
-
-  def calls_logger
-    Alephant::Logger.set_logger(CustomLogger.new)
-    logger.warn "SUCH CUSTOM. MUCH LOG."
-  end
-end
-```
-
-### AWS CloudWatch Metrics
-
-```ruby
-require "aws-sdk"
 require "alephant/logger"
-require "alephant/logger/cloudwatch_decorator"
+require "alephant/logger/statsd"
+require "alephant/logger/cloudwatch"
 
-AWS.config(
-  :region            => "eu-west-1",
-  :access_key_id     => "ACCESS_KEY_ID",
-  :secret_access_key => "SECRET_ACCESS_KEY",
-  :session_token     => "SESSION_TOKEN"
-)
+config = {
+  :host      => "statsd.test.service.bbc.co.uk",
+  :port      => 6452,
+  :namespace => "test"
+}
 
-LOGGER = Alephant::Logger::CloudWatchDecorator.new(
-  Logger.new("app.log"), "SomeCloudWatchMetricNameSpace"
-)
+statsd_driver     = Alephant::Logger::Statsd.new config
+cloudwatch_driver = Alephant::Logger::CloudWatch.new "my_namespace"
 
-Alephant::Logger.set_logger LOGGER
-
-class Foo
-  include Alephant::Logger
+logger = Alephant::Logger.create([statsd_driver, cloudwatch_driver])
+logger.increment "foo.bar"
+logger.metric(:name => "FooBar", :unit => "Count", :value => 1)
+```
 
-  def initialize
-    logger.info "some info"
-    logger.debug "much debug"
-    logger.error "great error"
-    logger.warn "so warn"
-    logger.fatal "ooh fatal"
+## Drivers
 
-    # Without the CloudWatchDecorator the `metric` call is a no-op
-    logger.metric({:name => "SomeMetricName", :unit => "Count", :value => 1})
-  end
-end
+You can consume an array of other gems to allow Alephant Logger to send custom metrics:
 
-Foo.new
-```
+1. [Statsd](https://github.com/BBC-News/alephant-logger-statsd#alephantloggerstatsd)
 
 ## Contributing
 
-1. Fork it ( http://github.com/BBC-News/alephant-logger/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. [Fork it!](http://github.com/BBC-News/alephant-logger/fork)
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Create new [Pull Request](https://github.com/BBC-News/alephant-logger/compare).

data/alephant-logger.gemspec

@@ -17,8 +17,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "aws-sdk"
-
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-nc"
   spec.add_development_dependency "guard"

data/lib/alephant/logger.rb

@@ -2,35 +2,32 @@ require 'alephant/logger/version'
 require 'logger'
 
 module Alephant
-  class DelegatingLogger
-    attr_reader :logger
-
-    def initialize(logger)
-      @logger = logger
-    end
-
-    def method_missing(name, *args)
-      logger.send(name, *args) if logger.respond_to? name
+  module Logger
+    def self.create(drivers = [])
+      Logger.new drivers
     end
 
-    def respond_to?(name)
-      logger.respond_to? name || super
-    end
-  end
+    class Logger
+      def initialize(drivers)
+        @drivers = drivers << ::Logger.new(STDOUT)
+      end
 
-  module Logger
-    @@logger = nil
+      def method_missing(name, *args)
+        drivers.each do |driver|
+          driver.send(name, *args) if driver.respond_to? name
+        end
+      end
 
-    def logger
-      ::Alephant::Logger.get_logger
-    end
+      def respond_to?(name)
+        drivers.any? do |driver|
+          driver.respond_to?(name) || super
+        end
+      end
 
-    def self.get_logger
-      @@logger ||= Alephant::DelegatingLogger.new ::Logger.new(STDOUT)
-    end
+      private
 
-    def self.set_logger(value)
-      @@logger = Alephant::DelegatingLogger.new value
+      attr_reader :drivers
     end
   end
 end
+

data/lib/alephant/logger/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Logger
-    VERSION = "0.2.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/logger_spec.rb

@@ -1,45 +1,41 @@
 require 'spec_helper'
 
 describe Alephant::Logger do
-  describe ".get_logger" do
-
-    context "no logger set" do
-      specify {
-        expect(subject.get_logger.logger).to be_a Logger
-      }
+  describe ".create" do
+    specify do
+      expect(subject.create).to be_a Alephant::Logger::Logger
     end
+  end
+end
 
-    context "subject.set_logger(:foo)" do
-      it "returns @@logger" do
-        subject.class_variable_set(:@@logger, :foo)
-        expect(subject.get_logger).to eq(:foo)
+describe Alephant::Logger::Logger do
+  describe "#info" do
+    context "no logger drivers given" do
+      subject { Alephant::Logger::Logger.new [] }
+
+      specify do
+        expect_any_instance_of(::Logger).to receive(:info).with "msg"
+
+        subject.info "msg"
       end
     end
-  end
 
-  describe ".set_logger(:foo)" do
-    it "sets foo as @@logger" do
-      subject.set_logger(:bar)
-      expect(subject.class_variable_get(:@@logger).logger).to eq :bar
-    end
-  end
+    context "logger drivers given" do
+      subject { Alephant::Logger::Logger.new [driver] }
 
-  context "when included in a class" do
+      let(:driver) { double }
 
-    class IncludesLog
-      include Alephant::Logger
+      it "responding drivers receive method calls" do
+        expect(driver).to receive(:metric).with("foo")
 
-      def calls_logger
-        logger
+        subject.metric("foo")
       end
-    end
 
-    context "called via '#logger'" do
-      it "returns the value of @@logger" do
-        subject.class_variable_set(:@@logger, :baz)
-        expect(IncludesLog.new.calls_logger).to eq :baz
+      it "::Logger is always used" do
+        expect_any_instance_of(::Logger).to receive(:info).with "foo"
+
+        subject.info "foo"
       end
     end
-
   end
 end

metadata

@@ -1,156 +1,142 @@
 --- !ruby/object:Gem::Specification
 name: alephant-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Robert Kenny
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rspec-nc
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: guard
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: guard-rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry-remote
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry-nav
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - kenoir@gmail.com
 executables: []
@@ -167,7 +153,6 @@ files:
 - Rakefile
 - alephant-logger.gemspec
 - lib/alephant/logger.rb
-- lib/alephant/logger/cloudwatch_decorator.rb
 - lib/alephant/logger/version.rb
 - spec/logger_spec.rb
 - spec/spec_helper.rb
@@ -175,7 +160,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,9 +175,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Logger functionality for Alephant
 test_files:

data/lib/alephant/logger/cloudwatch_decorator.rb

@@ -1,57 +0,0 @@
-require "aws-sdk"
-
-module Alephant
-  module Logger
-    class CloudWatchDecorator
-      ONE_HOUR = 3600
-
-      def initialize(logger, namespace)
-        @logger = logger
-        @namespace = namespace
-        @cloudwatch = AWS::CloudWatch.new
-      end
-
-      def metric(opts)
-        name, value, unit, dimensions = opts.values_at(:name, :value, :unit, :dimensions)
-
-        Thread.new do
-          cloudwatch.put_metric_data(
-            :namespace => namespace,
-            :metric_data => [{
-              :metric_name => name,
-              :value       => value,
-              :unit        => unit || "None",
-              :dimensions  => parse(dimensions || {})
-            }]
-          )
-        end
-      end
-
-      # Ruby's Kernel implements a `warn` method
-      def warn(*args)
-        logger.warn(*args)
-      end
-
-      def method_missing(name, *args)
-        logger.send(name, *args)
-      end
-
-      def respond_to?(name)
-        logger.respond_to?(name) || super
-      end
-
-      private
-
-      attr_reader :logger, :cloudwatch, :namespace
-
-      def parse(dimensions)
-        dimensions.map do |name, value|
-          {
-            :name  => name,
-            :value => value
-          }
-        end
-      end
-    end
-  end
-end