fluent-plugin-gcloud-pubsub-custom 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a55a4279110490b7ac03da92af18e269d92d5d75af86d294a130acd4fb440364
-  data.tar.gz: cfa6ba338f70ae9826fc71e3733dfb6c42175f55ae7015db38fc1703c643ed33
+  metadata.gz: 51c4af6bf7aee07e04161734152a796864a9a21924eab0e2434e45d177b4be0d
+  data.tar.gz: cd0bb6ec1e0b769b0e7792c5c8d5a797a5407ffca3dbe66f37bd1010959194ce
 SHA512:
-  metadata.gz: 00aedffe49e51e556d3b8ef86965b67614aab97d7bb06ef1032d8b826ff8d33ca85383d822430ff8c30f6638372bd2a7f2544d86d6745b9b4f89395af384e226
-  data.tar.gz: 0b4c66aa2418626728eebb048a4e57f1f49915d609bbf028c7979ca0ce79168e36a3d413d79301faf5ce4fb998162ae75e508b784f6764a0d08aad76a6af6d45
+  metadata.gz: 4f6f11c50da0f9396275e757a18cec552fdeeb8718e290a1388a2190bd26cb327704e6424848bf65a656e545f8cd6364ae571c285774cf82735a5512f0a57cd4
+  data.tar.gz: 62840bd5232d0f756c5ea09449f9821b2a55cee69d2fe0c048bfe764c4673fb389cde7b2b8c1b6d671a3f6def5d0d11587b080b15011fee1868079df7c35a4e8

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
 
 gemfile:

data/CHANGELOG.md

@@ -1,8 +1,35 @@
 ## ChangeLog
 
+### Release 1.4.0 - 2020/08/11
+
+- Bump up google-cloud-pubsub to v0.39.x
+  - In preparation for updating to v1.x
+- Output plugin
+  - Add `dest_project` parameter
+
+### Release 1.3.2 - 2019/08/16
+
+- Input plugin
+  - Make `topic` parameter optional
+
+### Release 1.3.1 - 2018/06/08
+
+- Input plugin
+  - Dumps raw string to logs for parsing errors
+
+### Release 1.3.0 - 2018/05/18
+
+- Make attributes available 
+
+### Release 1.2.0 - 2018/04/24
+
+- Output plugin
+  - Support inject section 
+
 ### Release 1.1.0 - 2018/03/30
 
-- The placeholder is now available in topic param
+- Output plugin
+  - The placeholder is now available in topic param
 
 ### Release 1.0.3 - 2018/03/29
 

data/README.md

@@ -81,6 +81,8 @@ Use `gcloud_pubsub` output plugin.
 - `topic` (required)
   - Set topic name to publish.
   - You can use placeholder in this param. See: https://docs.fluentd.org/v1.0/articles/buffer-section
+- `dest_project` (optional, default: `nil`)
+  - Set your destination GCP project if you publish messages cross project.
 - `autocreate_topic` (optional, default: `false`)
   - If set to `true`, specified topic will be created when it doesn't exist.
 - `max_messages` (optional, default: `1000`)
@@ -91,6 +93,8 @@ Use `gcloud_pubsub` output plugin.
     - See https://cloud.google.com/pubsub/quotas#other_limits
 - `max_message_size` (optional, default: `4000000` = `4MB`)
   - Messages exceeding `max_message_size` are not published because Pub/Sub clients cannot receive it.
+- `attribute_keys` (optional, default: `[]`)
+  - Publishing the set fields as attributes.
 
 ### Pull messages
 
@@ -131,8 +135,8 @@ Use `gcloud_pubsub` input plugin.
   - Set your credential file path.
   - Running fluentd on GCP, you can use scope instead of specifying this.
   - You can also use environment variable such as `GCLOUD_KEYFILE`.
-- `topic` (required)
-  - Set topic name to pull.
+- `topic` (optional)
+  - Set topic name that the subscription belongs to.
 - `subscription` (required)
   - Set subscription name to pull.
 - `max_messages` (optional, default: `100`)
@@ -144,6 +148,8 @@ Use `gcloud_pubsub` input plugin.
   - Pulling messages by intervals of specified seconds.
 - `pull_threads` (optional, default: `1`)
   - Set number of threads to pull messages.
+- `attribute_keys` (optional, default: `[]`)
+  - Specify the key of the attribute to be emitted as the field of record.
 - `parse_error_action` (optional, default: `exception`)
   - Set error type when parsing messages fails.
     - `exception`: Raise exception. Messages are not acknowledged.

