fluent-plugin-wendelin 0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 690acc01d3867ddd46c6cb0709553e512aeafad6
+  data.tar.gz: 3186bc8fe9cb69b7700d13a4b907e6b3a78f0553
+SHA512:
+  metadata.gz: 74bcf2e5e9aecb28cb4966d49382b73d6ec803337e0e6cdaaf022c1a86aaf00ab2287c5cb1610d23eddd6220ea71129b84cb9f851bfa25934662f5ab2f5ffae2
+  data.tar.gz: 09b83cf665ee08f06b1114e717b169e14660d3de01bfac97679cfb951b600f68b5d24eb18f574e882ca69578ad3ee417ccb45ec3b80072f856239ba1105c81c8

data/.gitignore

@@ -0,0 +1,2 @@
+/.bundle/
+/Gemfile.lock

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (C) 2015 Nexedi SA and Contributors
+
+   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,49 @@
+fluent-plugin-wendelin
+======================
+
+This is output plugin for [Fluentd][] to forward data to [Wendelin][] system.
+
+[Fluentd]:  http://fluentd.org/
+[Wendelin]: http://wendelin.io/
+
+
+Configuration
+-------------
+
+A sample configuration to setup ingestion of data for a tag to Wendelin:
+
+```apache
+<match your.sensor.tag>
+  @type wendelin
+  @id wendelin_out
+
+  streamtool_uri    <Wendelin_URL>/erp5/portal_ingestion_policies/<YOUR_INGESTION_POLICY_ID>
+  user      <your_wendelin_user>
+  password  <your_wendelin_password>
+
+  # all parameters of BufferedOutput & Output classes are supported too, e.g.
+  # `buffer_type`, `flush_interval`, `num_threads`, `log_level`, etc - see
+  # their code near:
+  #
+  #   https://github.com/fluent/fluentd/blob/master/lib/fluent/output.rb#L182
+  #
+  # logging setup description:
+  #
+  #   http://docs.fluentd.org/articles/logging
+
+  buffer_type       memory
+  #buffer_path       "#{ENV['HOME']/var}"
+  flush_interval    5s
+</match>
+```
+
+See *example/to_wendelin.conf* for fully setup example.
+
+
+TODO
+----
+
+- make content to be posted over HTTP as raw (instead of urlencode data).
+- HTTPS certificates are currently not verified.
+- X.509 certificates instead of user / password.
+- cleanup

data/example/to_wendelin.conf

@@ -0,0 +1,90 @@
+# Example configuration of Wendelin output for Fluentd
+
+## built-in TCP input, so we can accept messages from other fluentd(s) and so
+## that fluent-cat works:
+## $ echo <json|msgpack> | fluent-cat <tag>
+<source>
+  @type forward
+  @id forward_input
+</source>
+
+
+# HTTP input
+# http://localhost:8888/<tag>?json=<json>
+<source>
+  @type http
+  @id http_input
+  port 8888
+</source>
+
+
+## output tag=sensor.** to Wendelin
+<match <YOUR_SENSOR_TAG>.**>
+  @type wendelin
+  @id wendelin_out
+
+  streamtool_uri    <Wendelin_URL>/erp5/portal_ingestion_policies/<YOUR_INGESTION_POLICY_ID>
+  # TODO ^^^ do not check peer's certificate
+  user      <your_wendelin_user>
+  password  <your_wendelin_password>
+
+  # all parameters of BufferedOutput & Output classes are supported too, e.g.
+  # `buffer_type`, `flush_interval`, `num_threads`, `log_level`, etc - see
+  # their code near:
+  #
+  #   https://github.com/fluent/fluentd/blob/master/lib/fluent/output.rb#L182
+  #
+  # logging setup description:
+  #
+  #   http://docs.fluentd.org/articles/logging
+
+  buffer_type       memory
+  #buffer_path       "#{ENV['HOME']/var}"
+  flush_interval    5s
+</match>
+
+
+
+
+# ---- monitoring & debugging ----
+
+
+# Listen HTTP for monitoring
+# http://localhost:24220/api/plugins
+# http://localhost:24220/api/plugins?type=TYPE
+# http://localhost:24220/api/plugins?tag=MYTAG
+<source>
+  @type monitor_agent
+  @id monitor_agent_input
+
+  port 24220
+</source>
+
+# Listen DRb for debug
+<source>
+  @type debug_agent
+  @id debug_agent_input
+
+  bind 127.0.0.1
+  port 24230
+</source>
+
+
+## match tag=debug.** and dump to console
+<match debug.**>
+  @type stdout
+  @id stdout_output
+</match>
+
+
+## match fluent's internal events
+#<match fluent.**>
+#  @type null
+#</match>
+
+## match not matched logs and write to file
+#<match **>
+#  @type file
+#  path /var/log/fluent/else
+#  compress gz
+#</match>

