observed-gauge 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWE3MTcxMTExMDI3YmFhZTc5MjMyOTQzZDBjMmM0ZDdhOGJmMDIwZA==
+  data.tar.gz: !binary |-
+    OWIxMTJhOTBhMTgyNGQzYmVkMzdkM2M1Y2RhNzU0ZTk4MmZhOWM0MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWYyNDJmNjFmOGFiY2NiZWM2YmE4NWM1YWM2Mjg4Yzg2MjFjZTlhNmQzN2My
+    MDIwYzIwYmYzZDI3N2U5NjNiYzczNGM5ZjkzNjg0NDdjYWM2NTAzNmEwODMx
+    OWVhZWNkNTI1NGY0MDYxNWMxYWU3ZGUyMzRjODBkNmNkNGQzZjg=
+  data.tar.gz: !binary |-
+    MGM5MzYxYjg5NDYzYWEyOGVjNzExYjA1OGE2N2RjNmNhNzcyYmE2YWMwMDEx
+    MDNjNGM2NDhjNDU4OGY4MDM2YzBkYjg2OWRhY2E3ZTA2M2FmODQxNGMzMDY3
+    NDVkNzUzNjI5YTczNGY0OTZkZGRmOThjN2RkY2VkZWY1ZWQ2ODE=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in observed-gauge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 GREE, Inc.
+
+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,29 @@
+# Observed::Gauge
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'observed-gauge'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install observed-gauge
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/observed/gauge/version.rb

@@ -0,0 +1,5 @@
+module Observed
+  module Gauge
+    VERSION = "0.1.0"
+  end
+end

data/lib/observed/gauge.rb

