fluent-plugin-bunyan 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f1d27ed2bb3fd6efe6d8a60caacf5e53a3da13c08e72ad217514f93d20b2b4d
+  data.tar.gz: 83fac6065435fb21ec697cea73673830f97387155bdae69859ce53596769014b
+SHA512:
+  metadata.gz: a09cbfb473f5cf39bdba75fb25d83e7962d2348d4b76bc2f8026ff0bbbb208b585f47ea70c87610ae0297c4aae6bb827d75b04eb554ac7e828a1c9e19a4ec13e
+  data.tar.gz: c1b768920ca490d12ecc6d6dc40a16915d4c1d1c5f9080954eb9cdbdffebad70a239b51bc3d297643607f74085727b191bf7ed7b577956ff0d2bff14eb30a60e

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+This file contains changes throughout the life of this project.
+
+### Development
+[Full Changelog](https://github.com/gildas/fluent-plugin-bunyan/compare/v0.0.2...dev)
+
+New Features:
+* None Yet
+
+Bug Fixes:  
+* None Yet
+
+### [0.0.2] / 2020-03-10
+
+Bug Fixes:
+* The GEM spec requires rake version 12.3.3 at least. 
+  There is a vulnerability before rake 12.3.3: [CVE-2020-8130](https://github.com/advisories/GHSA-jppv-gw3r-w3q8).  
+  We just should be on the safe side...
+
+### [0.0.1] / 2020-03-10
+
+Initial Release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-bunyan (0.1.0)
+      fluentd (>= 0.14.10, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.6)
+    cool.io (1.6.0)
+    fluentd (1.9.3)
+      cool.io (>= 1.4.5, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 1.3.1, < 2.0.0)
+      serverengine (>= 2.0.4, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.6.0)
+    msgpack (1.3.3)
+    power_assert (0.2.7)
+    rake (13.0.1)
+    serverengine (2.2.1)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.3)
+    test-unit (3.2.5)
+      power_assert
+    tzinfo (2.0.1)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2019.3)
+      tzinfo (>= 1.0.0)
+    yajl-ruby (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  fluent-plugin-bunyan!
+  rake (>= 12.3.3)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Gildas Cherruel
+
+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,44 @@
+# fluent-plugin-bunyan
+
+[Fluentd](https://fluentd.org/) parser plugin to process logs from applications that write [bunyan](https://github.com/gildas/go-logger/blob/master/trentm/node-bunyan) logs.
+
+The plugin requires [Fluentd](https://fluentd.org/) 1.0 at least.
+
+|  |   |
+---|---|
+master | [![Build Status](https://dev.azure.com/keltiek/gildas/_apis/build/status/gildas.fluent-plugin-bunyan?branchName=master)](https://dev.azure.com/keltiek/gildas/_build/latest?definitionId=4&branchName=master)
+dev | [![Build Status](https://dev.azure.com/keltiek/gildas/_apis/build/status/gildas.fluent-plugin-bunyan?branchName=dev)](https://dev.azure.com/keltiek/gildas/_build/latest?definitionId=4&branchName=dev)
+
+## Installation
+
+Pretty straight forward:  
+```console
+$ gem install fluent-plugin-bunyan
+```
+
+## Configuration
+
+Simply add the parser to the [Fluentd](https://fluentd.org/) configuration file, for example:
+
+```xml
+<source>
+  @type tail # say the logs come from stdout
+  <parse>
+    @type bunyan
+  </parse>
+</source>
+```
+
+## Testing
+
+To run the unit tests, make sure you have the [Fluentd](https://fluentd.org/) gem installed and run:
+
+```console
+bundle exec rake test
+```
+
+## Copyright
+
+* Copyright(c) 2020- Gildas Cherruel
+* 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/azure-pipelines.yml

@@ -0,0 +1,24 @@
+# Ruby
+# Package your Ruby project.
+# Add steps that install rails, analyze code, save build artifacts, deploy, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/ruby
+
+trigger:
+- master
+- dev
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+steps:
+- task: UseRubyVersion@0
+  inputs:
+    versionSpec: '>= 2.5'
+
+- script: |
+    gem install bundler -v 1.16.1
+    bundle install --retry=3 --jobs=4
+  displayName: 'bundle install'
+
+- script: bundle exec rake
+  displayName: 'bundle exec rake'

data/fluent-plugin-bunyan.gemspec

@@ -0,0 +1,31 @@
+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"
+  spec.version = "0.0.2"
+  spec.authors = ["Gildas Cherruel"]
+  spec.email   = ["gildas@breizh.org"]
+
+  spec.summary       = %q{Fluentd Parser for applications that produce [Bunyan](https://github.com/trentm/node-bunyan) logs.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/gildas/fluent-plugin-bunyan"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "https://github.com/gildas/fluent-plugin-bunyan/blob/master/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", "~> 1.14"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/parser_bunyan.rb

@@ -0,0 +1,54 @@
+#
+# Copyright 2020- Gildas Cherruel
+#
+# 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/parser"
+#require "fluent/parser"
+
+module Fluent
+  module Plugin
+    class BunyanParser < JSONParser
+      Fluent::Plugin.register_parser("bunyan", self)
+
+      def configure(conf)
+        conf["time_format"] = "%iso8601"
+        super(conf)
+      end
+
+      def parse(text)
+        super(text) do |time, record|
+          record["severity"] = severity(record["level"] || 0)
+          record["host"]     = record.delete("hostname")
+          record["message"]  = record.delete("msg")
+
+          record.delete("v")
+          yield time, record
+        end
+      end
+
+      def severity(level)
+        return "fatal" if level >= 60
+        return "error" if level >= 50
+        return "warn"  if level >= 40
+        return "info"  if level >= 30
+        return "debug" if level >= 20
+        return "trace"
+      end
+
+      def version
+        return "0.0.2"
+      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/parser"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_parser_bunyan.rb

@@ -0,0 +1,89 @@
+require "helper"
+require "fluent/plugin/parser_bunyan.rb"
+
+class BunyanParserTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    pattern apache
+  ]
+
+  sub_test_case "parse" do
+    test "can parse simple entry" do
+      driver = create_driver(CONFIG)
+      text = '{"hostname":"helloworld-go-helloworld-5649dfd7bd-k8954","level":30,"msg":"The message","name":"helloworld","pid":1,"scope":"main","tid":1,"time":"2020-03-10T07:08:41Z","topic":"main","v":0}'
+      expected_time   = Time.utc(2020, 3, 10, 7, 8, 41).to_i
+      expected_record = {
+        "host"     => "helloworld-go-helloworld-5649dfd7bd-k8954",
+        "name"     => "helloworld",
+        "severity" => "info",
+        "level"    => 30,
+        "message"  => "The message",
+        "topic"    => "main",
+        "scope"    => "main",
+        "pid"      => 1,
+        "tid"      => 1,
+      }
+      driver.instance.parse(text) do |time, record|
+        assert_equal(expected_record, record)
+        assert_equal(expected_time,   time)
+      end
+    end
+
+    test "can parse entry with custom properties" do
+      driver = create_driver(CONFIG)
+      text = '{"hostname":"helloworld-go-helloworld-5649dfd7bd-k8954","level":50,"msg":"Failed to be happy","name":"helloworld","pid":1,"reqid":"0ba850ff-1e1f-4bcf-8288-135927bb850f","scope":"start","tid":21,"time":"2020-03-10T15:04:19Z","topic":"server","v":0}'
+      expected_time   = Time.utc(2020, 3, 10, 15, 4, 19).to_i
+      expected_record = {
+        "host"     => "helloworld-go-helloworld-5649dfd7bd-k8954",
+        "name"     => "helloworld",
+        "severity" => "error",
+        "level"    => 50,
+        "message"  => "Failed to be happy",
+        "topic"    => "server",
+        "scope"    => "start",
+        "pid"      => 1,
+        "tid"      => 21,
+        "reqid"    => "0ba850ff-1e1f-4bcf-8288-135927bb850f",
+      }
+      driver.instance.parse(text) do |time, record|
+        assert_equal(expected_record, record)
+        assert_equal(expected_time,   time)
+      end
+    end
+
+    test "can parse entry with complex custom properties" do
+      driver = create_driver(CONFIG)
+      text = '{"hostname":"helloworld-go-helloworld-5649dfd7bd-k8954","level":50,"msg":"Failed to be happy","name":"helloworld","pid":1,"err":{"text": "aouch", "code": 404},"reqid":"0ba850ff-1e1f-4bcf-8288-135927bb850f","scope":"start","tid":21,"time":"2020-03-10T15:04:19Z","topic":"server","v":0}'
+      expected_time   = Time.utc(2020, 3, 10, 15, 4, 19).to_i
+      expected_record = {
+        "host"     => "helloworld-go-helloworld-5649dfd7bd-k8954",
+        "name"     => "helloworld",
+        "severity" => "error",
+        "level"    => 50,
+        "message"  => "Failed to be happy",
+        "topic"    => "server",
+        "scope"    => "start",
+        "pid"      => 1,
+        "tid"      => 21,
+        "reqid"    => "0ba850ff-1e1f-4bcf-8288-135927bb850f",
+        "err"      => {
+          "code" => 404,
+          "text" => "aouch",
+        },
+      }
+      driver.instance.parse(text) do |time, record|
+        assert_equal(expected_record, record)
+        assert_equal(expected_time,   time)
+      end
+    end
+  end
+
+  private
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Parser.new(Fluent::Plugin::BunyanParser).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-bunyan
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Gildas Cherruel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-10 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.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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'
+description: Fluentd Parser for applications that produce [Bunyan](https://github.com/trentm/node-bunyan)
+  logs.
+email:
+- gildas@breizh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- azure-pipelines.yml
+- fluent-plugin-bunyan.gemspec
+- lib/fluent/plugin/parser_bunyan.rb
+- test/helper.rb
+- test/plugin/test_parser_bunyan.rb
+homepage: https://github.com/gildas/fluent-plugin-bunyan
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gildas/fluent-plugin-bunyan
+  source_code_uri: https://github.com/gildas/fluent-plugin-bunyan
+  changelog_uri: https://github.com/gildas/fluent-plugin-bunyan/blob/master/CHANGELOG.md
+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 Parser for applications that produce [Bunyan](https://github.com/trentm/node-bunyan)
+  logs.
+test_files:
+- test/helper.rb
+- test/plugin/test_parser_bunyan.rb