data/fluent-plugin-wendelin.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |gem|
+    gem.name            = "fluent-plugin-wendelin"
+    gem.version         = "0.1.alpha1"
+    gem.authors         = ["Kirill Smelkov"]
+    gem.email           = ["kirr@nexedi.com"]
+    gem.summary         = %q{Fluentd output to Wendelin}
+    gem.description     = %q{Fluentd output plugin to forward data to Wendelin system}
+    gem.homepage        = "https://lab.nexedi.cn/nexedi/fluent-plugin-wendelin"
+    gem.license         = "APLv2"
+
+    gem.files           = `git ls-files -z`.split("\x0")
+    gem.require_paths   = ["lib"]
+
+    gem.add_runtime_dependency "fluentd", "~> 0"
+    # ? net/http
+    # ? openssl
+end

data/lib/fluent/plugin/out_wendelin.rb

@@ -0,0 +1,88 @@
+# Fluentd output plugin to ingest data to Wendelin system
+# Copyright (C) 2015  Nexedi SA and Contributors.
+#                     Kirill Smelkov <kirr@nexedi.com>
+#
+#   This program is free software: you can Use, Study, Modify and Redistribute
+#   it under the terms of 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.
+
+
+# This plugin hooks into Fluentd in a way similiar to out_forward and
+# out_secure_forward and outputs event stream to a Wendelin HTTP endpoint.
+
+require 'fluent/output'
+require_relative 'wendelin_client'
+
+
+module Fluent
+
+  class WendelinOutput < ObjectBufferedOutput   # XXX verify base class
+    Plugin.register_output('wendelin', self)
+
+    # where Wendelin's Input Stream Tool is located,
+    # ex http://example.com/erp5/portal_ingestion_policies/example_ingestion
+    config_param    :streamtool_uri,    :string
+
+    # credentials to authenticate this fluentd to wendelin
+    # by default credentials are not used
+    # TODO user/password -> certificate
+    config_param    :user,      :string,  :default => nil
+    config_param    :password,  :string,  :default => nil
+
+
+    def configure(conf)
+        super
+
+        credentials = {}
+        if @user
+            credentials['user']     = @user
+            credentials['password'] = @password
+        end
+        @wendelin = WendelinClient.new(@streamtool_uri, credentials)
+    end
+
+    def start
+        super
+        # TODO
+    end
+
+    def shutdown
+        super
+        # TODO
+    end
+
+
+    # hooked to ObjectBufferedOutput - write out records from a buffer chunk for a tag.
+    #
+    # NOTE this is called from a separate thread (see OutputThread and BufferedOutput)
+    def write_objects(tag, chunk)
+        # NOTE if this fail and raises -> it will unroll to BufferedOutput#try_flush
+        # which detects errors and retries outputting logs up to retry maxcount
+        # times and aborts outputting current logs if all try fail.
+        #
+        # This way, we don't need to code rescue here.
+
+        # NOTE tag is 1, and chunk stores an event stream, usually [] of
+        # (timestamp, record) in msgpack, but it general it could be arbitrary
+        # data - we send it as-is.
+        data_chunk = chunk.read()
+
+        # for input_stream_ref use tag as-is - it will be processed/translated
+        # further on server by Wendelin
+        reference = tag
+
+        @wendelin.ingest(reference, data_chunk)
+    end
+
+  end
+
+end

data/lib/fluent/plugin/wendelin_client.rb