data/fluent-plugin-gcloud-pubsub-custom.gemspec

@@ -7,17 +7,16 @@ Gem::Specification.new do |gem|
   gem.license     = "MIT"
   gem.homepage    = "https://github.com/mia-0032/fluent-plugin-gcloud-pubsub-custom"
   gem.summary     = gem.description
-  gem.version     = "1.1.0"
+  gem.version     = "1.4.0"
   gem.authors     = ["Yoshihiro MIYAI"]
   gem.email       = "msparrow17@gmail.com"
-  gem.has_rdoc    = false
   gem.files       = `git ls-files`.split("\n")
   gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency "fluentd", [">= 0.14.15", "< 2"]
-  gem.add_runtime_dependency "google-cloud-pubsub", "~> 0.30.0"
+  gem.add_runtime_dependency "google-cloud-pubsub", "~> 0.39.0"
 
   gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"

data/lib/fluent/plugin/gcloud_pubsub/client.rb

@@ -7,19 +7,40 @@ module Fluent
     class RetryableError < Error
     end
 
+    class Message
+      attr_reader :message, :attributes
+      def initialize(message, attributes={})
+        @message = message
+        @attributes = attributes
+      end
+
+      def bytesize()
+        attr_size = 0
+        @attributes.each do |key, val|
+          attr_size += key.bytesize + val.bytesize
+        end
+        @message.bytesize + attr_size
+      end
+    end
+
     class Publisher
-      def initialize(project, key, autocreate_topic)
+      def initialize(project, key, autocreate_topic, dest_project)
         @pubsub = Google::Cloud::Pubsub.new project_id: project, credentials: key
         @autocreate_topic = autocreate_topic
+        @dest_project = dest_project
         @topics = {}
       end
 
       def topic(topic_name)
         return @topics[topic_name] if @topics.has_key? topic_name
 
-        client = @pubsub.topic topic_name
-        if client.nil? && @autocreate_topic
-          client = @pubsub.create_topic topic_name
+        if @dest_project.nil?
+          client = @pubsub.topic topic_name
+          if client.nil? && @autocreate_topic
+            client = @pubsub.create_topic topic_name
+          end
+        else
+          client = @pubsub.topic topic_name, project: @dest_project
         end
         if client.nil?
           raise Error.new "topic:#{topic_name} does not exist."
@@ -32,7 +53,7 @@ module Fluent
       def publish(topic_name, messages)
         topic(topic_name).publish do |batch|
           messages.each do |m|
-            batch.publish m
+            batch.publish m.message, m.attributes
           end
         end
       rescue Google::Cloud::UnavailableError, Google::Cloud::DeadlineExceededError, Google::Cloud::InternalError => ex
@@ -43,8 +64,12 @@ module Fluent
     class Subscriber
       def initialize(project, key, topic_name, subscription_name)
         pubsub = Google::Cloud::Pubsub.new project_id: project, credentials: key
-        topic = pubsub.topic topic_name
-        @client = topic.subscription subscription_name
+        if topic_name.nil?
+          @client = pubsub.subscription subscription_name
+        else
+          topic = pubsub.topic topic_name
+          @client = topic.subscription subscription_name
+        end
         raise Error.new "subscription:#{subscription_name} does not exist." if @client.nil?
       end
 

data/lib/fluent/plugin/in_gcloud_pubsub.rb

@@ -26,7 +26,7 @@ module Fluent::Plugin
     desc 'Set your credential file path.'
     config_param :key,                :string,  default: nil
     desc 'Set topic name to pull.'
-    config_param :topic,              :string
+    config_param :topic,              :string,  default: nil
     desc 'Set subscription name to pull.'
     config_param :subscription,       :string
     desc 'Pulling messages by intervals of specified seconds.'
@@ -37,6 +37,8 @@ module Fluent::Plugin
     config_param :return_immediately, :bool,    default: true
     desc 'Set number of threads to pull messages.'
     config_param :pull_threads,       :integer, default: 1
+    desc 'Specify the key of the attribute to be acquired as a record'
+    config_param :attribute_keys,     :array,   default: []
     desc 'Set error type when parsing messages fails.'
     config_param :parse_error_action, :enum,    default: :exception, list: [:exception, :warning]
     # for HTTP RPC
