ffwd 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 662d6ca5d2a1a07cf582c04a365f705c1cc807f9
+  data.tar.gz: 1a823ac6b62d55c1b2751830a6ffcdbb13c92fd9
+SHA512:
+  metadata.gz: 1e8b9bf081c3883429a20a0be30c3f0b22203057061f45fe828f0a3b23ec8b193e58814915fcdc1e05193a1048a8fc1065adb44c2909ee64ac68575a0756fcf7
+  data.tar.gz: 602b3ea6457cab25305334696046d1b21364a70327e91767df9fd3b321f52462d9f6d642604c22540ee3484a2e16aa61669cea3385b0f9be577cc8e6352c9c62

data/lib/ffwd.rb

@@ -145,15 +145,40 @@ module FFWD
 
   def self.dump_loaded_plugins
     FFWD::Plugin.loaded.each do |name, plugin|
-      puts "  Plugin '#{name}'"
+      unless description = plugin.description
+        description = "no description"
+      end
+
+      puts "  Plugin '#{name}' (#{description})"
       puts "    Source: #{plugin.source}"
-      puts "    Supports: #{plugin.capabilities.join(' ')}"
-      puts "    Description: #{plugin.description}" if plugin.description
+      puts "    Supported modes: #{plugin.capabilities.join(', ')}"
+
       unless plugin.options.empty?
         puts "    Available Options:"
         plugin.options.each do |opt|
-          puts "      :#{opt[:name]} (default: #{opt[:default].inspect})"
-          puts "        #{opt[:help]}" if opt[:help]
+          if modes = opt[:modes]
+            modes = modes.join(', ')
+          else
+            modes = "all modes"
+          end
+
+          puts "      :#{opt[:name]} (#{modes})"
+
+          unless (default = opt[:default]).nil?
+            puts "        Default: #{default.inspect}"
+          else
+            puts "        Default: (no default)"
+          end
+
+          if help = opt[:help]
+            if help.is_a? Array
+              help.each do |h|
+                puts "        #{h}"
+              end
+            else
+              puts "        #{help}"
+            end
+          end
         end
       end
     end

data/lib/ffwd/plugin.rb

@@ -92,17 +92,17 @@ module FFWD
 
     module ClassMethods
       def register_plugin(name, opts={})
-        options = {
+        config = {
           :mod => self,
           :description => opts[:description],
           :options => opts[:options] || []
         }
 
-        options[:setup_input_method_name] = (opts[:setup_input_method] || :setup_input)
-        options[:setup_output_method_name] = (opts[:setup_output_method] || :setup_output)
-        options[:setup_tunnel_method_name] = (opts[:setup_tunnel_method] || :setup_tunnel)
+        config[:setup_input_method_name] = (opts[:setup_input_method] || :setup_input)
+        config[:setup_output_method_name] = (opts[:setup_output_method] || :setup_output)
+        config[:setup_tunnel_method_name] = (opts[:setup_tunnel_method] || :setup_tunnel)
 
-        FFWD::Plugin.discovered[name] = options
+        FFWD::Plugin.discovered[name] = config
       end
     end
 
@@ -115,8 +115,8 @@ module FFWD
     end
 
     def self.load_discovered source
-      FFWD::Plugin.discovered.each do |name, options|
-        FFWD::Plugin.loaded[name] = Loaded.new source, name, options
+      FFWD::Plugin.discovered.each do |name, config|
+        FFWD::Plugin.loaded[name] = Loaded.new source, name, config
       end
 
       FFWD::Plugin.discovered.clear
@@ -152,7 +152,8 @@ module FFWD
     end
 
     def self.option name, opts={}
-      {:name => name, :default => opts[:default], :help => opts[:help]}
+      {:name => name, :default => opts[:default], :help => opts[:help],
+       :modes => opts[:modes]}
     end
   end
 end

data/lib/ffwd/plugin/json.rb

@@ -28,16 +28,26 @@ module FFWD::Plugin::JSON
   DEFAULT_HOST = "localhost"
   DEFAULT_PORT = 19000
   DEFAULT_PROTOCOL = "tcp"
+  DEFAULT_KIND = "line"
 
   register_plugin "json",
     :description => "A simple JSON protocol implementation",
     :options => [
       FFWD::Plugin.option(
-        :kind, :default => :line,
-        :help => "Kind of protocol to use, valid options are: :frame and :line."),
+        :kind, :default => DEFAULT_KIND,
+        :help => [
+          "Kind of protocol to use, valid options are 'frame' and 'line'.",
+          "'frame' means that the protocol is frame delimited, " +
+          "so each received datagram is received.",
+          "'line' means that the protocol is line-delimited, " +
+          "each line is assumed to be a JSON object."
+        ]),
       FFWD::Plugin.option(
         :protocol, :default => DEFAULT_PROTOCOL,
-        :help => "Protocol to use when receiving messages. When :kind is :frame, this should be 'udp'.")
+        :help => [
+          "Protocol to use when receiving messages.",
+          "When :kind is 'frame', this should be 'udp'."
+        ])
     ]
 
   class LineConnection < FFWD::Connection
