fluent-plugin-ec2-metadata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5908f29a5f627257434a2f2bc851ce60bd1471a1
+  data.tar.gz: 4e47bd06fe4857a6a53f15e27ce302d3d43ef342
+SHA512:
+  metadata.gz: 0a89c1f3f296b57e23e459dc592884870fda770f3d1814840953b6f188e003710cf3242a891784adb7654dab9533fc97731c62d5f4a956a8d47775cd7dc55e9d
+  data.tar.gz: 80acb1d9eaa4e32bfd1adc418c53877d53e4341e983ff213ba1f41732d2ee7cd16fa88c421d4f04227aa057d9412e466711e3c010cd1f7de2bdff9a701497064

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-ec2-metadata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014- SAKAMOTO Takumi
+
+   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,52 @@
+# fluent-plugin-ec2-metadata
+
+Fluentd plugin to add ec2 metadata fields to a event record
+
+## Installation
+Use RubyGems:
+
+    gem install fluent-plugin-ec2-metadata
+
+## Configuration
+
+Example:
+
+    <match foo.**>
+      type ec2-metadata
+      output_tag ${instance_id}.${tag}
+
+      <record>
+        hostname ${instance_id}
+      </record>
+    </match>
+
+Assume following input is coming:
+
+```js
+foo.bar {"message":"hello ec2!"}
+```
+
+then output becomes as below (indented):
+
+```js
+i-28b5ee77.foo.bar {
+  "hostname" : "i-28b5ee77",
+  "message"  : "hello ec2!"
+}
+```
+
+### Placeholders
+
+The following placeholders are available:
+
+* ${instance_id} instance id
+* ${tag} input tag
+* ${tag_parts} input tag splitted by '.'. you can use it like `${tag_parts[0]}` or `${tag_parts[-1]}`
+
+## 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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-ec2-metadata.gemspec

@@ -0,0 +1,22 @@
+# 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-ec2-metadata"
+  spec.version       = "0.0.1"
+  spec.authors       = ["SAKAMOTO Takumi"]
+  spec.email         = ["takumi.saka@gmail.com"]
+  spec.description   = %q{Output plugin to add ec2 metadata into messages}
+  spec.summary       = %q{Output plugin to add ec2 metadata into messages}
+  spec.homepage      = "https://github.com/takus/fluent-plugin-ec2-metadata"
+  spec.license       = "APLv2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency     "fluentd"
+end

data/lib/fluent/plugin/out_ec2_metadata.rb

@@ -0,0 +1,94 @@
+module Fluent
+  class EC2MetadataOutput < Output
+    Fluent::Plugin.register_output('ec2-metadata', self)
+
+    def initialize
+      super
+      require 'net/http'
+    end
+
+    config_param :output_tag, :string
+
+    def configure(conf)
+      super
+
+      # <record></record> directive
+      @map = {}
+      conf.elements.select { |element| element.name == 'record' }.each { |element|
+        element.each_pair { |k, v|
+          element.has_key?(k)
+          @map[k] = v
+        }
+      }
+
+      @placeholder_expander = PlaceholderExpander.new
+
+      # get ec2 metadata
+      @ec2_metadata = {}
+      @ec2_metadata['instance_id'] = get_instance_id()
+    end
+
+    def emit(tag, es, chain)
+      tag_parts = tag.split('.')
+      es.each { |time, record|
+        new_tag, new_record = modify(@output_tag, record, tag, tag_parts)
+        Engine.emit(new_tag, time, new_record)
+      }
+      chain.next
+    rescue => e
+      $log.warn "ec2-metadata: #{e.class} #{e.message} #{e.backtrace.join(', ')}"
+    end
+
+    private
+
+    def get_instance_id
+        res = Net::HTTP.get_response("169.254.169.254", "/latest/meta-data/instance-id")
+        raise Fluent::ConfigError, "ec2-metadata: failed to get instance-id" unless res.is_a?(Net::HTTPSuccess)
+        raise Fluent::ConfigError, "ec2-metadata: invalid instance-id #{res.body}" unless res.body =~ /^i-\h{8}$/
+        res.body
+    end
+
+    def modify(output_tag, record, tag, tag_parts)
+      @placeholder_expander.prepare_placeholders(record, tag, tag_parts, @ec2_metadata)
+
+      new_tag = @placeholder_expander.expand(output_tag)
+
+      new_record = record.dup
+      @map.each_pair { |k, v| new_record[k] = @placeholder_expander.expand(v) }
+
+      [new_tag, new_record]
+    end
+
+    class PlaceholderExpander
+      # referenced https://github.com/fluent/fluent-plugin-rewrite-tag-filter
+      # referenced https://github.com/sonots/fluent-plugin-record-reformer
+      attr_reader :placeholders
+
+      def prepare_placeholders(record, tag, tag_parts, ec2_metadata)
+        placeholders = {
+          '${tag}' => tag,
+        }
+
+        size = tag_parts.size
+        tag_parts.each_with_index { |t, idx|
+          placeholders.store("${tag_parts[#{idx}]}", t)
+          placeholders.store("${tag_parts[#{idx-size}]}", t) # support tag_parts[-1]
+        }
+
+        ec2_metadata.each { |k, v|
+          placeholders.store("${#{k}}", v)
+        }
+
+        @placeholders = placeholders
+      end
+
+      def expand(str)
+        str.gsub(/(\${[a-z_]+(\[-?[0-9]+\])?}|__[A-Z_]+__)/) {
+          $log.warn "ec2-metadata: unknown placeholder `#{$1}` found in a tag `#{tag}`" unless @placeholders.include?($1)
+          @placeholders[$1]
+        }
+      end
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_ec2_metadata'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_ec2_metadata.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class EC2MetadataOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    output_tag ${instance_id}.${tag}
+    <record>
+      instance_id ${instance_id}
+    </record>
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::EC2MetadataOutput, tag).configure(conf)
+  end
+
+  def get_instance_id
+    Net::HTTP.get_response('169.254.169.254', '/latest/meta-data/instance-id').body
+  end
+
+  def test_emit
+    d = create_driver(CONFIG, 'foo.bar')
+
+    d.run do
+      d.emit("a" => 1)
+      d.emit("a" => 2)
+    end
+
+    instance_id = get_instance_id
+
+    # tag
+    assert_equal "#{instance_id}.foo.bar", d.emits[0][0]
+    assert_equal "#{instance_id}.foo.bar", d.emits[1][0]
+
+    # record
+    mapped = { 'instance_id' => instance_id }
+    assert_equal [
+      {"a" => 1}.merge(mapped),
+      {"a" => 2}.merge(mapped),
+    ], d.records
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-ec2-metadata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SAKAMOTO Takumi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: Output plugin to add ec2 metadata into messages
+email:
+- takumi.saka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-ec2-metadata.gemspec
+- lib/fluent/plugin/out_ec2_metadata.rb
+- test/helper.rb
+- test/plugin/test_out_ec2_metadata.rb
+homepage: https://github.com/takus/fluent-plugin-ec2-metadata
+licenses:
+- APLv2
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Output plugin to add ec2 metadata into messages
+test_files:
+- test/helper.rb
+- test/plugin/test_out_ec2_metadata.rb