@@ -0,0 +1,98 @@
+# module to ingest data to a Wendelin through HTTP endpoint
+# Copyright (C) 2015  Nexedi SA and Contributors.
+#                     Kirill Smelkov <kirr@nexedi.com>
+#
+#   This program is free software: you can Use, Study, Modify and Redistribute
+#   it under the terms of 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 'net/http'
+require 'openssl'
+
+# show request/response traces or not
+$trace    = false
+
+
+# class representing a Wendelin client
+class WendelinClient
+
+  # `streamtool_uri` - URI pointing to portal_input_data_stream "mountpoint"
+  # `credentials`    # {'user' => _, 'password' => _}     TODO change to certificate
+  def initialize(streamtool_uri, credentials)
+    @streamtool_uri = streamtool_uri
+    @credentials    = credentials
+  end
+
+
+  # ingest `data_chunk` to a stream referenced as `reference`
+  def ingest(reference, data_chunk)
+      uri = URI("#{@streamtool_uri}/ingest?reference=#{reference}")
+      req = Net::HTTP::Post.new(uri)
+      if @credentials.has_key?('user')
+        req.basic_auth @credentials['user'], @credentials['password']
+      end
+
+      # TODO ensure content-type is 'raw', e.g. this way
+      # (but then querystring ?reference=... is lost)
+      # req.body = data_chunk
+      # req.content_type = 'application/octet-stream'
+      req.set_form_data('data_chunk' => data_chunk)
+
+      if $trace
+          puts '>>> REQUEST'
+          puts "method\t=> #{req.method}"
+          puts "path\t=> #{req.path}"
+          puts "uri\t=> #{req.uri}"
+          puts "body\t=> #{req.body}"
+          puts "body_stream\t=> #{req.body_stream}"
+          req.each {|h| puts "#{h}:\t#{req[h]}"}
+          puts
+      end
+
+      begin
+          # TODO keep connection open (so that every new ingest does not do
+          # full connect again)
+          res = Net::HTTP.start(uri.hostname, uri.port,
+                      :use_ssl      => (uri.scheme == 'https'),
+                      # NOTE = "do not check server cert"
+                      # TODO move this out to conf parameters
+                      :verify_mode  => OpenSSL::SSL::VERIFY_NONE
+                ) do |http|
+              http.request(req)
+          end
+
+      rescue
+          # some http/ssl/other connection error
+          puts "HTTP ERROR:"
+          raise
+
+      else
+          if $trace
+              puts '>>> RESPONSE'
+              res.each {|h| puts "#{h}:\t#{res[h]}"}
+              puts "code\t=> #{res.code}"
+              puts "msg\t=> #{res.message}"
+              puts "class\t=> #{res.class}"
+              puts "body:", res.body
+          end
+
+          if res.kind_of?(Net::HTTPSuccess)       # res.code is 2XX
+              #puts "ingested ok"
+          else
+              puts "FAIL:"
+              res.value
+          end
+      end
+  end
+
+end

data/test/ingest-torture.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# ingest several data streams concurently forever
+require_relative 'wendelin_test'
+
+def runingest(stream_ref)
+    i = 0
+    while true
+        data_chunk = ", #{i} (#{stream_ref})"
+        #puts "ingest #{stream_ref}, #{data_chunk}"
+        ingest stream_ref, data_chunk
+        i = i + 1
+        sleep 0.1
+    end
+end
+
+
+t31 = Thread.new { runingest 'ABC-HELLO-01.cat' }
+t32 = Thread.new { runingest 'ABC-HELLO-01.tac' }
+
+t31.join    # wait forever

data/test/ingest.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# manually test erp5_data_streams ingestion via Ruby HTTP lib
+# XXX draft/stub
+
+require_relative 'wendelin_test'
+require 'msgpack'
+
+#puts [1,2,'hello'].to_msgpack
+ingest 'ABC-HELLO-01.cat', [1,2,'hello'].to_msgpack
+#ingest 'ABC-HELLO-01.cat', ', hello'
+#ingest 'ABC-HELLO-01.tac', ', magic'

data/test/wendelin_test.rb

@@ -0,0 +1,22 @@
+# simple ingest() for wendelin tests
+# (without need for providing streamtool uri, credentials, etc)
+
+# load wendelin_clinet.rb from in-tree
+here = File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path(File.join(here, '../lib'))
+require 'fluent/plugin/wendelin_client'
+
+# FIXME hardcoded
+$user     = 'user'
+$password = 'password'
+
+# FIXME hardcoded & shortcut for tests
+$erp5       = "https://example.com/erp5"                # erp5 root
+$streamtool = "#{$erp5}/portal_input_data_streams"      # where Input Stream Tool is mounted
+
+$wendelin   = WendelinClient.new($streamtool, {'user' => $user, 'password' => $password})
+
+
+def ingest(input_stream_ref, data_chunk)
+    $wendelin.ingestDataChunk(input_stream_ref, data_chunk)
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-wendelin
+version: !ruby/object:Gem::Version
+  version: 0.1.alpha1
+platform: ruby
+authors:
+- Kirill Smelkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd output plugin to forward data to Wendelin system
+email:
+- kirr@nexedi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- example/to_wendelin.conf
+- fluent-plugin-wendelin.gemspec
+- lib/fluent/plugin/out_wendelin.rb
+- lib/fluent/plugin/wendelin_client.rb
+- test/ingest-torture.rb
+- test/ingest.rb
+- test/wendelin_test.rb
+homepage: https://lab.nexedi.cn/nexedi/fluent-plugin-wendelin
+licenses:
+- APLv2
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fluentd output to Wendelin
+test_files: []