@@ -67,31 +77,22 @@ module FFWD::Plugin::JSON
     end
   end
 
-  KINDS = {
-    :frame => FrameConnection,
-    :line => LineConnection,
-  }
+  KINDS = {"frame" => FrameConnection, "line" => LineConnection}
 
   def self.setup_input opts, core
+    protocol = FFWD.parse_protocol opts[:protocol] || DEFAULT_PROTOCOL
+    kind = (opts[:kind] || DEFAULT_KIND).to_s
+    raise "No such kind: #{kind}" unless connection = KINDS[kind]
     opts[:host] ||= DEFAULT_HOST
     opts[:port] ||= DEFAULT_PORT
-    protocol = FFWD.parse_protocol(opts[:protocol] || DEFAULT_PROTOCOL)
-    kind = opts[:kind] || :line
-    unless connection = KINDS[kind]
-      raise "No such kind: #{kind}"
-    end
-
     protocol.bind opts, core, log, connection
   end
 
   def self.setup_tunnel opts, core, tunnel
+    protocol = FFWD.parse_protocol opts[:protocol] || "tcp"
+    kind = (opts[:kind] || DEFAULT_KIND).to_s
+    raise "No such kind: #{kind}" unless connection = KINDS[kind]
     opts[:port] ||= DEFAULT_PORT
-    protocol = FFWD.parse_protocol(opts[:protocol] || "tcp")
-    kind = opts[:kind] || :line
-    unless connection = KINDS[kind]
-      raise "No such kind: #{kind}"
-    end
-
     protocol.tunnel opts, core, tunnel, log, connection
   end
 end

data/lib/ffwd/plugin/log.rb

@@ -28,13 +28,13 @@ module FFWD::Plugin
     register_plugin "log",
       :description => "A simple plugin that outputs to the primary log.",
       :options => [
-        FFWD::Plugin.option(:prefix, :help => "Prefix for every line logged."),
+        FFWD::Plugin.option(:prefix, :help => [
+          "Prefix for every line logged."
+        ]),
       ]
 
-
     def self.setup_output opts, core
-      prefix = opts[:prefix]
-      Writer.new core, prefix
+      Writer.new core, opts[:prefix]
     end
   end
 end

data/lib/ffwd/statistics/collector.rb

@@ -22,6 +22,7 @@ module FFWD::Statistics
     include FFWD::Lifecycle
 
     DEFAULT_PERIOD = 10
+    DEFAULT_PREFIX = "ffwd"
 
     # Initialize the statistics collector.
     #
@@ -38,6 +39,7 @@ module FFWD::Statistics
       @reporters = {}
       @channel = channel
       @timer = nil
+      @prefix = opts[:prefix] || DEFAULT_PREFIX
 
       system = SystemStatistics.new(opts[:system] || {})
 
@@ -72,6 +74,7 @@ module FFWD::Statistics
     def generate! last, now
       if @system
         @system.collect @channel do |key, value|
+          key = "#{@prefix}.#{key}"
           @emitter.metric.emit(
             :key => key, :value => value,
             :tags => @tags, :attributes => @attributes)
@@ -81,8 +84,9 @@ module FFWD::Statistics
       @reporters.each do |id, reporter|
         reporter.report! do |d|
           attributes = FFWD.merge_hashes @attributes, d[:meta]
+          key = "#{@prefix}.#{d[:key]}"
           @emitter.metric.emit(
-            :key => d[:key], :value => d[:value],
+            :key => key, :value => d[:value],
             :tags => @tags, :attributes => attributes)
         end
       end

data/lib/ffwd/statistics/system_statistics.rb

@@ -103,11 +103,11 @@ module FFWD::Statistics
       cpu_use = cpu_usage
 
       cpu_use.each do |key, value|
-        yield "statistics-cpu/#{key}", value
+        yield "statistics.cpu-#{key}", value
       end
 
       memory_use.each do |key, value|
