alephant-logger 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9a5bd35b04aa6d2617caf7b3981ed99bc04805e
-  data.tar.gz: bfe2dc0e7ea1d273ebd7d6d6b22c95aa5ec1f28a
+  metadata.gz: 2d605d1b63ad9aba8fa73757565282ab99da4315
+  data.tar.gz: 8c5aaba175a66c483b007996b565e1bd33b47eac
 SHA512:
-  metadata.gz: 63912a965c633660e323df8bf9d3898439b65580ee9a72a44218a307453629c52cb4f39549c52df4e51a7d93887f743e8d0e56ca439808425c79b64da7c4732d
-  data.tar.gz: 7e3460616caf70dcf6c95da656a3baf08884f4021df7f485ec22f3ba2f185cdf3182113318fe79f8a1755c963e7643af1dc3c373d5c5c98e683b4d5fb7d14d28
+  metadata.gz: c32c78d2569da9febbf690ede022a1f455bd06d6a58300985d94c2210008b89b170166752df5366a1a8ac9a8ea2134d5263476041635fc8bc245bb2ef3a506a5
+  data.tar.gz: b481bd868cd2a352f5e020412120d4254c399bfa7879e6a76c220eea464fd65e0d65b8feed6e273a5f24708a2914e3245cc2c0c9a4f99a140298ce316f705758

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.9

data/README.md

@@ -44,12 +44,53 @@ class SetsLogger
     logger.warn "SUCH CUSTOM. MUCH LOG."
   end
 end
+```
+
+### AWS CloudWatch Metrics
+
+```ruby
+require "aws-sdk"
+require "alephant/logger"
+require "alephant/logger/cloudwatch_decorator"
+
+AWS.config(
+  :region            => "eu-west-1",
+  :access_key_id     => "ACCESS_KEY_ID",
+  :secret_access_key => "SECRET_ACCESS_KEY",
+  :session_token     => "SESSION_TOKEN"
+)
+
+LOGGER = Alephant::Logger::CloudWatchDecorator.new(
+  Logger.new("app.log"), "SomeCloudWatchMetricNameSpace"
+)
+
+Alephant::Logger.set_logger LOGGER
+
+class Foo
+  include Alephant::Logger
+
+  def initialize
+    logger.info "some info"
+    logger.debug "much debug"
+    logger.error "great error"
+    logger.warn "so warn"
+    logger.fatal "ooh fatal"
+    
+    # We set the value of the metric to 123
+    logger.metric({:name => "SomeMetricName", :unit => "Count", :value => 123})
+    
+    # Notice that no :value key is specified, meaning we'll increment the last seen value
+    # If this metric hasn't been set within the last hour then we'll reset the value back to zero
+    logger.metric({:name => "SomeMetricName", :unit => "Count"})
+  end
+end
 
+Foo.new
 ```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/alephant-logger/fork )
+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`)

data/alephant-logger.gemspec

@@ -17,6 +17,8 @@ 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/cloudwatch_decorator.rb

@@ -0,0 +1,90 @@
+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)
+
+        cloudwatch.put_metric_data(
+          :namespace => namespace,
+          :metric_data => [{
+            :metric_name => name,
+            :value       => determine(name, value),
+            :unit        => unit || "None",
+            :dimensions  => parse(dimensions || {})
+          }]
+        )
+      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
+
+      def determine(name, value)
+        value ? value : increment_metric_value(name)
+      end
+
+      def increment_metric_value(name)
+        stats = get_stats name
+        stats.datapoints.size == 0 ? 0 : stats.datapoints.last[:sum] += 1
+      end
+
+      def get_stats(name)
+        stats_for(filter_metric name).tap do |stats|
+          sort stats.datapoints if stats.datapoints.size > 0
+        end
+      end
+
+      def filter_metric(name)
+        filter_namespace.filter("metric_name", name)
+      end
+
+      def filter_namespace
+        cloudwatch.metrics.filter("namespace", namespace)
+      end
+
+      def stats_for(metric)
+        metric.first.statistics({
+          :statistics => ["Sum"],
+          :start_time => Time.now - ONE_HOUR,
+          :end_time => Time.now
+        })
+      end
+
+      def sort(stats)
+        stats.sort! { |a, b| a[:timestamp] <=> b[:timestamp] }
+      end
+    end
+  end
+end

data/lib/alephant/logger/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Logger
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/lib/alephant/logger.rb

@@ -2,6 +2,22 @@ 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
+    end
+
+    def respond_to?(name)
+      logger.respond_to? name || super
+    end
+  end
+
   module Logger
     @@logger = nil
 
@@ -10,12 +26,11 @@ module Alephant
     end
 
     def self.get_logger
-      @@logger ||= ::Logger.new(STDOUT)
+      @@logger ||= Alephant::DelegatingLogger.new ::Logger.new(STDOUT)
     end
 
     def self.set_logger(value)
-      @@logger = value
+      @@logger = Alephant::DelegatingLogger.new value
     end
   end
 end
-

data/spec/logger_spec.rb

@@ -4,9 +4,9 @@ describe Alephant::Logger do
   describe ".get_logger" do
 
     context "no logger set" do
-      it "returns standard Logger" do
-        expect(subject.get_logger).to be_a Logger
-      end
+      specify {
+        expect(subject.get_logger.logger).to be_a Logger
+      }
     end
 
     context "subject.set_logger(:foo)" do
@@ -20,7 +20,7 @@ describe Alephant::Logger do
   describe ".set_logger(:foo)" do
     it "sets foo as @@logger" do
       subject.set_logger(:bar)
-      expect(subject.class_variable_get(:@@logger)).to eq(:bar)
+      expect(subject.class_variable_get(:@@logger).logger).to eq :bar
     end
   end
 
@@ -37,7 +37,7 @@ describe Alephant::Logger do
     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)
+        expect(IncludesLog.new.calls_logger).to eq :baz
       end
     end
 

metadata

@@ -1,142 +1,156 @@
 --- !ruby/object:Gem::Specification
 name: alephant-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Kenny
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  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'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec-nc
+  prerelease: false
   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'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard
+  prerelease: false
   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'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
+  prerelease: false
   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'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry
+  prerelease: false
   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'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry-remote
+  prerelease: false
   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'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry-nav
+  prerelease: false
   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'
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
-  type: :development
-description:
+description: 
 email:
 - kenoir@gmail.com
 executables: []
@@ -144,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - .travis.yml
 - Gemfile
 - Guardfile
@@ -152,6 +167,7 @@ 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
@@ -159,7 +175,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -174,9 +190,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
 specification_version: 4
 summary: Logger functionality for Alephant
 test_files: