fluent-plugin-bunyan-to-google-cloud-logging 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fde9742100aa1d3806698f665f0ac2cff763fba1e0faa17570396202afa395a
+  data.tar.gz: 341029c271a485eb824fd50bbf40353ce39d2e5d9e2dcdf2692d88fab287fabb
+SHA512:
+  metadata.gz: d0f4557d30b1ec87a20e2b1057d881b2cc03cdef56e8fca8933620379c6cdcaafbcc69d43d8aa01946e953f4f38ca09aefb5f42d5bd5231e99e38f74c52ea183
+  data.tar.gz: 3a39a11d9635d8a2b1747cdecc44bca4aef8c47127fec687507dff7e46889c577eb0b5dc6a2478a6c7c1e4de3fd7ce813c068191c25a00031f2d25bb706dabcb

data/Gemfile

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

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 [yyyy] [name of copyright owner]
+
+   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,127 @@
+# fluent-plugin-bunyan-to-google-cloud-logging
+
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-bunyan-to-google-cloud-logging.svg)](https://badge.fury.io/rb/fluent-plugin-bunyan-to-google-cloud-logging)
+
+[Fluentd](https://www.fluentd.org/) plugin to parse [bunyan](https://www.npmjs.com/package/bunyan) format logs and to transfer Google Cloud Logging.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-bunyan-to-google-cloud-logging
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-bunyan-to-google-cloud-logging"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+### Example 1. Tailing a log file and transfering to Google Cloud Logging
+
+```
+<source>
+  @type tail
+  path /tmp/myapp.log
+  pos_file /tmp/myapp.log.pos
+  tag myapp.trace
+  <parse>
+    @type json
+    time_key time
+    time_format %FT%T.%L%z
+  </parse>
+</source>
+
+<match **>
+  @type bunyan_to_google_cloud_logging
+  project_id  'my-project-211117'
+  keyfile /etc/td-agent/secret/keyfile.json
+</match>
+```
+
+### Example 2. Receiving docker container logs and transfering to Google Cloud Logging
+
+#### /etc/td-agent/td-agent.conf
+
+```
+<source>
+  @type forward
+</source>
+
+<filter docker.**>
+  @type parser
+  format json
+  key_name log
+  time_key time
+  time_format %FT%T.%L%z
+  reserve_data yes
+</filter>
+
+<filter docker.**>
+  @type record_transformer
+  remove_keys log
+  <record>
+    time ${time}
+  </record>
+</filter>
+
+<match docker.**>
+  @type bunyan_to_google_cloud_logging
+  project_id  'high-office-001'
+  keyfile /etc/td-agent/secret/gcp-key.json
+</match>
+
+<label @ERROR>
+  <match **>
+    @type bunyan_to_google_cloud_logging
+    project_id  'high-office-001'
+    keyfile /etc/td-agent/secret/gcp-key.json
+  </match>
+</label>
+```
+
+#### docker-compose.yml 
+
+```
+version: '3'
+services:
+  yourwebapp:
+    image: registry.example.com/yourwebapp
+    logging:
+      driver: fluentd
+      options:
+        fluentd-address: "localhost:24224"
+        tag: "docker.webapp"
+    environment:
+      NODE_ENV: production
+    ports:
+      - 8080:8080
+```
+
+## Fluent::Plugin::BunyanToGoogleCloudLoggingOutput
+
+### project_id (string) (required)
+
+your Project ID on Google Cloud Platform
+
+### keyfile (string) (required)
+
+Specify the path of key json file
+https://cloud.google.com/iam/docs/creating-managing-service-account-keys
+
+## Copyright
+
+* Copyright(c) 2018- Toshimitsu Takahashi
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-bunyan-to-google-cloud-logging.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-bunyan-to-google-cloud-logging"
+  spec.version = "0.3.0"
+  spec.authors = ["Toshimitsu Takahashi"]
+  spec.email   = ["toshi@tilfin.com"]
+
+  spec.summary       = %q{Fluentd plugin to transfer bunyan format logs to Google Cloud Logging}
+  spec.description   = %q{Fluentd plugin to parse bunyan format logs and to transfer Google Cloud Logging.}
+  spec.homepage      = "https://github.com/tilfin/fluent-plugin-bunyan-to-google-cloud-logging"
+  spec.license       = "Apache-2.0"
+
+  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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+  spec.add_runtime_dependency "google-cloud-logging", "~> 1.5", ">= 1.5.1"
+end

data/lib/fluent/plugin/out_bunyan_to_google_cloud_logging.rb

@@ -0,0 +1,91 @@
+#
+# Copyright 2018- Toshimitsu Takahashi
+#
+# 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/output"
+require "google/cloud/logging"
+
+module Fluent::Plugin
+  class BunyanToGoogleCloudLoggingOutput < Fluent::Plugin::Output
+    Fluent::Plugin.register_output("bunyan_to_google_cloud_logging", self)
+
+    config_param :project_id, :string
+    config_param :keyfile, :string
+
+    def start
+      super
+
+      Google::Cloud.configure do |config|
+        config.project_id = @project_id
+        config.keyfile = @keyfile
+      end
+
+      @logging = Google::Cloud::Logging.new
+    end
+
+    def process(tag, es)
+      entries = []
+
+      es.each do |time, record|
+        msg = record.delete("msg")
+        record["message"] = msg if msg
+
+        entry = @logging.entry
+        entry.log_name = tag
+
+        labels = {}.tap do |h|
+          app_name =  record.delete("name")
+          h["app_name"] = app_name unless app_name.nil?
+
+          hostname = record.delete("hostname")
+          h["hostname"] = hostname unless hostname.nil?
+
+          pid = record.delete("pid")
+          h["pid"] = pid.to_s unless pid.nil?
+
+          v = record.delete("v")
+          h["log_version"] = v.to_s unless v.nil?
+        end
+        entry.labels = labels unless labels.empty?
+
+        entry.resource.type = "global"
+        entry.timestamp = Time.at(time.to_r)
+        entry.severity = severity(record["level"])
+        entry.payload = record
+        entries << entry
+      end
+
+      @logging.write_entries entries
+    end
+
+    private
+
+    def severity(level)
+      case level
+      when 10, 20
+        :DEBUG
+      when 30
+        :INFO
+      when 40
+        :WARNING
+      when 50
+        :ERROR
+      when 60
+        :CRITICAL
+      else
+        :DEFAULT
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+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_out_bunyan_to_google_cloud_logging.rb

@@ -0,0 +1,18 @@
+require "helper"
+require "fluent/plugin/out_bunyan_to_google_cloud_logging.rb"
+
+class BunyanToGoogleCloudLoggingOutputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  test "failure" do
+    flunk
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::BunyanToGoogleCloudLoggingOutput).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-bunyan-to-google-cloud-logging
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Toshimitsu Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-29 00:00:00.000000000 Z
+dependencies:
+- !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: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Fluentd plugin to parse bunyan format logs and to transfer Google Cloud
+  Logging.
+email:
+- toshi@tilfin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-bunyan-to-google-cloud-logging.gemspec
+- lib/fluent/plugin/out_bunyan_to_google_cloud_logging.rb
+- test/helper.rb
+- test/plugin/test_out_bunyan_to_google_cloud_logging.rb
+homepage: https://github.com/tilfin/fluent-plugin-bunyan-to-google-cloud-logging
+licenses:
+- Apache-2.0
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to transfer bunyan format logs to Google Cloud Logging
+test_files:
+- test/helper.rb
+- test/plugin/test_out_bunyan_to_google_cloud_logging.rb