-        yield "statistics-memory/#{key}", value
+        yield "statistics.memory-#{key}", value
       end
 
       channel << {

data/lib/ffwd/version.rb

@@ -14,5 +14,5 @@
 # the License.
 
 module FFWD
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffwd
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - John-John Tedro
@@ -10,70 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-02 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: autoversion
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -86,88 +77,87 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/ffwd
 - bin/fwc
+- bin/ffwd
+- lib/fwc.rb
+- lib/ffwd.rb
+- lib/ffwd/statistics.rb
+- lib/ffwd/processor.rb
 - lib/ffwd/producing_client.rb
-- lib/ffwd/tunnel/udp.rb
-- lib/ffwd/tunnel/plugin.rb
-- lib/ffwd/tunnel/tcp.rb
+- lib/ffwd/tunnel.rb
+- lib/ffwd/protocol.rb
 - lib/ffwd/lifecycle.rb
-- lib/ffwd/logging.rb
-- lib/ffwd/metric.rb
-- lib/ffwd/schema.rb
-- lib/ffwd/version.rb
-- lib/ffwd/statistics/collector.rb
+- lib/ffwd/debug/tcp.rb
+- lib/ffwd/debug/connection.rb
+- lib/ffwd/debug/monitor_session.rb
+- lib/ffwd/channel.rb
+- lib/ffwd/plugin/json.rb
+- lib/ffwd/plugin/log/writer.rb
+- lib/ffwd/plugin/log.rb
+- lib/ffwd/plugin/json/connection.rb
+- lib/ffwd/circular_buffer.rb
+- lib/ffwd/event.rb
 - lib/ffwd/statistics/system_statistics.rb
+- lib/ffwd/statistics/collector.rb
+- lib/ffwd/connection.rb
 - lib/ffwd/utils.rb
-- lib/ffwd/protocol/udp.rb
+- lib/ffwd/protocol/tcp.rb
 - lib/ffwd/protocol/tcp/bind.rb
-- lib/ffwd/protocol/tcp/flushing_connect.rb
 - lib/ffwd/protocol/tcp/plain_connect.rb
+- lib/ffwd/protocol/tcp/flushing_connect.rb
 - lib/ffwd/protocol/tcp/connection.rb
-- lib/ffwd/protocol/tcp.rb
 - lib/ffwd/protocol/udp/bind.rb
 - lib/ffwd/protocol/udp/connect.rb
-- lib/ffwd/plugin/log/writer.rb
-- lib/ffwd/plugin/log.rb
-- lib/ffwd/plugin/json.rb
-- lib/ffwd/plugin/json/connection.rb
-- lib/ffwd/handler.rb
-- lib/ffwd/protocol.rb
-- lib/ffwd/plugin.rb
-- lib/ffwd/debug.rb
-- lib/ffwd/event.rb
-- lib/ffwd/processor.rb
-- lib/ffwd/debug/monitor_session.rb
-- lib/ffwd/debug/tcp.rb
-- lib/ffwd/debug/connection.rb
-- lib/ffwd/channel.rb
-- lib/ffwd/circular_buffer.rb
-- lib/ffwd/core/interface.rb
-- lib/ffwd/core/emitter.rb
-- lib/ffwd/core/processor.rb
-- lib/ffwd/core/reporter.rb
-- lib/ffwd/core.rb
-- lib/ffwd/plugin_channel.rb
-- lib/ffwd/plugin_loader.rb
+- lib/ffwd/protocol/udp.rb
 - lib/ffwd/reporter.rb
-- lib/ffwd/metric_emitter.rb
-- lib/ffwd/statistics.rb
+- lib/ffwd/plugin_loader.rb
 - lib/ffwd/schema/spotify100.rb
 - lib/ffwd/schema/default.rb
-- lib/ffwd/retrier.rb
-- lib/ffwd/tunnel.rb
+- lib/ffwd/metric_emitter.rb
+- lib/ffwd/schema.rb
+- lib/ffwd/event_emitter.rb
+- lib/ffwd/core/processor.rb
+- lib/ffwd/core/interface.rb
+- lib/ffwd/core/reporter.rb
+- lib/ffwd/core/emitter.rb
+- lib/ffwd/handler.rb
+- lib/ffwd/version.rb
+- lib/ffwd/core.rb
+- lib/ffwd/processor/rate.rb
 - lib/ffwd/processor/count.rb
 - lib/ffwd/processor/histogram.rb
-- lib/ffwd/processor/rate.rb
-- lib/ffwd/event_emitter.rb
-- lib/ffwd/connection.rb
-- lib/ffwd.rb
+- lib/ffwd/debug.rb
+- lib/ffwd/retrier.rb
+- lib/ffwd/logging.rb
+- lib/ffwd/plugin_channel.rb
+- lib/ffwd/tunnel/tcp.rb
+- lib/ffwd/tunnel/udp.rb
+- lib/ffwd/tunnel/plugin.rb
+- lib/ffwd/plugin.rb
+- lib/ffwd/metric.rb
 - lib/em/all.rb
-- lib/fwc.rb
 homepage: https://github.com/spotify/ffwd
 licenses:
 - Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Core framework for the FastForward Daemon.
 test_files: []