@@ -220,15 +222,20 @@ module Fluent::Plugin
 
       messages.each do |m|
         line = m.message.data.chomp
+        attributes = m.attributes
         @parser.parse(line) do |time, record|
           if time && record
+            @attribute_keys.each do |key|
+              record[key] = attributes[key]
+            end
+
             event_streams[@extract_tag.call(record)].add(time, record)
           else
             case @parse_error_action
             when :exception
-              raise FailedParseError.new "pattern not match: #{line.inspect}"
+              raise FailedParseError.new "pattern not match: #{line}"
             else
-              log.warn 'pattern not match', record: line.inspect
+              log.warn 'pattern not match', record: line
             end
           end
         end

data/lib/fluent/plugin/out_gcloud_pubsub.rb

@@ -1,9 +1,11 @@
 require 'fluent/plugin/output'
-
 require 'fluent/plugin/gcloud_pubsub/client'
+require 'fluent/plugin_helper/inject'
 
 module Fluent::Plugin
   class GcloudPubSubOutput < Output
+    include Fluent::PluginHelper::Inject
+
     Fluent::Plugin.register_output('gcloud_pubsub', self)
 
     helpers :compat_parameters, :formatter
@@ -17,6 +19,8 @@ module Fluent::Plugin
     config_param :key,                :string,  :default => nil
     desc 'Set topic name to publish.'
     config_param :topic,              :string
+    desc "Set your dest GCP project if publishing cross project"
+    config_param :dest_project,       :string,  :default => nil
     desc "If set to `true`, specified topic will be created when it doesn't exist."
     config_param :autocreate_topic,   :bool,    :default => false
     desc 'Publishing messages count per request to Cloud Pub/Sub.'
@@ -25,6 +29,8 @@ module Fluent::Plugin
     config_param :max_total_size,     :integer, :default => 9800000  # 9.8MB
     desc 'Limit bytesize per message.'
     config_param :max_message_size,   :integer, :default => 4000000  # 4MB
+    desc 'Publishing the set field as an attribute'
+    config_param :attribute_keys,     :array,   :default => []
 
     config_section :buffer do
       config_set_default :@type, DEFAULT_BUFFER_TYPE
@@ -43,11 +49,16 @@ module Fluent::Plugin
 
     def start
       super
-      @publisher = Fluent::GcloudPubSub::Publisher.new @project, @key, @autocreate_topic
+      @publisher = Fluent::GcloudPubSub::Publisher.new @project, @key, @autocreate_topic, @dest_project
     end
 
     def format(tag, time, record)
-      @formatter.format(tag, time, record).to_msgpack
+      record = inject_values_to_record(tag, time, record)
+      attributes = {}
+      @attribute_keys.each do |key|
+        attributes[key] = record.delete(key)
+      end
+      [@formatter.format(tag, time, record), attributes].to_msgpack
     end
 
     def formatted_to_msgpack_binary?
@@ -64,7 +75,8 @@ module Fluent::Plugin
       messages = []
       size = 0
 
-      chunk.msgpack_each do |msg|
+      chunk.msgpack_each do |msg, attr|
+        msg = Fluent::GcloudPubSub::Message.new(msg, attr)
         if msg.bytesize > @max_message_size
           log.warn 'Drop a message because its size exceeds `max_message_size`', size: msg.bytesize
           next

data/test/plugin/test_in_gcloud_pubsub.rb

@@ -18,13 +18,16 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
 
   class DummyInvalidMsgData
     def data
-      return 'foo:bar'
+      'foo:bar'
     end
   end
   class DummyInvalidMessage
     def message
       DummyInvalidMsgData.new
     end
+    def attributes
+      {"attr_1" => "a", "attr_2" => "b"}
+    end
   end
 
   def create_driver(conf=CONFIG)
@@ -53,6 +56,7 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
         return_immediately true
         pull_interval 2
         pull_threads 3
+        attribute_keys attr-test
         enable_rpc true
         rpc_bind 127.0.0.1
         rpc_port 24681
@@ -67,6 +71,7 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
       assert_equal(1000, d.instance.max_messages)
       assert_equal(true, d.instance.return_immediately)
       assert_equal(3, d.instance.pull_threads)
+      assert_equal(['attr-test'], d.instance.attribute_keys)
       assert_equal(true, d.instance.enable_rpc)
       assert_equal('127.0.0.1', d.instance.rpc_bind)
       assert_equal(24681, d.instance.rpc_port)
