alephant-logger-statsd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3533696698a6e0e6f4c39212997d85cead186ad6
+  data.tar.gz: 79c8f158fadb773f0dc6814ad3ee647d92c9cc92
+SHA512:
+  metadata.gz: e6cbf7e1659eb5edb9bf2adb11fc0bd34e6b868c57c4d3d6df89a902719df6d8cec6d6d15c6668e8b6857eb258062756815a2d0792e7c1e79b2e697319876fa5
+  data.tar.gz: b5ce96604eadbd714be006b06611a1850ed8a4742093a7a8e28082d797ec0c97733bd0bf310f464b922fdd70a22a37e8936dcaccf3bdcf145d81fb052b703871

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - jruby
+  - 1.7.17
+script: "bundle exec rake all"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Charlie Revett
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Alephant::Logger::Statsd
+
+Statsd driver for the [alephant-logger](https://github.com/BBC-News/alephant-logger) gem, which consumes the [statsd-ruby](https://github.com/reinh/statsd) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alephant-logger-statsd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alephant-logger-statsd
+
+## Usage
+
+Create an instance of the driver:
+
+```ruby
+require "alephant/logger"
+require "alephant/logger/statsd"
+
+config = {
+  :host      => "statsd.test.service.bbc.co.uk",
+  :port      => 6452,
+  :namespace => "test"
+}
+
+driver = Alephant::Logger::Statsd.new config
+logger = Alephant::Logger.create([driver])
+logger.increment "foo.bar"
+```
+
+**Note** that a config is *optional*, if you leave any of the keys out then they will be replaced by the following:
+
+```ruby
+{
+  :host      => "localhost",
+  :port      => 8125,
+  :namespace => "statsd"
+}
+```
+
+Then increment a custom metric, with a given key:
+
+```key
+driver.increment 'front_page.response_time'
+```
+
+You can also increment the metric by a specific interval:
+
+```key
+driver.increment('facebook.signups', 43)
+```
+
+## Contributing
+
+1. [Fork it!](https://github.com/bbc-news/alephant-logger-statsd/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 a new [Pull Request](https://github.com/BBC-News/alephant-logger-statsd/compare).
+
+## Help
+
+Please raise a new [issue](https://github.com/BBC-News/alephant-logger-statsd/issues/new) with the relevant label, or ping [@revett](http://github.com/revett).

data/Rakefile

@@ -0,0 +1,7 @@
+$: << File.join(File.dirname(__FILE__), "lib")
+
+require "bundler/gem_tasks"
+require "rake/rspec"
+
+task :default => :spec
+

data/alephant-logger-statsd.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alephant/logger/statsd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alephant-logger-statsd"
+  spec.version       = Alephant::Logger::Statsd::VERSION
+  spec.authors       = ["Charlie Revett"]
+  spec.email         = ["charlierevett@gmail.com"]
+  spec.summary       = %q{StatsD driver for Alephant Logger gem.}
+  spec.homepage      = "https://github.com/BBC-News/alephant-logger-statsd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "statsd-ruby"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rake-rspec"
+end

data/lib/alephant/logger/statsd.rb

@@ -0,0 +1,38 @@
+require "statsd-ruby"
+require "thread"
+
+module Alephant
+  module Logger
+    class Statsd
+      def initialize(config = {})
+        @server = connect defaults.merge(config)
+      end
+
+      def increment(key, interval = 1)
+        send_data { server.increment(key, interval) }
+      end
+
+      private
+
+      attr_reader :server
+
+      def connect(config)
+        ::Statsd.new(config[:host], config[:port]).tap do |s|
+          s.namespace = config[:namespace]
+        end
+      end
+
+      def defaults
+        {
+          :host      => "localhost",
+          :port      => 8125,
+          :namespace => "statsd"
+        }
+      end
+
+      def send_data
+        Thread.new { yield }
+      end
+    end
+  end
+end

data/lib/alephant/logger/statsd/version.rb

@@ -0,0 +1,7 @@
+module Alephant
+  module Logger
+    class Statsd
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+require "pry"

data/spec/statsd_spec.rb

@@ -0,0 +1,89 @@
+require "alephant/logger/statsd"
+
+describe Alephant::Logger::Statsd do
+  subject { described_class }
+  let(:server) do
+    instance_double(
+      ::Statsd,
+      :increment => true,
+      :namespace= => true
+    )
+  end
+
+  before do
+    allow(::Statsd).to receive(:new) { server }
+  end
+
+  describe ".new" do
+    context "default config" do
+      let(:config) do
+        {
+          :host      => "localhost",
+          :port      => 8125,
+          :namespace => "statsd"
+        }
+      end
+
+      specify do
+        subject.new
+        expect(::Statsd).to have_received(:new).once.with(
+          config[:host], 
+          config[:port]
+        )
+      end
+
+      specify do
+        subject.new
+        expect(server).to have_received(:namespace=).once.with(
+          config[:namespace]
+        )
+      end
+    end
+
+    context "custom config" do
+      let(:config) do
+        {
+          :host      => "192.168.59.103",
+          :port      => 1234,
+          :namespace => "batman"
+        }
+      end
+
+      specify do
+        subject.new config
+        expect(::Statsd).to have_received(:new).once.with(
+          config[:host], 
+          config[:port]
+        )
+      end
+
+      specify do
+        subject.new config
+        expect(server).to have_received(:namespace=).once.with(
+          config[:namespace]
+        )
+      end
+    end 
+  end
+
+  describe "#increment" do
+    let(:driver) { subject.new }
+    let(:key) { "batman" }
+
+    context "default interval" do
+      specify do
+        driver.increment(key).join
+        expect(server).to have_received(:increment).once.with(key, 1)
+      end
+    end
+
+    context "custom interval" do
+      let(:interval) { 10 }
+
+      specify do
+        driver.increment(key, interval).join
+        expect(server).to have_received(:increment).once.with(key, interval)
+      end 
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: alephant-logger-statsd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charlie Revett
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: statsd-ruby
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec-nc
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake-rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- charlierevett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alephant-logger-statsd.gemspec
+- lib/alephant/logger/statsd.rb
+- lib/alephant/logger/statsd/version.rb
+- spec/spec_helper.rb
+- spec/statsd_spec.rb
+homepage: https://github.com/BBC-News/alephant-logger-statsd
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: StatsD driver for Alephant Logger gem.
+test_files:
+- spec/spec_helper.rb
+- spec/statsd_spec.rb