@@ -0,0 +1,117 @@
+require 'observed/reporter'
+require 'observed/reporter/regexp_matching'
+require 'observed/gauge/version'
+require 'logger'
+require 'rrd'
+
+module Observed
+  module Plugins
+    class Gauge < Observed::Reporter
+
+      plugin_name 'gauge'
+
+      include Observed::Reporter::RegexpMatching
+
+      attribute :tag
+      attribute :key_path
+      attribute :coerce, default: ->(data){ data }
+      attribute :rrd
+      attribute :step
+      attribute :period
+
+      def report(tag, time, data)
+        rewrote = update_value_for_key_path(data, key_path) do |v|
+          sample = coerce.call(v)
+          average = get_cdp_updated_with(time, sample)
+          average
+        end
+        unless fetch_value_for_key_path(rewrote, key_path).nan?
+          system.report(self.tag, rewrote)
+        end
+      end
+
+      def prepare_rrd(args)
+        start = args[:start]
+        logger.debug "Creating a rrd file named '#{args[:rrd]}' with options {:start => #{start}}"
+        result = RRD::Builder.new(args[:rrd], start: start, step: step.seconds).tap do |builder|
+          builder.datasource data_source, :type => :gauge, :heartbeat => period.seconds, :min => 0, :max => :unlimited
+          builder.archive :average, :every => period.seconds, :during => period.seconds
+          builder.save
+        end
+        logger.debug "Builder#save returned: #{result.inspect}"
+      end
+
+      private
+
+      def update_value_for_key_path(data, key_path, &block)
+        first, *rest = split_key_path(key_path)
+        data = data.dup
+        dug_data = data[first] || data[first.intern]
+
+        if rest.empty?
+          hash_update(data, first, block.call(dug_data))
+        else
+          hash_update(data, first, update_value_for_key_path(dug_data, rest, &block))
+        end
+
+        data
+      end
+
+      def hash_update(hash, key, value)
+        if hash[key]
+          hash[key] = value
+        else
+          hash[key.intern] = value
+        end
+      end
+
+      def fetch_value_for_key_path(data, key_path)
+        first, *rest = split_key_path(key_path)
+        dug_data = data[first] || data[first.intern]
+        if rest.empty?
+          dug_data
+        else
+          fetch_value_for_key_path(dug_data, rest)
+        end
+      end
+
+      def split_key_path(key_path)
+        case key_path
+        when Array
+          key_path
+        when String
+          key_path.split('.')
+        else
+          fail "Unexpected type of key_path met. Expected an Array or a String, but it was a(n) #{key_path.class}"
+        end
+      end
+
+      def data_source
+        self.key_path.gsub('.', '_')
+      end
+
+      # @param [Time] time
+      def get_cdp_updated_with(time, value)
+        rrd_path = self.rrd
+        t = time.to_i
+
+        rrd = RRD::Base.new(rrd_path)
+
+        unless File.exist? rrd_path
+          prepare_rrd(rrd: rrd_path, start: t)
+        end
+
+        logger.debug "Updating the data source '#{data_source}' with the value #{value} with timestamp #{t}"
+        rrd.update t, value
+
+        logger.debug rrd.fetch!(:average)[-2..-1]
+
+        rrd.fetch(:average)[-2..-1].first.last
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/observed-gauge.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'observed/gauge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'observed-gauge'
+  spec.version       = Observed::Gauge::VERSION
+  spec.authors       = ['KUOKA Yusuke']
+  spec.email         = ['yusuke.kuoka@gree.net']
+  spec.description   = %q{Gauge plugin for Observed}
+  spec.summary       = %q{A plugin to consolidate outputs from other Observed output plugins by averaging values by averaging them over configured periods}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'observed', '~> 0.1.0'
+  spec.add_dependency 'rrd-ffi', '~> 0.2.14'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/gauge_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+
+require 'observed/gauge'
+
+shared_examples_for 'the observed-gauge plugin' do
+
+  subject {
+    described_class.new
+  }
+
+  before {
+    File.delete(rrd) if File.exist?(rrd)
+
+    subject.configure rrd: rrd, key_path: key_path
+  }
+
+  it 'matches against the tag using a pattern described in regular expression' do
+    expect(subject.match('test.foo')).to be_true
+  end
+
+  it 'reports data with averaged values' do
+    subject.prepare_rrd(start: t - 120, rrd: rrd)
+    system.expects(:report).with(tag, expected_data.freeze).once
+    expect { subject.report('test.foo', t - 120, data) }.to_not raise_error
+    expect { subject.report('test.foo', t - 60, data) }.to_not raise_error
+    expect { subject.report('test.foo', t, data) }.to_not raise_error
+  end
+
+  it 'creates rrd files automatically on first report' do
+    expect { subject.report('test.foo', t, data) }.to_not raise_error
+
+    expect { File.exist? rrd }.to be_true
+  end
+end
+
+describe Observed::Plugins::Gauge do
+  subject {
+    Observed::Plugins::Gauge.new
+  }
+
+  it 'has a name' do
+    expect(described_class.plugin_name).to eq('gauge')
+  end
+
+  context 'with configuration' do
+
+    before {
+
+      subject.configure(
+          system: system,
+          tag_pattern: tag_pattern,
+          tag: tag,
+          step: step,
+          period: period
+      )
+    }
+
+    after {
+      File.delete(rrd) if File.exist?(rrd)
+    }
+
+    let(:t) {
+      Time.now
+    }
+
+    let(:system) {
+      sys = mock('system')
+
+      sys.stubs(:now).returns(t)
+
+      sys
+    }
+
+    let(:tag_pattern) {
+      /test.\.*/
+    }
+
+    let(:tag) {
+      'test.out'
+    }
+
+    let(:step) {
+      10
+    }
+
+    let(:period) {
+      60
+    }
+
+    before {
+      subject.configure(
+          system: system,
+          tag_pattern: tag_pattern,
+          tag: tag,
+          step: step,
+          period: period,
+          key_path: key_path
+      )
+    }
+
+    context 'with an incorrect key path' do
+
+      let(:key_path) {
+        123
+      }
+
+      let(:rrd) {
+        'gauge_incorrect_key_path.rrd'
+      }
+
+      let(:data) {
+        { response: { time: 10 }}
+      }
+
+      let(:t) {
+        Time.now
+      }
+
+      it 'raise an error' do
+        expect { subject.report('test.foo', t, data) }.to raise_error(/Unexpected type of key_path met/)
+      end
+    end
+
+    context 'with a correct key path' do
+
+      let(:key_path) {
+        'response.time'
+      }
+
+      let(:data_source) {
+        'response_time'
+      }
+
+      context 'with the default coercer' do
+
+        context 'with data whose keys are symbols' do
+          let(:rrd) {
+            'gauge_spec_symbols.rrd'
+          }
+
+          let(:data) {
+            { response: { time: 10 }}
+          }
+
+          let(:expected_data) {
+            { response: { time: 10 }}
+          }
+
+          it_behaves_like 'the observed-gauge plugin'
+        end
+
+        context 'with data whose keys are strings' do
+          let(:rrd) {
+            'gauge_spec_strings.rrd'
+          }
+
+          let(:data) {
+            {'response' => {'time' => 10}}
+          }
+
+          let(:expected_data) {
+            { 'response' => { 'time' => 10 }}
+          }
+
+          it_behaves_like 'the observed-gauge plugin'
+        end
+
+      end
+
+      context 'with a string-to-integer coercer for values' do
+
+        before {
+          subject.configure coercer: ->(v){ t.to_i }
+        }
+
+        let(:rrd) {
+          'gauge_spec_coercer.rrd'
+        }
+
+        let(:data) {
+          {'response' => {'time' => '10'}}
+        }
+
+        let(:expected_data) {
+          { 'response' => { 'time' => 10 }}
+        }
+
+        it_behaves_like 'the observed-gauge plugin'
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'fakefs/spec_helpers'
+require 'rspec'
+
+Dir["#{File.expand_path('..',  __FILE__)}/support/**/*.rb"].each { |f| require f }
+
+puts "Please do not update/create files while tests are running."
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.order = :random
+  config.filter_run :focus => true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    @fixture_path = Pathname.new(File.expand_path('../fixtures/',  __FILE__))
+  end
+
+  config.mock_framework = :mocha
+end
+
+if RUBY_VERSION =~ /^1.9/
+  require 'simplecov'
+  SimpleCov.start
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: observed-gauge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KUOKA Yusuke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: observed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rrd-ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.14
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gauge plugin for Observed
+email:
+- yusuke.kuoka@gree.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/observed/gauge.rb
+- lib/observed/gauge/version.rb
+- observed-gauge.gemspec
+- spec/gauge_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: A plugin to consolidate outputs from other Observed output plugins by averaging
+  values by averaging them over configured periods
+test_files:
+- spec/gauge_spec.rb
+- spec/spec_helper.rb