fluent-plugin-grpc 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3947aab1ca9cec4a5489d5b1f07921a80ff046ad
+  data.tar.gz: 662a6a85c98f3a486ff41b5fed6a47dcbcd794da
+SHA512:
+  metadata.gz: 1fb58c4851579e45ba74333ac8f356665ccf1574c59e1880ec60424acc698b86ca71d182477c50c711d59087476ade30b5550901cadc554eac9d089f0ba20416
+  data.tar.gz: 28f7a4bc43a8ba1d5d8411c39ee7979351dd9fc5cefdc80063656bd965eb86dd29c54c8b048fb1c98cbc5cd3874d5abdee56caab3b20a4bad918e939cc54665b

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018-2018 Myungjae Won
+
+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,54 @@
+# fluent-plugin-grpc, a plugin for [Fluentd](http://fluentd.org)
+
+A fluentd plugin to both send and receive fluentd events via [grpc](https://grpc.io)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-grpc'
+
+And then execute:
+
+    $ bundle
+
+Or install it by yourself:
+
+    $ gem install fluent-plugin-grpc
+
+## Requirements
+
+- Ruby 2.3 or later
+
+## Usage
+
+### Input plugin (@type 'grpc')
+
+Receive events via grpc.
+
+    <source>
+      @type grpc
+      bind 0.0.0.0
+      port 50051
+    </source>
+
+    <match **>
+      @type stdout
+    </match>
+
+### Output plugin (@type 'grpc')
+
+Send events via grpc.
+
+    <source>
+      @type dummy
+      tag test
+    </source>
+
+    <match **>
+      @type grpc
+      path localhost:50051
+      <buffer>
+        flush_mode immediate
+      </buffer>
+    </match>

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/**/test_*.rb']
+  test.verbose = true
+end
+
+task :default => [:build]

data/fluent-plugin-grpc.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.authors       = ["Myungjae Won"]
+  spec.email         = ["breadmj@gmail.com"]
+  spec.description   = %q{Fluentd plugins for gRPC}
+  spec.summary       = %q{Fluentd input/output plugins that communicate over gRPC}
+  spec.homepage      = "https://github.com/breadmj/fluent-plugin-grpc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($\)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.name          = "fluent-plugin-grpc"
+  spec.require_paths = ["lib"]
+  spec.version       = '0.0.2'
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "fluentd", [">= 0.12.39", "< 2"]
+  spec.add_dependency "grpc", "~> 1.14"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_development_dependency "grpc-tools", "~> 1.14"
+end

data/lib/event_pb.rb

@@ -0,0 +1,18 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: event.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "event.Log" do
+    optional :name, :string, 1
+  end
+  add_message "event.Ack" do
+    optional :type, :string, 1
+  end
+end
+
+module Event
+  Log = Google::Protobuf::DescriptorPool.generated_pool.lookup("event.Log").msgclass
+  Ack = Google::Protobuf::DescriptorPool.generated_pool.lookup("event.Ack").msgclass
+end

data/lib/event_services_pb.rb

@@ -0,0 +1,22 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: event.proto for package 'event'
+
+require 'grpc'
+require 'event_pb'
+
+module Event
+  module Forwarder
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'event.Forwarder'
+
+      rpc :Forward, Log, Ack
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/fluent/plugin/in_grpc.rb

@@ -0,0 +1,51 @@
+require 'fluent/plugin/input'
+require 'grpc'
+require 'event_services_pb'
+
+module Fluent::Plugin
+  class GrpcInput < Input
+    Fluent::Plugin.register_input('grpc', self)
+
+    helpers :thread
+
+    desc 'The address to bind to.'
+    config_param :bind, :string, default: '0.0.0.0'
+    desc 'The port to listen to.'
+    config_param :port, :integer, default: 50051
+
+    class ForwarderServer < Event::Forwarder::Service
+      def forward(event, _unused_call)
+        $stdout.puts event.name
+        Event::Ack.new(type: "received")
+      end
+    end
+
+    public
+    def configure(conf)
+      super
+
+      if @port < 1024
+        raise Fluent::ConfigError, "well known ports cannot be used for this purpose."
+      end
+    end
+
+    public
+    def start
+      super
+
+      @s = GRPC::RpcServer.new
+      @s.add_http2_port("#{@bind}:#{@port}", :this_port_is_insecure)
+      @s.handle(ForwarderServer)
+      thread_create :in_grpc_server do
+        @s.run
+      end
+    end
+
+    public
+    def shutdown
+      @s.stop
+
+      super
+    end
+  end
+end

data/lib/fluent/plugin/out_grpc.rb

@@ -0,0 +1,25 @@
+require 'fluent/plugin/output'
+require 'event_services_pb'
+
+module Fluent::Plugin
+  class GrpcOutput < Output
+
+    Fluent::Plugin.register_output('grpc', self)
+
+    desc 'The endpoint of gRPC server.'
+    config_param :path, :string
+
+    def start
+      super
+      @stub = Event::Forwarder::Stub.new(@path, :this_channel_is_insecure)
+    end
+
+    def write(chunk)
+      chunk.each do |time, record|
+        ack = @stub.forward(Event::Log.new(name: record['message']))
+        $stdout.puts ack.type
+      end
+    end
+
+  end
+end

data/protos/event.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package event;
+
+service Forwarder {
+  rpc Forward(Log) returns (Ack) {}
+}
+
+message Log {
+  string name = 1;
+}
+
+message Ack {
+  string type = 1;
+}

data/test/helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/input"
+require "fluent/test/driver/output"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_in_grpc.rb

@@ -0,0 +1,31 @@
+require 'helper'
+require 'fluent/plugin/in_grpc'
+
+class GrpcInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  BASE_CONFIG = %[
+    @type grpc
+  ]
+
+  CONFIG = BASE_CONFIG + %[
+    # nothing yet
+  ]
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::GrpcInput).configure(conf)
+  end
+
+  def test_configure
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG)
+    }
+
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(CONFIG)
+    }
+  end
+
+end

data/test/plugin/test_out_grpc.rb

@@ -0,0 +1,30 @@
+require 'helper'
+require 'fluent/plugin/out_grpc'
+
+class GrpcOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    path localhost:50051
+  ]
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::GrpcOutput).configure(conf)
+  end
+
+  sub_test_case 'configured with invalid configurations' do
+    test 'empty config' do
+      assert_raise Fluent::ConfigError do
+        create_driver(%[])
+      end
+    end
+
+    test 'path is set correctly' do
+      d = create_driver
+      assert_equal "localhost:50051", d.instance.path
+    end
+  end
+
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-grpc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Myungjae Won
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.39
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.39
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: Fluentd plugins for gRPC
+email:
+- breadmj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-grpc.gemspec
+- lib/event_pb.rb
+- lib/event_services_pb.rb
+- lib/fluent/plugin/in_grpc.rb
+- lib/fluent/plugin/out_grpc.rb
+- protos/event.proto
+- test/helper.rb
+- test/plugin/test_in_grpc.rb
+- test/plugin/test_out_grpc.rb
+homepage: https://github.com/breadmj/fluent-plugin-grpc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Fluentd input/output plugins that communicate over gRPC
+test_files:
+- test/helper.rb
+- test/plugin/test_in_grpc.rb
+- test/plugin/test_out_grpc.rb