fluent-plugin-formatter-protobuf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d8d0f38e949a78909ca9396248df0f460dc3ac8901f66b5fa2f438da5284b0c
+  data.tar.gz: d74cb1a9098d00115b0b4bbe64355f853e3aa2d89b77a888014aabc70d22e2d8
+SHA512:
+  metadata.gz: 4fdd5e38190985d2c1b10959b4ff5bd9729b82a4877647ee3b2d4e7c8bf0e05657686c560810cf6398bf256a537caccdc4ab9c5bf118dc1bfd6f0684d5483a8f
+  data.tar.gz: 34d8144ccb7a304eacd70034ad9e57e7b317d2eca459bb07bfe5295aa925baad00f45d78e89f385210450ac6cb2a41e443172ae697df6fdc29ec271a06062203

data/.github/workflows/gem-push.yml

@@ -0,0 +1,19 @@
+name: Publish Package
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.5
+      - uses: actions/setup-node@v2.4.1
+        with:
+          node-version: "16"
+      - uses: ruby/setup-ruby@v1.83.0
+        with:
+          ruby-version: "2.7.1"

data/.gitignore

@@ -0,0 +1,2 @@
+yarn-error.log
+node_modules

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  NewCops: enable
+Style/StringLiterals:
+  Exclude:
+    - 'test/proto/addressbook_pb.rb'
+Style/HashSyntax:
+  Exclude:
+    - 'test/proto/addressbook_pb.rb'
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'test/proto/addressbook_pb.rb'
+Metrics/MethodLength:
+  Max: 100

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-formatter-protobuf (0.0.1)
+      fluentd (>= 1.0, < 2)
+      google-protobuf (~> 3.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.9)
+    cool.io (1.7.1)
+    fluentd (1.14.1)
+      bundler
+      cool.io (>= 1.4.5, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.8.0)
+      msgpack (>= 1.3.1, < 2.0.0)
+      serverengine (>= 2.2.2, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      webrick (>= 1.4.2, < 1.8.0)
+      yajl-ruby (~> 1.0)
+    google-protobuf (3.18.1-x86_64-linux)
+    http_parser.rb (0.7.0)
+    msgpack (1.4.2)
+    power_assert (2.0.1)
+    rake (13.0.6)
+    serverengine (2.2.4)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.5)
+    test-unit (3.3.9)
+      power_assert
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2021.3)
+      tzinfo (>= 1.0.0)
+    webrick (1.7.0)
+    yajl-ruby (1.4.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2.22)
+  fluent-plugin-formatter-protobuf!
+  rake (~> 13.0.3)
+  test-unit (~> 3.3.7)
+
+BUNDLED WITH
+   2.2.29

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Ray Tung
+
+   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,41 @@
+# fluent-plugin-formatter-protobuf
+
+[Fluentd](https://fluentd.org/) formatter plugin to format messages into Protobuf v3 encoded binary.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-formatter-protobuf
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-formatter-protobuf"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+You can generate configuration template:
+
+```
+$ fluent-plugin-config-format formatter formatter-protobuf
+```
+
+You can copy and paste generated documents here.
+
+## Copyright
+
+* Copyright(c) 2021 - Ray Tung
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.libs.push('lib', 'test')
+    t.test_files = FileList['test/**/test_*.rb']
+    t.verbose = true
+    t.warning = true
+  end
+end
+
+namespace :generate do
+  desc 'Generates golden file for testing'
+  task :golden do
+    sh '\
+cat ./test/proto/addressbook | \
+protoc \
+  --encode=tutorial.AddressBook \
+  --proto_path=./test/proto/ \
+  ./test/proto/addressbook.proto \
+  > ./test/proto/addressbook.bin'
+  end
+
+  desc 'Generates Ruby Protobuf classes'
+  task :proto do
+    sh 'protoc --proto_path=./test/proto --ruby_out=./test/proto ./test/proto/addressbook.proto   '
+  end
+end
+
+namespace :lint do
+  desc 'Linting'
+  task :check do
+    sh 'rubocop'
+  end
+
+  desc 'Auto correcting lint errors'
+  task :fix do
+    sh 'rubocop --auto-correct'
+  end
+end
+
+desc 'Listing all tasks'
+task :help do
+  sh 'rake --tasks'
+end
+
+task default: [:help]

data/docker-compose.yaml

@@ -0,0 +1,19 @@
+version: '3.9'
+services:
+  ruby:
+    image: ruby:2.7.1
+    working_dir: "/opt/fluent-plugin-formatter-protobuf/"
+    volumes:
+      - ".:/opt/fluent-plugin-formatter-protobuf/"
+      - "${PWD}/cache/gem/specs:/root/.local/share/gem/specs"
+      - "${PWD}/cache/gem/ruby/2.7.1:/root/.local/share/gem/ruby/2.7.1"
+      - "${PWD}/cache/bundle/:/usr/local/bundle"
+
+  protoc:
+    image: jaegertracing/protobuf:0.3.1
+    working_dir: "/opt/fluent-plugin-formatter-protobuf/"
+    volumes:
+      - ".:/opt/fluent-plugin-formatter-protobuf/"
+      - "${PWD}/cache/gem/specs:/root/.local/share/gem/specs"
+      - "${PWD}/cache/gem/ruby/2.7.1:/root/.local/share/gem/ruby/2.7.1"
+      - "${PWD}/cache/bundle/:/usr/local/bundle"

data/docker-run.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(dirname "$0")"
+
+WORK_DIR="/opt/fluent-plugin-formatter-protobuf/"
+GEMSPEC_CACHE_DIR="/root/.local/share/gem/specs"
+GEM_PATHS="/root/.local/share/gem/ruby/3.0.0"
+INSTALLATION_DIR="/usr/local/bundle"
+PROJECT_CACHE="${PWD}/cache/"
+
+docker run \
+  -it \
+  --rm \
+  -v "${PWD}:${WORK_DIR}" \
+  -v "${PROJECT_CACHE}/gem/specs:${GEMSPEC_CACHE_DIR}" \
+  -v "${PROJECT_CACHE}/gem/ruby/3.0.0/:${GEM_PATHS}" \
+  -v "${PROJECT_CACHE}/bundle/:${INSTALLATION_DIR}" \
+  --workdir "${WORK_DIR}" \
+  ruby:3.0.2 "$@"

data/fluent-plugin-formatter-protobuf.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluent/plugin/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'fluent-plugin-formatter-protobuf'
+  spec.version = Fluent::Plugin::ProtobufFormatter::VERSION
+  spec.authors = ['Ray Tung']
+  spec.email = ['code@raytung.net']
+
+  spec.summary = 'Protobuf formatter for Fluentd'
+  spec.description = 'This is a Fluentd formatter plugin designed to convert Protobuf JSON into Protobuf binary'
+  spec.homepage = 'https://github.com/raytung/fluent-plugin-formatter-protobuf'
+  spec.license = 'Apache-2.0'
+  spec.required_ruby_version = Gem::Requirement.new('>=2.7.1')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/raytung/fluent-plugin-formatter-protobuf'
+  spec.metadata['changelog_uri'] = 'https://github.com/raytung/fluent-plugin-formatter-protobuf/blobl/main/CHANGELOG.md'
+
+  test_files, files = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files = files
+  spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = test_files
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.2.22'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'test-unit', '~> 3.3.7'
+  spec.add_runtime_dependency 'fluentd', ['>= 1.0', '< 2']
+  spec.add_runtime_dependency 'google-protobuf', ['~> 3.18']
+end

data/lib/fluent/plugin/formatter_protobuf.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+#
+# Copyright 2021-Ray Tung
+#
+# 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 'fluent/plugin/formatter'
+
+require 'pathname'
+require 'google/protobuf'
+require 'protocol_buffers'
+
+require 'fluent/env'
+require 'fluent/time'
+
+module Fluent
+  module Plugin
+    # ProtobufFormatter for Fluentd
+    class ProtobufFormatter < Fluent::Plugin::Formatter
+      Fluent::Plugin.register_formatter('protobuf', self)
+
+      # Absolute paths to the generated Ruby protobuf files
+      config_param :include_paths, :array, default: []
+
+      # Protobuf message name
+      config_param :message_name, :string
+
+      def configure(conf)
+        super(conf)
+
+        raise Fluent::ConfigError, "Missing 'include_paths'" if @include_paths.empty?
+
+        @include_paths.each { |path| require_proto!(path) } unless @include_paths.empty?
+
+        message_lookup = Google::Protobuf::DescriptorPool.generated_pool.lookup(@message_name)
+        raise Fluent::ConfigError, "message name '#{@message_name}' not found" if message_lookup.nil?
+
+        @protobuf_class = message_lookup.msgclass
+      end
+
+      def format(_tag, _time, record)
+        protobuf_msg = @protobuf_class.new(record)
+        @protobuf_class.encode(protobuf_msg)
+      end
+
+      # @param [string] filename
+      # @return [void]
+      def require_proto!(filename)
+        unless filename.end_with?('.rb')
+          raise Fluent::ConfigError, "Unable to load file '#{filename}'. It is not a Ruby file"
+        end
+
+        unless Pathname.new(filename).absolute?
+          raise Fluent::ConfigError, "Unable to load file '#{filename}'. Please provide absolute paths"
+        end
+
+        begin
+          require filename
+        rescue LoadError => e
+          raise Fluent::ConfigError, "Unable to load file '#{filename}'. Reason: #{e.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/fluent/plugin/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Fluent
+  module Plugin
+    module ProtobufFormatter
+      VERSION = '0.0.1'
+    end
+  end
+end

data/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "fluent-plugin-formatter-protobuf",
+  "version": "0.0.1",
+  "description": "Protobuf formatter for Fluentd",
+  "main": "dist/index.js",
+  "repository": "git@github.com:raytung/fluent-plugin-formatter-protobuf.git",
+  "author": "Ray Tung <code@raytung.net>",
+  "license": "Apache-2.0",
+  "private": false,
+  "scripts": {
+    "release": "semantic-release"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.0",
+    "@semantic-release/commit-analyzer": "^9.0.1",
+    "@semantic-release/git": "^10.0.0",
+    "@semantic-release/github": "^8.0.1",
+    "@semantic-release/npm": "^8.0.0",
+    "@semantic-release/release-notes-generator": "^10.0.2",
+    "semantic-release": "^18.0.0",
+    "semantic-release-rubygem": "^1.2.0"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      [
+        "@semantic-release/npm",
+        {
+          "npmPublish": false
+        }
+      ],
+      [
+        "semantic-release-rubygem",
+        {
+          "updateGemfileLock": true
+        }
+      ],
+      "@semantic-release/changelog",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json",
+            "yarn.lock",
+            "lib/fluent/plugin/version.rb",
+            "CHANGELOG.md"
+          ],
+          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ],
+      "@semantic-release/github"
+    ]
+  }
+}

data/test/helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('..', __dir__))
+require 'test-unit'
+require 'fluent/test'
+require 'fluent/test/driver/formatter'
+require 'fluent/test/helpers'
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)