fluent-plugin-json_expander 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd0e91d385a1c563f4eeda19098692538e510d20
+  data.tar.gz: 1c35f48f84214ab5e9e1c3b872c7852b19631f80
+SHA512:
+  metadata.gz: 3b6fdbddb5dd1aaed2317c129fd1f1fa66c6cc66cfac2f8cf407fdd49e8ef04ceba667270f261026a7d8bc3dae574e7113a63a7dfc20bf7f2f7de7244f12b634
+  data.tar.gz: dc05731acc6313db0faad2074543cd1036be1c56343dabfa60a14ec5c61ca484cd49a1d33deb7614eb5b8735f05d29cfea9e27504dccfaf564f445082f4018e4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+
+before_install: gem install bundler -v 1.10.6
+
+script: bundle exec rake test
+
+notifications:
+  slack:
+    secure: S3CV6glzkzmVCEmXv0/mqizzBdGJk7btU2Y2pqP9V5JuQO/5ememCSxbmqcbMiO6CLRUIObFxhUxlWpvZspauQVX6xNMPZPgoTM9Ma5a+kxYkXc/7izbCqEhaqO8Qf2J78Ly5osqE4DtzYjQ6An85dDJ2mrhbuOrNINJkzL4x34jZgxLfNUIzcn1yC/MOstLqSWBPeSWUmh/cL8Jb74q+vLSYY5QdZvnGtxUvf8kWK/dfaT9xU9TUU+axdRJRT7VZqXEUtkuwhAEUElGNOFNuPUK95pxtGujVI+TI5s4+wq9rBRINGULpXQZh897pvHyAqGApxz/yxt/tsLGRT+B0Jn2EJ5J0eA0Aaew8Zwzp5Vpa3Q07jxr5EvGEWEHlNO1fTkg+SFE3EZO+I+0Mvlsqc1le8clGcssPyUCNl/ddvtbIR4QpcYf+JxE7YVgKCPGMdHQrmfTiqiuYfp6XhIiW5dcXa4WwT4/aCW0C/DtxMj74MZOfuMKGzyAOIQem/KZnxQj9zQG55ofCyUxjWUcdqHeLaHvVhOf5SX9O5CGyO1tpFW54Lj3nXO5EuJNj+pxIMVLPuP4oUkDN5xbMYF8IrNfYkXpOYJCvUpALmU7F9CfuNkJQwgDA3nQl4ptby8s/Ml8NzDPJnXxFVjF2hXocgHYy8Kqa344PleBpOG+da0=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-json_expander.gemspec
+gemspec
+
+gem "pry"
+gem "travis"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Uchio KONDO
+
+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,71 @@
+# fluent-plugin-json_expander
+
+[![Build Status](https://travis-ci.org/udzura/fluent-plugin-json_expander.svg?branch=master)](https://travis-ci.org/udzura/fluent-plugin-json_expander)
+
+## Installation
+
+Install it yourself as:
+
+    $ fluent-gem install fluent-plugin-json_expander
+
+## Usage
+
+```xml
+<match access.summary>
+  type json_expander
+  subtype growthforecast
+  delete_used_key false # or true if you want to delete the key
+                        # used in template construction
+
+  <template>
+    gfapi_url http://127.0.0.1:5125/api/
+    graph_path ${data[mothor_host]}/${data[vhost]}/${key_name}
+    name_keys count_2xx,count_3xx,count_4xx,count_5xx
+  </template>
+</match>
+```
+
+With data:
+
+```json
+// tag = access.summary
+{
+  "mother_host": "kvm001.udzura.jp",
+  "vhost": "front.udzura.com",
+  "count_2xx": 1234,
+  "count_3xx": 567,
+  "...": "..."
+}
+```
+
+Will extracted to below:
+
+```xml
+<match>
+  type growthforecast
+  gfapi_url http://127.0.0.1:5125/api/
+  graph_path kvm001.udzura.jp/front.udzura.com/${key_name}
+  name_keys count_2xx,count_3xx,count_4xx,count_5xx
+</match>
+```
+
+### Options
+
+* `delete_used_key` - Deletes the key in the data when it is used to expand. Default: `false`
+* `handle_empty_as_error` - Raise error that the value for the specified key is empty in template. Default: `false`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/udzura/fluent-plugin-json_expander. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.description = "Run #{File.basename(Dir.pwd)}'s test suite"
+  # To run test for only one file (or file path pattern)
+  #  $ bundle exec rake test TEST=test/test_specified_path.rb
+  t.libs.concat ["test"]
+  t.test_files = Dir["test/**/test_*.rb"]
+  t.verbose = true
+  t.ruby_opts = ["-r config"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/jsonbreak"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-json_expander.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-json_expander"
+  spec.version       = "0.0.1.pre"
+  spec.authors       = ["Uchio KONDO"]
+  spec.email         = ["udzura@udzura.jp"]
+
+  spec.summary       = %q{Run the sub-matcher created from accepted json data}
+  spec.description   = %q{Run the sub-matcher created from accepted json data}
+  spec.homepage      = "https://github.com/udzura/fluent-plugin-json_expander"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "test-unit", ">= 3"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency "power_assert"
+end

data/lib/fluent/plugin/out_json_expander.rb

@@ -0,0 +1,126 @@
+class Fluent::JsonExpanderOutput < Fluent::MultiOutput
+  Fluent::Plugin.register_output('json_expander', self)
+
+  config_param :subtype,       :string
+  config_param :remove_prefix, :string, :default => nil
+  config_param :add_prefix,    :string, :default => nil
+
+  config_param :delete_used_key,       :bool, :default => false
+  config_param :handle_empty_as_error, :bool, :default => false
+
+  attr_reader :outputs
+
+  # Define `log` method for v0.10.42 or earlier
+  unless method_defined?(:log)
+    define_method("log") { $log }
+  end
+
+  def configure(conf)
+    super
+
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    if @add_prefix
+      @added_prefix_string = @add_prefix + '.'
+    end
+
+    @outputs = []
+    @mutex = Mutex.new
+
+    templates = conf.elements.select{|e| e.name == 'template' }
+    if templates.size != 1
+      raise Fluent::ConfigError, "Just 1 template must be contained"
+    end
+
+    @template = templates.first
+  end
+
+  def emit(tag, es, chain)
+    if @remove_prefix and
+        ((tag.start_with?(@removed_prefix_string) and tag.length > @removed_length) or tag == @remove_prefix)
+      tag = tag[@removed_length..-1]
+    end
+    if @add_prefix
+      tag = tag.empty? ? (@added_prefix_string + tag) : @add_prefix
+    end
+
+    es.each {|time, record|
+      output = new_output(record)
+      if output
+        dup_es = Fluent::ArrayEventStream.new([[time, record]])
+        null_chain = Fluent::NullOutputChain.instance
+        output.emit(tag, dup_es, null_chain)
+      end
+    }
+    chain.next
+  end
+
+  private
+
+  def new_output(data)
+    o = nil
+    t = @template
+    begin
+      @mutex.synchronize do
+        if e = expand_elm(t, data)
+          o = Fluent::Plugin.new_output(@subtype)
+          o.configure(e)
+          o.start
+
+          @outputs.push(o)
+        end
+      end
+
+      log.info "[out_json_expand] Expanded new output: #{@subtype}"
+    rescue Fluent::ConfigError => e
+      log.error "failed to configure sub output #{@subtype}: #{e.message}"
+      log.error e.backtrace.join("\n")
+      log.error "Cannot output messages with data #{data.inspect}"
+      o = nil
+    rescue StandardError => e
+      log.error "failed to configure/start sub output #{@subtype}: #{e.message}"
+      log.error e.backtrace.join("\n")
+      log.error "Cannot output messages with data #{data.inspect}"
+      o = nil
+    end
+
+    return o
+  end
+
+  SCAN_DATA_RE = /\$\{data\[(?:[_a-zA-Z][_a-zA-Z0-9]*)\]\}/
+  SCAN_KEY_NAME_RE = /\[([_a-zA-Z][_a-zA-Z0-9]*)\]/
+
+  def expand_elm(template, data)
+    attr = {}
+    template.each do |k, v|
+      v = v.gsub(SCAN_DATA_RE) do |matched|
+        key_matched = matched.scan(SCAN_KEY_NAME_RE)[0]
+        if !key_matched or !key_matched[0]
+          raise(Fluent::ConfigError, "[BUG] data matched in template, but could not find key name")
+        end
+        if @handle_empty_as_error
+          k = key_matched[0]
+          data[k] || mark_errored(k, data)
+        else
+          data[key_matched[0]] || ""
+        end
+      end
+      attr[k] = v
+    end
+    # Expand recursively
+    sub_elms = template.elements.map {|e| expand_elm(data) }
+
+    if @mark_errored
+      nil
+    else
+      Fluent::Config::Element.new('instance', '', attr, sub_elms)
+    end
+  end
+
+  def mark_errored(k, data)
+    log.error "Could not find value for `#{k}' in data #{data.inspect}, Fluentd skips this"
+    @mark_errored = true
+  end
+end

data/lib/fluent/plugin/testing/out_echopool.rb

@@ -0,0 +1,22 @@
+class Fluent::EchoPoolOutput < Fluent::Output
+  class << self
+    def echopool
+      @echopool ||= []
+    end
+  end
+
+  Fluent::Plugin.register_output('echopool', self)
+
+  config_param :message, :string
+
+  def emit(tag, es, chain)
+    es.each {|time, record|
+      self.class.echopool.push({
+        message: @message,
+        record:  record,
+        tag:     tag
+      })
+    }
+    chain.next
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-json_expander
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Uchio KONDO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run the sub-matcher created from accepted json data
+email:
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-json_expander.gemspec
+- lib/fluent/plugin/out_json_expander.rb
+- lib/fluent/plugin/testing/out_echopool.rb
+homepage: https://github.com/udzura/fluent-plugin-json_expander
+licenses:
+- MIT
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Run the sub-matcher created from accepted json data
+test_files: []