observed 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjY4MTNiYmFjYTdiNmQ3ODk3ZThkOGRjMjNkNWI1MDg2MmZhYTUxNw==
+  data.tar.gz: !binary |-
+    YzYwZWI3NGE3ZmI4MmQ4NDRkZWZkMTBiNzU2NDM5NmUzMzg3ZWZiYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGM5N2Q4ODQzMTRlZDMzNzdiN2UwODVjNmE0NzUwMjdkZTU2MzdkOThjNjc3
+    NmQwMjRkZGIzYzM0ZDA3N2FkMWVkZmY0YjAyNDE3MWNjMjMxMDUwYmY5ZmMw
+    MWNkMjFmN2RiMTY2Mzg1MjRmMzVlOWEwMGM0MDAxZjE5N2UyOTg=
+  data.tar.gz: !binary |-
+    MTYxNDc0NGRlZjE2NDkwMzNmOGY5ZTM4MDQ1NmNkZWJkNTY0NDk0MWY4MDkz
+    OWQ2ZjQ1MzVhYTQyNDE2MGU4YjExZDEyNTg3ZDg1ZDBmM2NlMWViMjBlZjdi
+    YzQ0MWE5OThlMDc1ZmVmMGZkMTQ5YTAxM2QxNTg4NWU4ZGIyYzQ=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+jdk:
+  - openjdk7
+  - oraclejdk7
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk7

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in observed.gemspec
+gemspec
+
+gem 'coveralls', require: false, group: :test

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,204 @@
+# [Observed](https://github.com/gree/observed)
+
+A polling framework
+
+[Observed](https://github.com/gree/observed) is a framework for polling various applications/middlewares/services running locally or on remote servers like
+ones in your production environment.
+It is designed with extensibility in mind.
+
+-----
+
+Observed polls services, optionally transforms the results, and then redirects the results to another services.
+Observed is open for extension which means that it is extensible via plugins to support add more services and transformations.
+
+To be clear, you can use Observed to:
+
+1.  poll something,
+2.  optionally transform the result,
+3.  pass the result to another services or trigger something
+
+All the three things mentioned above can be extended via plugins and configured via configuration files.
+
+There are known plugins for:
+
+-  Polling HTTP-based services to detect failures and performance degradation
+-  Sending observed data to Fluentd
+-  (More to come)
+
+Observed has has a very small code-base (only a few hundreds of lines) and it should not be too hard to understand the
+code and develop plugins.
+
+Observed's extensible design through plugins is inspired by other Ruby products like Fluentd,
+and having knowledge of other Ruby products may help understanding Observed.
+(But remember that Observed is yet a highly ambitioned and experimental framework. Observed's code has more space to
+improve than other great Ruby products.)
+
+Observed is (and its plugins should be) stateless.
+Specially for Observed, this means that it should work similarly when it is ran as a daemon or a _oneshot_ application like
+a regular cron job as states are stored somewhere outside of the application instance.
+
+Observed is intended to work on Ruby 1.9.3 but should work on Ruby 2.0+ too.
+
+## What it is not
+
+Observed is:
+
+-  Not a framework for creating Web-based polls which are voted. It's all about [polling (computer science)](http://en.wikipedia.org/wiki/Polling_\(computer_science\))
+-  Not a monitoring and reporting tool like Ganglia, New Relic, or etc.
+   But Observed can be used to gather simple metrics via its plugins, and it can pass those metrics to an another tool to
+   achieve any serious monitoring or reporting.
+-  Not a log collector like Fluentd.
+   Observed can be used to emit event logs to the log collector of your choice, but it does not replace or act like that.
+-  Not a [job scheduler](http://en.wikipedia.org/wiki/Job_scheduler) like cron, though it can be integrated to those schedulers to make them trigger Observed to do the
+   job.
+
+## Similar products
+
+- [vacuumetrix](https://github.com/99designs/vacuumetrix) gets metrics from various sources and puts those to various
+  outputs like Graphite, Ganglia, etc.
+  On the other hand, Observed scope itself to be used just for `polling` and also it outputs to not only monitoring
+  systems but any system.
+- [metrics-sampler](https://github.com/dimovelev/metrics-sampler) is a java program which queries metrics from various
+  sources and sends them to outputs like the console or Graphite. It supports inputs such as JMX, JDBC, apache-status,
+  Oracle NoSQL, Redis, webmethods, or regular process which is runnable via the command-line and is able to communiate
+  via standard input/output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'observed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install observed
+
+Or `git clone` the sources and install by using rake:
+
+    $ rake install
+
+## Usage
+
+Just for the purpose of illustration, _let Observed observe and report the healthiness of Google_.
+
+Observed itself is just a framework and doesn't support any service by default.
+Now, just for example, let's assume that we want Observed to poll our HTTP-based webs service and report the result and
+show average response time.
+We start with installing some observed plugins:
+
+    $ gem install observed
+    $ gem install observed-clockwork
+    $ gem install observed-http
+
+In this case, we use observed-clockwork to trigger polls through [Clockwork](https://github.com/tomykaira/clockwork).
+observed-clockwork is a library intended to use in Clockwork's configuration
+file. Clockwork is a scheduler process made with Ruby, which is intended to replace cron.
+Note that we can just use cron which is supported via observed-cron plugin(or even without the plugin, it is breeze to use
+Observed with cron) but we proceed with Clockwork just for example.
+
+With `clockwork.rb` like:
+
+```ruby
+require 'pathname'
+
+require 'clockwork'
+require 'observed/clockwork'
+
+include Clockwork
+
+# Below two lines are specific to Observed's Clockwork support.
+# Others lines are just standard `clockwork.rb`
+include Observed::Clockwork
+
+the_dir = Pathname.new(File.dirname(__FILE__))
+
+register_observed_handler :config_file => the_dir + 'observed.rb'
+
+every(10.seconds, 'google.health')
+```
+
+With `observed.rb` like:
+
+```ruby
+require 'observed/http'
+
+observe 'google.health', via: 'http', with: {
+    method: 'get',
+    url: 'http://www.google.co.jp/'
+}
+
+report /google.health/, via: 'stdout', with: {
+    format: -> tag, time, data {
+      case data[:status]
+      when :success
+        'Google is healthy! (^o^)'
+      else
+        'Google is unhealthy! (;_;)'
+      end
+    }
+}
+```
+
+As you see, `observed.conf` is just a Ruby source to describe Observed's configuration.
+You can rely on Ruby's language features, gems, or etc.
+
+We have finished configuring Observed.
+
+Now, run:
+
+```
+$ clockwork clockwork.rb
+
+I, [2013-11-08T23:39:53.999484 #44285]  INFO -- : Starting clock for 1 events: [ google.health ]
+I, [2013-11-08T23:39:53.999555 #44285]  INFO -- : Triggering 'google.health'
+Google is healthy! (^o^)
+Google is healthy! (^o^)
+Google is healthy! (^o^)
+...
+```
+
+You did it!
+You just saw that Google's healthiness is printed to the standard output every 10 seconds.
+In other words, you did observed Google's healthiness with easily with Observed.
+
+The example described here is fairly simple and would look useless at a glance, but remember that Observed is just a
+framework.
+If you want to monitor performances or get statistics on performance on your service, you can redirect the results to
+Fluentd, Ganglia or else and take advantages of their rich features and plugins.
+We like not reinventing the wheel and it is encouraged to use Observed for just to poll something and then emit the
+result to other services. Things like monitoring, watching, alerting can be done there.
+
+## Documentation
+
+Observed is documented with [YARD](https://github.com/lsegal/yard).
+The documentation is not currently hosted on any server and we have to build the document before reading it.
+
+To generate the document, install YARD:
+
+```
+$ gem install yard
+```
+
+And then run `yardoc` like:
+
+```
+$ yardoc 'lib/**/*.rb'
+```
+
+Open the document:
+
+```
+$ open doc/index.html
+```
+
+## Contributing
+
+1.  [Fork it](https://github.com/gree/observed)
+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,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+task :default => :spec
+RSpec::Core::RakeTask.new

data/examples/00readme/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'observed'
+gem 'observed-clockwork'
+gem 'observed-http'

data/examples/00readme/clockwork.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+
+require 'clockwork'
+require 'observed/clockwork'
+
+include Clockwork
+
+# Below two lines are specific to Observed's Clockwork support.
+# Others lines are just standard `clockwork.rb`
+include Observed::Clockwork
+
+the_dir = Pathname.new(File.dirname(__FILE__))
+
+register_observed_handler :config_file => the_dir + 'observed.rb'
+
+every(10.seconds, 'google.health')

data/examples/00readme/observed.rb

@@ -0,0 +1,17 @@
+require 'observed/http'
+
+observe 'google.health', via: 'http', with: {
+    method: 'get',
+    url: 'http://www.google.co.jp/'
+}
+
+report /google.health/, via: 'stdout', with: {
+    format: -> tag, time, data {
+      case data[:status]
+      when :success
+        'Google is healthy! (^o^)'
+      else
+        'Google is unhealthy! (;_;)'
+      end
+    }
+}

data/examples/observed.rb

@@ -0,0 +1,10 @@
+class Test < Observed::Observer
+  plugin_name 'test'
+  def observe
+    system.report(tag, {foo:1})
+  end
+end
+
+observe 'foo', via: 'test'
+
+report /foo/, via: 'stdout'

data/exe/observed-oneshot

@@ -0,0 +1,11 @@
+#!/bin/env/ruby
+
+require 'observed'
+require 'observed/application/oneshot'
+
+begin
+  Observed::Application::Oneshot.from_argv(ARGV).run
+rescue Observed::Application::Oneshot::InvalidArgumentError => e
+  $stderr.puts 'Missing the path to a Observed config file'
+  $stderr.puts 'Usage: observed-oneshot [-d|--debug] [-l LOG_FILE|--log_file LOG_FILE] <observed.rb>'
+end

data/features/oneshot.feature

@@ -0,0 +1,24 @@
+Feature: Be testable in a single command
+
+  In order to try Observed to see the basic usage usage of it,
+  I want to write a config file and test it by running Observed in a single command
+
+  Scenario: Create a .rb file containing Observed configuration and run it with the observed-oneshot command
+    Given a file named "test.rb" with:
+    """
+    class Test < Observed::Observer
+      plugin_name 'test'
+      def observe
+        system.report(tag, {foo:1})
+      end
+    end
+
+    observe 'foo', via: 'test'
+
+    report /foo/, via: 'stdout'
+    """
+    When I run `observed-oneshot -d test.rb`
+    Then the output should contain:
+    """
+    foo {:foo=>1}
+    """

data/features/support/env.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'aruba/cucumber'
+
+World(Aruba::Api)
+
+Before do
+  @aruba_timeout_seconds = 120
+end

data/features/test_in_single_ruby_source.feature

@@ -0,0 +1,32 @@
+Feature: Be testable in a single Ruby source
+
+  In order to try Observed to see the basic usage usage of it,
+  I want to configure and run Observed in just a single Ruby source file
+
+  Scenario: Create a .rb file containing Observed code and run it with the ruby command
+    Given a file named "test.rb" with:
+    """
+    require 'observed'
+
+    include Observed
+
+    class Test < Observed::Observer
+      plugin_name 'test'
+      def observe
+        system.report(tag, {foo:1})
+      end
+    end
+
+    observe 'foo', via: 'test'
+
+    run 'foo'
+
+    report /foo/, via: 'stdout'
+
+    run 'foo'
+    """
+    When I run `ruby test.rb`
+    Then the output should contain:
+    """
+    foo {:foo=>1}
+    """

data/integrations/observed-clockwork/.gitignore

@@ -0,0 +1,17 @@
+*.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/integrations/observed-clockwork/Gemfile

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

data/integrations/observed-clockwork/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/integrations/observed-clockwork/README.md

@@ -0,0 +1,53 @@
+# observed-clockwork
+
+observed-clockwork is an integration of Observed and Clockwork.
+In the integration, we can define jobs in Observed and schedule those to run by Clockwork.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'observed-clockwork'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install observed-clockwork
+
+## Usage
+
+### With Bundler
+
+    $ bundle install
+    $ bundle exec clockwork examples/clockwork/clockwork.rb
+
+    Or with daemonizing:
+
+    $ bundle install (Note that we need to add the dependency to 'daemons' gem in our Gemfile or gemspec)
+    $ bundle exec clockworkd -c examples/clockwork/clockwork.rb -l start
+    $ tail -f tmp/clockworkd.clockwork.output
+    $ bundle exec clockworkd -c examples/clockwork/clockwork.rb -l stop
+
+### Without Bundler
+
+    $ gem install observed-clockwork
+    $ clockwork clockwork.rb
+
+    Or with daemonizing:
+
+    $ gem install observed-clockwork
+    $ gem install daemons
+    $ clockworkd -c examples/clockwork/clockwork.rb -l start
+    $ tail -f tmp/clockworkd.clockwork.output
+    $ clockworkd -c examples/clockwork/clockwork.rb -l stop
+
+## 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/integrations/observed-clockwork/Rakefile

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

data/integrations/observed-clockwork/bin/clockwork

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'clockwork' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('clockwork', 'clockwork')

data/integrations/observed-clockwork/bin/clockworkd

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'clockworkd' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('clockwork', 'clockworkd')

data/integrations/observed-clockwork/bin/observed-clockwork

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'observed-clockwork' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('observed-clockwork', 'observed-clockwork')

data/integrations/observed-clockwork/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/integrations/observed-clockwork/examples/clockwork/clockwork.rb

@@ -0,0 +1,9 @@
+require 'clockwork'
+require 'observed/clockwork'
+
+include Clockwork
+include Observed::Clockwork
+
+register_observed_handler :config_file => File.dirname(__FILE__) + '/observed.conf'
+
+every(10.seconds, 'foo_1')

data/integrations/observed-clockwork/examples/clockwork/foo_plugin.rb

@@ -0,0 +1,19 @@
+module OneshotSpec
+  class FooPlugin < Observed::Observer
+
+    plugin_name 'foo'
+
+    default timeout_in_milliseconds: 5000
+    default number_of_trials: 10
+
+    def observe
+      sleep_duration = rand / 20
+      sleep sleep_duration
+      system.report(tag, "Foo #{sleep_duration}")
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/integrations/observed-clockwork/examples/clockwork/observed.conf

@@ -0,0 +1,6 @@
+require 'observed/builtin_plugins'
+require_relative 'foo_plugin'
+
+observe 'foo_1', via: 'foo'
+
+report /foo_1/, via: 'stdout'