@@ -78,6 +83,7 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
       assert_equal(100, d.instance.max_messages)
       assert_equal(true, d.instance.return_immediately)
       assert_equal(1, d.instance.pull_threads)
+      assert_equal([], d.instance.attribute_keys)
       assert_equal(false, d.instance.enable_rpc)
       assert_equal('0.0.0.0', d.instance.rpc_bind)
       assert_equal(24680, d.instance.rpc_port)
@@ -126,13 +132,16 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
   sub_test_case 'emit' do
     class DummyMsgData
       def data
-        return '{"foo": "bar"}'
+        '{"foo": "bar"}'
       end
     end
     class DummyMessage
       def message
         DummyMsgData.new
       end
+      def attributes
+        {"attr_1" => "a", "attr_2" => "b"}
+      end
     end
 
     class DummyMsgDataWithTagKey
@@ -140,7 +149,7 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
         @tag = tag
       end
       def data
-        return '{"foo": "bar", "test_tag_key": "' + @tag + '"}'
+        '{"foo": "bar", "test_tag_key": "' + @tag + '"}'
       end
     end
     class DummyMessageWithTagKey
@@ -150,6 +159,9 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
       def message
         DummyMsgDataWithTagKey.new @tag
       end
+      def attributes
+        {"attr_1" => "a", "attr_2" => "b"}
+      end
     end
 
     setup do
@@ -235,6 +247,22 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
       assert_true d.events.empty?
     end
 
+    test 'with attributes' do
+      messages = Array.new(1, DummyMessage.new)
+      @subscriber.pull(immediate: true, max: 100).at_least(1) { messages }
+      @subscriber.acknowledge(messages).at_least(1)
+
+      d = create_driver("#{CONFIG}\nattribute_keys attr_1")
+      d.run(expect_emits: 1, timeout: 3)
+      emits = d.events
+
+      assert(1 <= emits.length)
+      emits.each do |tag, time, record|
+        assert_equal("test", tag)
+        assert_equal({"foo" => "bar", "attr_1" => "a"}, record)
+      end
+    end
+
     test 'invalid messages with parse_error_action warning' do
       messages = Array.new(1, DummyInvalidMessage.new)
       @subscriber.pull(immediate: true, max: 100).at_least(1) { messages }

data/test/plugin/test_out_gcloud_pubsub.rb

@@ -62,6 +62,17 @@ class GcloudPubSubOutputTest < Test::Unit::TestCase
 
       assert_equal(true, d.instance.autocreate_topic)
     end
+
+    test '"dest_project" can be specified' do
+      d = create_driver(%[
+        project project-test
+        topic topic-test
+        key key-test
+        dest_project dest-project-test
+      ])
+
+      assert_equal("dest-project-test", d.instance.dest_project)
+    end
   end
 
   sub_test_case 'topic' do
@@ -87,6 +98,21 @@ class GcloudPubSubOutputTest < Test::Unit::TestCase
       end
     end
 
+    test '"dest_project" is set' do
+      d = create_driver(%[
+        project project-test
+        topic topic-test
+        key key-test
+        dest_project dest-project-test
+      ])
+
+      @publisher.publish.once
+      @pubsub_mock.topic("topic-test", {:project=>"dest-project-test"}).once { @publisher }
+      d.run(default_tag: "test") do
+        d.feed(@time, {"a" => "b"})
+      end
+    end
+
     test '40x error occurred on connecting to Pub/Sub' do
       d = create_driver
 
@@ -206,5 +232,21 @@ class GcloudPubSubOutputTest < Test::Unit::TestCase
         end
       end
     end
+
+    test 'inject section' do
+      d = create_driver(%[
+        project project-test
+        topic topic-test
+        key key-test
+        <inject>
+          tag_key tag
+        </inject>
+      ])
+      @publisher.publish.once
+      d.run(default_tag: 'test') do
+        d.feed({"foo" => "bar"})
+      end
+      assert_equal({"tag" => 'test', "foo" => "bar"}, JSON.parse(MessagePack.unpack(d.formatted.first)[0]))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-gcloud-pubsub-custom
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Yoshihiro MIYAI
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.39.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.39.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +124,7 @@ homepage: https://github.com/mia-0032/fluent-plugin-gcloud-pubsub-custom
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Google Cloud Pub/Sub input/output plugin for Fluentd event collector
 test_files: