fluent-plugin-gcloud-metadata 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 135a1e2e9934318488499e58501d0cee9617691a
+  data.tar.gz: dcf9c91aae07f032a25d016a01f750eb5525907e
+SHA512:
+  metadata.gz: feac76eca0f0401b2a8d2c2df41c3dfaac295a99f579e65dfd49b538c2d5834eb0d0cb078508857f4f1d81ff71c8688925327bb263825a9686677922fafad4ca
+  data.tar.gz: cccc34125a376067cf8e7e5e31687387bc5e71a5b65dc92a0a85c9d7fdcdab81b8d8d79d4dfca5a6f3768361aeed6aeca65ff377d917351643e96581b400b003

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
+.DS_Store

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.1
+
+gemfile:
+ - Gemfile
+
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-gcloud-metadata.gemspec
+gemspec
+
+gem 'simplecov', require: false
+gem 'coveralls', require: false
+gem 'strptime', require: false if RUBY_ENGINE == "ruby" && RUBY_VERSION =~ /^2/

data/README.md

@@ -0,0 +1,22 @@
+# Fluentd GoogleCloud Metadata Filter Pluging
+
+[![Build Status](https://travis-ci.org/tourstream/fluentd-plugin-gcloud-metadata.svg?branch=master)](https://travis-ci.org/tourstream/fluentd-plugin-gcloud-metadata)
+
+
+The plugin uses the google cloud metadata api in [version1](https://cloud.google.com/compute/docs/storing-retrieving-metadata)
+
+## Installation
+```bash
+gem install fluent-plugin-gcloud-metadata
+```
+
+## plugin configuration
+```
+<filter **>
+  @type gcloud_metadata
+  <metadata>
+    project_name project/project-id
+    ...
+  </metadata>
+</filter>
+```

data/Rakefile

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

data/fluent-plugin-gcloud-metadata.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'fluent-plugin-gcloud-metadata'
+  s.version       = '1.0.0'
+  s.authors       = ['engerim']
+  s.email         = ['alexander.miehe@tourstream.eu']
+  s.description   = %q{gcloud metadata filter plugin for Fluent. The Plugin adds gcloud metadata to the record }
+  s.summary       = s.description
+  s.homepage      = 'https://github.com/tourstream/fluent-plugin-gcloud-metadata'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = Gem::Requirement.new(">= 2.1".freeze)
+
+  s.add_runtime_dependency 'fluentd', '~> 0.14'
+
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'webmock', '~> 2.3'
+  s.add_development_dependency 'test-unit', '~> 3.1'
+  s.add_development_dependency 'minitest', '~> 5.8'
+  s.add_development_dependency 'vcr', '~> 3.0'
+end

data/lib/fluent/plugin/filter_gcloud_metadata.rb

@@ -0,0 +1,56 @@
+require 'fluent/filter'
+require 'net/http'
+require 'uri'
+
+module Fluent
+
+  class GcloudMetadataFilter <  Fluent::Filter
+    class ConnectionFailure < StandardError; end
+    Fluent::Plugin.register_filter('gcloud_metadata', self)
+
+    def configure(conf)
+      super
+      @map = {}
+      @cache = {}
+      # <record></record> directive
+      conf.elements.select { |element| element.name == 'metadata' }.each do |element|
+        element.each_pair do |k, v|
+          element.has_key?(k) # to suppress unread configuration warning
+          @map[k] = v
+        end
+      end
+    end
+
+    def filter(tag, time, record)
+      @map.each do |recordName, pathSegment|
+
+        if @cache.has_key?(recordName)
+          record[recordName] = @cache[recordName]
+          next
+        end
+
+        begin
+          uri = URI.parse("http://metadata.google.internal/computeMetadata/v1/#{pathSegment}")
+          request = Net::HTTP::Get.new(uri)
+          request['Metadata-Flavor'] = 'Google'
+
+          req_options = {
+              use_ssl: uri.scheme == 'https',
+          }
+
+          response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+            http.request(request)
+          end
+
+          record[recordName] = response.body
+          @cache[recordName] = record[recordName]
+        rescue => e
+          log.warn "failed to get metadata for #{recordName} from #{pathSegment}. ", error: e
+        end
+      end
+
+      record
+    end
+
+  end
+end

data/test/cassettes/metadata.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://metadata.google.internal/computeMetadata/v1/project/project-id
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Metadata-Flavor:
+      - "Google"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/text
+      Date:
+      - Fri, 08 May 2015 10:35:37 GMT
+    body:
+      encoding: UTF-8
+      string: foobar_project
+
+    http_version:
+  recorded_at: Tue, 23 May 2017 04:58:44 GMT
+
+- request:
+    method: get
+    uri: http://metadata.google.internal/computeMetadata/v1/instance/attributes/cluster-name
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Metadata-Flavor:
+      - "Google"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/text
+      Date:
+      - Fri, 08 May 2015 10:35:37 GMT
+    body:
+      encoding: UTF-8
+      string: testing
+
+    http_version:
+  recorded_at: Tue, 23 May 2017 04:58:44 GMT

data/test/helper.rb

@@ -0,0 +1,24 @@
+# simplecov must be loaded before any of target code
+#if ENV['SIMPLE_COV']
+  require 'simplecov'
+  if defined?(SimpleCov::SourceFile)
+    mod = SimpleCov::SourceFile
+    def mod.new(*args, &block)
+      m = allocate
+      m.instance_eval do
+        begin
+          initialize(*args, &block)
+        rescue Encoding::UndefinedConversionError
+          @src = "".force_encoding('UTF-8')
+        end
+      end
+      m
+    end
+  end
+  unless SimpleCov.running
+    SimpleCov.start do
+      add_filter '/test/'
+      add_filter '/gems/'
+    end
+  end
+#end

data/test/plugin/test_filter_gcloud_metadata.rb

@@ -0,0 +1,78 @@
+require_relative '../helper'
+require 'test/unit'
+require 'fluent/test'
+require 'fluent/plugin/filter_gcloud_metadata'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/cassettes'
+  config.hook_into :webmock
+end
+
+
+class TestGcloudMetadataFilter < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+      <metadata>
+        gce_project project/project-id
+        environment instance/attributes/cluster-name
+      </metadata>
+    ]
+
+  def create_driver(conf = CONFIG, tag='test.input')
+    Fluent::Test::FilterTestDriver.new(Fluent::GcloudMetadataFilter, tag).configure(conf)
+  end
+
+  def test_filter_metadata
+
+    input = {'message' => 'foobar'}
+
+    d = create_driver
+    VCR.use_cassette('metadata', :allow_unused_http_interactions => false) do
+      d.run do
+        d.filter input
+      end
+    end
+    expected = {'message' => 'foobar', 'gce_project' => 'foobar_project', 'environment' => 'testing'}
+
+    assert_equal expected, d.filtered_as_array[0][2]
+  end
+
+  def test_filter_metadata_with_cache
+
+    inputs = [
+        {'message' => 'foobar'},
+        {'message' => 'foobar2'},
+    ]
+
+    d = create_driver
+    VCR.use_cassette('metadata', :allow_unused_http_interactions => false) do
+      d.run do
+        inputs.each do |dat|
+          d.filter dat
+        end
+      end
+    end
+    expected = {'message' => 'foobar2', 'gce_project' => 'foobar_project', 'environment' => 'testing'}
+
+    assert_equal expected, d.filtered_as_array[1][2]
+  end
+
+  def test_filter_return_orignal_record_for_error
+
+    input = {'message' => 'foobar'}
+
+    d = create_driver
+    d.run do
+      d.filter input
+    end
+
+    expected = {'message' => 'foobar'}
+
+    assert_equal expected, d.filtered_as_array[0][2]
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-gcloud-metadata
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- engerim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+description: 'gcloud metadata filter plugin for Fluent. The Plugin adds gcloud metadata
+  to the record '
+email:
+- alexander.miehe@tourstream.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- fluent-plugin-gcloud-metadata.gemspec
+- lib/fluent/plugin/filter_gcloud_metadata.rb
+- test/cassettes/metadata.yml
+- test/helper.rb
+- test/plugin/test_filter_gcloud_metadata.rb
+homepage: https://github.com/tourstream/fluent-plugin-gcloud-metadata
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: gcloud metadata filter plugin for Fluent. The Plugin adds gcloud metadata
+  to the record
+test_files:
+- test/cassettes/metadata.yml
+- test/helper.rb
+- test/plugin/test_filter_gcloud_metadata.rb