fluent-plugin-websocket 0.1.2

data/.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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2013 IZAWA Tetsu (@moccos)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,79 @@
+# Fluent::Plugin::Websocket
+
+Fluentd websocket output plugin.
+
+## Installation
+
+Copy __out_websocket.rb__ into your fluentd plugin directory.
+
+Default plugin directory is _/etc/fluent/plugin_. You can specify additional location by _-p_ option. (Please see _fluentd -h_)
+
+This plugin depends on [__em-websocket__](https://github.com/igrigorik/em-websocket) module. You can  install it by _gem install em-websocket_.
+
+
+## Configuration
+    <match foo.**>
+      type websocket
+      host 192.168.1.1  # default: 0.0.0.0 (ANY)
+      port 8080         # default: 8080
+      use_msgpack false # default: false
+      add_time false    # default: false
+      add_tag true      # default: true
+    </match>
+
+- __host__: WebSocket server IP address.
+- __port__: WebSocket server port.
+- __use\_msgpack__: Send [MessagePack](http://msgpack.org/) format binary. Otherwise, you send JSON format text.
+- __add\_time__: Add timestamp to the data.
+- __add\_tag__: Add fluentd tag to the data.
+
+If there are no websocket connections, this plugin silently discards data. You may use _out\_copy_ plugin like this:
+
+    <match foo.**>
+      type copy
+      <store>
+        type file
+        path /var/log/foo/bar.log
+      </store>
+      <store>
+        type websocket
+        port 8080
+      </store>
+    </match>
+
+## Data format
+    [tag, timestamp, data_object]
+
+- tag is appended when _add\_tag_ option is true.
+- timespamp is appended when _add\_time_ option is true.
+
+### Example
+    curl -X POST -d 'json={"action":"login","user":6}' http://localhost:8888/foo/bar
+
+    ["foo.bar",1364699026,{"action":"login","user":6}]
+
+## Client sample
+### JSON format (use_msgpack: false)
+    function onMessage(evt) {
+      data = JSON.parse(evt.data);
+      ...
+    }
+
+### Msgpack format binary (use_msgpack: true)
+Extract data by [msgpack.js](https://github.com/msgpack/msgpack-javascript).
+
+    websocket.binaryType = "arraybuffer"
+    ...
+    function onMessage(evt) {
+      data = msgpack.unpack(new Uint8Array(evt.data))
+      ...
+    }
+
+## 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,10 @@
+#env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/plugin/test*.rb']
+  t.verbose = true
+end
+task :default => :test

data/fluent-plugin-websocket.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-websocket"
+  gem.version       = "0.1.2"
+  gem.authors       = ["IZAWA Tetsu (@moccos)"]
+  gem.email         = ["tt.izawa@gmail.com"]
+  gem.homepage      = "https://github.com/moccos/fluent-plugin-websocket"
+  gem.summary       = %q{Fluentd websocket output plugin}
+  gem.description   = %q{Fluentd websocket output plugin}
+  gem.required_ruby_version = ">= 1.9.2"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "fluentd"
+  gem.add_development_dependency "websocket-ocket-eventmachine-client"
+  gem.add_development_dependency "msgpack"
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "em-websocket"
+end

data/lib/fluent/plugin/out_websocket.rb

@@ -0,0 +1,82 @@
+# Copyright (C) 2013 IZAWA Tetsu (@moccos)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'em-websocket'
+require 'thread'
+
+module Fluent
+  $lock = Mutex::new
+  $channel = EM::Channel.new
+
+  class WebSocketOutput < Fluent::Output
+    Fluent::Plugin.register_output('websocket', self)
+    config_param :use_msgpack, :bool, :default => false
+    config_param :host, :string, :default => "0.0.0.0"
+    config_param :port, :integer, :default => 8080
+    config_param :add_time, :bool, :default => false
+    config_param :add_tag, :bool, :default => true
+
+    def configure(conf)
+      super
+      $thread = Thread.new do
+      $log.trace "Started em-websocket thread."
+      $log.info "WebSocket server #{@host}:#{@port} [msgpack: #{@use_msgpack}]"
+      EM.run {
+        EM::WebSocket.run(:host => @host, :port => @port) do |ws|
+          ws.onopen { |handshake|
+            callback = @use_msgpack ? proc{|msg| ws.send_binary(msg)} : proc{|msg| ws.send(msg)}
+            $lock.synchronize do
+              sid = $channel.subscribe callback
+              $log.trace "WebSocket connection: ID " + sid.to_s
+              ws.onclose {
+                $log.trace "Connection closed: ID " + sid.to_s
+                $lock.synchronize do
+                  $channel.unsubscribe(sid)
+                end
+              }
+            end
+
+            #ws.onmessage { |msg|
+            #}
+          }
+        end
+      }
+      end
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+      EM.stop
+      Thread::kill($thread)
+      $log.trace "Killed em-websocket thread."
+    end
+
+    def emit(tag, es, chain)
+      chain.next
+      es.each {|time,record|
+        data = [record]
+        if (@add_time) then data.unshift(time) end
+        if (@add_tag) then data.unshift(tag) end
+        output = @use_msgpack ? data.to_msgpack : data.to_json
+        $lock.synchronize do
+          $channel.push output
+        end
+      }
+    end
+  end
+end

data/test/plugin/test_out_websocket.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'msgpack'
+require 'fluent/test'
+require 'fluent/plugin/out_websocket'
+require 'websocket-eventmachine-client'
+
+class WebSocketForTest
+  def initialize(key, n)
+    @n_received = 0
+    @v_received = []
+
+    @ws = WebSocket::EventMachine::Client.connect(:uri => 'ws://localhost:8080')
+    @ws.onmessage do |msg, type|
+      #puts "Received message: #{msg.to_s} / #{type.to_s}"
+      data = type == :text ? JSON.parse(msg): MessagePack.unpack(msg)
+      @v_received.push(data[0][key])
+      @n_received += 1
+      if (n == @n_received)
+        @ws.close()
+      end
+    end
+  end
+
+  attr_reader :n_received, :v_received
+end
+
+class WebSocketOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    v_str = "sekaiichi kawaiiyo"
+    v_int = -1234567
+    v_double = -123.4567
+    @key = "key"
+    @values = [v_str, v_int, v_double]
+  end
+
+  CONFIG = %[
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::OutputTestDriver.new(Fluent::WebSocketOutput).configure(conf)
+  end
+
+  def impl_test(d)
+    sleep(0.2)
+    ws = WebSocketForTest.new(@key, @values.length)
+    sleep(0.2)
+    for v in @values
+      d.emit({@key => v}, 0)
+    end
+    sleep(0.5)
+    assert_equal(@values.length, ws.n_received)
+    result = ws.v_received
+    for i in 0 .. @values.length
+      assert_equal(@values[i], result[i])
+    end
+  end
+
+  # TODO: How to test another configuration?
+  #def test_json_out
+    #d = create_driver %[
+      #use_msgpack false
+      #add_tag false
+    #]
+    #impl_test(d)
+  #end
+
+  def test_msgpack_out
+    d = create_driver %[
+      use_msgpack true
+      add_tag false
+    ]
+    impl_test(d)
+  end
+
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-websocket
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- IZAWA Tetsu (@moccos)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: fluentd
+  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: websocket-ocket-eventmachine-client
+  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: msgpack
+  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: fluentd
+  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: em-websocket
+  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'
+description: Fluentd websocket output plugin
+email:
+- tt.izawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-websocket.gemspec
+- lib/fluent/plugin/out_websocket.rb
+- test/plugin/test_out_websocket.rb
+homepage: https://github.com/moccos/fluent-plugin-websocket
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Fluentd websocket output plugin
+test_files:
+- test/plugin/test_out_websocket.rb