fluent-plugin-gcloud-pubsub-custom-subscriber 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c40c4cd8a4d0c00706354f721a7d152c10fdc7bfe8ce52bdc39b268d74e4dbb
+  data.tar.gz: dfbeb82161e39ffd4c3b6795a5adc1b595852f210f2d6ea109af81cafa9c5821
+SHA512:
+  metadata.gz: 053474f74e5dbf96d413ab4f4c57f0ccc98631578ea6b7e4d95f1a95533f65a7fabc5109ebe9292de32637d59b30187652ea31bf03d9fcb260ea24ad461ad3bb
+  data.tar.gz: 03a60c08384edf78977d4814ed9d27fecf43a8ac1e014b6b730c4873ab1521fee459746155b1e746c6112823a75bdb062bdc23e99b0a74d69a76445bf5ab8937

data/.gitignore

@@ -0,0 +1,11 @@
+~*
+#*
+*~
+[._]*.s[a-w][a-z]
+.DS_Store
+
+*.gem
+.bundle
+Gemfile.lock
+vendor
+.ruby-version

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+
+gemfile:
+ - Gemfile
+
+branches:
+  only:
+    - master
+
+before_install: gem update bundler
+script: bundle exec rake test
+
+sudo: false
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,134 @@
+## ChangeLog
+
+### 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
+
+- Output plugin
+  - The placeholder is now available in topic param
+
+### Release 1.0.3 - 2018/03/29
+
+- Bump up google-cloud-pubsub to v0.30.x
+- Make config file Fluentd v1 compatible
+
+### Release 1.0.2 - 2017/09/11
+
+- Bump up google-cloud-pubsub to v0.27.x
+
+### Release 1.0.1 - 2017/09/05
+
+- Bump up google-cloud-pubsub to v0.26.x
+
+### Release 1.0.0 - 2017/06/23
+
+- Fluentd v0.14 ready
+  - Fluentd v0.12 is not supported in the later version
+
+### Release 0.4.6 - 2017/05/14
+
+- Output plugin
+  - Make messages exceeding configured size not be published because Pub/Sub clients cannot receive it
+
+### Release 0.4.5 - 2017/04/02
+
+- Bump up google-cloud-pubsub to v0.24.x
+
+### Release 0.4.4 - 2017/03/07
+
+- Bump up google-cloud-pubsub to v0.23.x
+
+### Release 0.4.3 - 2017/02/16
+
+- Input plugin
+  - Add "status" method to the http rpc api
+
+### Release 0.4.2 - 2017/02/03
+
+- Make retry to get topic/subscription when Pub/Sub API returns 50x code
+
+### Release 0.4.1 - 2017/02/02
+
+- Bump up google-cloud-pubsub to v0.22.x
+- Input plugin
+  - Rescue 50x errors on acknowledge api
+
+### Release 0.4.0 - 2017/01/21
+
+- Input plugin
+  - Add feature to use record key as tag
+
+### Release 0.3.4 - 2017/01/03
+
+- Output plugin
+  - Rescue 50x errors
+- Input plugin
+  - Guard emit to be called with multi-threading
+  - Rescue 50x errors
+  - Enabled to select whether to raise an exception if message processing failed
+
+### Release 0.3.3 - 2016/12/03
+
+- Input plugin
+  - Fix undefined variable error
+
+### Release 0.3.2 - 2016/11/13
+
+- Add plugin param desc
+- Input plugin
+  - Improve handling to acknowledge messages
+
+### Release 0.3.1 - 2016/11/03
+
+- Output plugin
+  - Improve error handling
+
+### Release 0.3.0 - 2016/10/30
+
+- Bump up google-cloud-pubsub to v0.21
+- Input plugin
+  - Add multithreaded pulling feature
+
+### Release 0.2.0 - 2016/10/15
+
+- Input plugin
+  - Add HTTP RPC feature
+
+### Release 0.1.4 - 2016/09/19
+
+- Input plugin
+  - `pull_interval` can be specified float value
+  - `topic` must be specified
+
+### Release 0.1.3 - 2016/09/17
+
+- Input plugin
+  - Fix error handling and add debug logging
+
+### Release 0.1.2 - 2016/09/11
+
+- Output plugin
+  - Change default max message size and add debug message
+
+### Release 0.1.1 - 2016/08/27
+
+- Bump up google-cloud-pubsub (gcloud-ruby) to 0.20
+
+### Release 0.1.0 - 2016/08/22
+
+- Use formatter / parser plugin and add format configuration
+- Bump up gcloud-ruby to 0.12
+- Remove dependency on lightening buffer
+- Fix error caused by Pub/Sub quotas

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 mdoi
+
+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,178 @@
+# fluent-plugin-gcloud-pubsub-custom
+
+[![Build Status](https://travis-ci.org/mia-0032/fluent-plugin-gcloud-pubsub-custom.svg?branch=master)](https://travis-ci.org/mia-0032/fluent-plugin-gcloud-pubsub-custom)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-gcloud-pubsub-custom.svg)](http://badge.fury.io/rb/fluent-plugin-gcloud-pubsub-custom)
+
+This plugin is forked from https://github.com/mdoi/fluent-plugin-gcloud-pubsub
+
+## Overview
+
+[Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) Input/Output(BufferedOutput) plugin for [Fluentd](http://www.fluentd.org/) with [google-cloud](https://googlecloudplatform.github.io/google-cloud-ruby/) gem
+
+- Publish messages to Google Cloud Pub/Sub
+- Pull messages from Google Cloud Pub/Sub
+
+## Preparation
+
+- Create a project on Google Developer Console
+- Add a topic of Cloud Pub/Sub to the project
+- Add a pull style subscription to the topic
+- Download your credential (json) or [set scope on GCE instance](https://cloud.google.com/compute/docs/api/how-tos/authorization)
+
+When using output plugin, you need to grant Pub/Sub Publisher and Pub/Sub Viewer role to IAM.
+
+Also, when using input plugin, you need to grant Pub/Sub Subscriber and Pub/Sub Viewer role to IAM.
+
+## Requirements
+
+| fluent-plugin-gcloud-pubsub-custom | fluentd | ruby |
+|------------------------|---------|------|
+| >= 1.0.0 | >= v0.14.0 | >= 2.1 |
+|  < 1.0.0 | >= v0.12.0 | >= 1.9 |
+
+## Installation
+
+Install by gem:
+
+```shell
+$ gem install fluent-plugin-gcloud-pubsub-custom
+```
+
+**Caution**
+
+This plugin doesn't work in [td-agent](http://docs.fluentd.org/articles/install-by-rpm).
+
+Please use in [Fluentd installed by gem](http://docs.fluentd.org/articles/install-by-gem).
+
+## Configuration
+
+### Publish messages
+
+Use `gcloud_pubsub` output plugin.
+
+```
+<match example.publish>
+  @type gcloud_pubsub
+  project <YOUR PROJECT>
+  key <YOUR KEY>
+  topic <YOUR TOPIC>
+  autocreate_topic false
+  max_messages 1000
+  max_total_size 9800000
+  max_message_size 4000000
+  <buffer>
+    @type memory
+    flush_interval 1s
+  </buffer>
+  <format>
+    @type json
+  </format>
+</match>
+```
+
+- `project` (optional)
+  - Set your GCP project.
+  - Running fluentd on GCP, you don't have to specify.
+  - You can also use environment variable such as `GCLOUD_PROJECT`.
+- `key` (optional)
+  - 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 publish.
+  - You can use placeholder in this param. See: https://docs.fluentd.org/v1.0/articles/buffer-section
+- `autocreate_topic` (optional, default: `false`)
+  - If set to `true`, specified topic will be created when it doesn't exist.
+- `max_messages` (optional, default: `1000`)
+  - Publishing messages count per request to Cloud Pub/Sub.
+    - See https://cloud.google.com/pubsub/quotas#other_limits
+- `max_total_size` (optional, default: `9800000` = `9.8MB`)
+  - Publishing messages bytesize per request to Cloud Pub/Sub. This parameter affects only message size. You should specify a little smaller value than quota.
+    - 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
+
+Use `gcloud_pubsub` input plugin.
+
+```
+<source>
+  @type gcloud_pubsub
+  tag example.pull
+  project <YOUR PROJECT>
+  key <YOUR KEY>
+  topic <YOUR TOPIC>
+  subscription <YOUR SUBSCRIPTION>
+  max_messages 1000
+  return_immediately true
+  pull_interval 0.5
+  pull_threads 2
+  parse_error_action exception
+  enable_rpc true
+  rpc_bind 0.0.0.0
+  rpc_port 24680
+  <parse>
+    @type json
+  </parse>
+</source>
+```
+
+- `tag` (required)
+  - Set tag of messages.
+  - If `tag_key` is specified, `tag` is used as tag when record don't have specified key.
+- `tag_key` (optional)
+  - Set key to be used as tag.
+- `project` (optional)
+  - Set your GCP project
+  - Running fluentd on GCP, you don't have to specify.
+  - You can also use environment variable such as `GCLOUD_PROJECT`.
+- `key` (optional)
+  - 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.
+- `subscription` (required)
+  - Set subscription name to pull.
+- `max_messages` (optional, default: `100`)
+  - See maxMessages on https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/pull
+- `return_immediately` (optional, default: `true`)
+  - See returnImmediately on https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/pull
+  - If `return_immediately` is `true` or pulling message is stopped by HTTP RPC, this plugin wait `pull_interval` each pull.
+- `pull_interval` (optional, default: `5.0`)
+  - 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.
+    - `warning`: Only logging as warning.
+- `enable_rpc` (optional, default: `false`)
+  - If `true` is specified, HTTP RPC to stop or start pulling message is enabled.
+- `rpc_bind` (optional, default: `0.0.0.0`)
+  - Bind IP address for HTTP RPC.
+- `rpc_port` (optional, default: `24680`)
+  - Port for HTTP RPC.
+
+## 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 a new Pull Request
+
+## TODO
+
+- Add `tag` attribute in output plugin and use `tag` attribute as tag in input plugin.
+- Send ack after other output plugin committed (if possible).
+
+## Authors
+
+- [@mdoi](https://github.com/mdoi) : First author
+- [@mia-0032](https://github.com/mia-0032) : This version author

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/plugin/test_*.rb']
+  test.verbose = true
+end
+
+task :default => [:build]

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

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-gcloud-pubsub-custom-subscriber"
+  gem.description = "Google Cloud Pub/Sub input/output plugin for Fluentd event collector without auto-create topic requiring only Pub/Sub subscriber ACL"
+  gem.license     = "MIT"
+  gem.summary     = gem.description
+  gem.version     = "1.3.1"
+  gem.authors     = ["BL-Logging-Engineer"]
+  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_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "test-unit-rr"
+end

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

@@ -0,0 +1,80 @@
+require 'google/cloud/pubsub'
+
+module Fluent
+  module GcloudPubSub
+    class Error < StandardError
+    end
+    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)
+        @pubsub = Google::Cloud::Pubsub.new project_id: project, credentials: key
+        @autocreate_topic = autocreate_topic
+        @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
+        end
+        if client.nil?
+          raise Error.new "topic:#{topic_name} does not exist."
+        end
+
+        @topics[topic_name] = client
+        client
+      end
+
+      def publish(topic_name, messages)
+        topic(topic_name).publish do |batch|
+          messages.each do |m|
+            batch.publish m.message, m.attributes
+          end
+        end
+      rescue Google::Cloud::UnavailableError, Google::Cloud::DeadlineExceededError, Google::Cloud::InternalError => ex
+        raise RetryableError.new "Google api returns error:#{ex.class.to_s} message:#{ex.to_s}"
+      end
+    end
+
+    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
+        raise Error.new "subscription:#{subscription_name} does not exist." if @client.nil?
+      end
+
+      def pull(immediate, max)
+        @client.pull immediate: immediate, max: max
+      rescue Google::Cloud::UnavailableError, Google::Cloud::DeadlineExceededError, Google::Cloud::InternalError => ex
+        raise RetryableError.new "Google pull api returns error:#{ex.class.to_s} message:#{ex.to_s}"
+      end
+
+      def acknowledge(messages)
+        @client.acknowledge messages
+      rescue Google::Cloud::UnavailableError, Google::Cloud::DeadlineExceededError, Google::Cloud::InternalError => ex
+        raise RetryableError.new "Google acknowledge api returns error:#{ex.class.to_s} message:#{ex.to_s}"
+      end
+    end
+  end
+end