fluent-plugin-kubernetes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c522ac244cb884a41b77a6042d25f223a52a4448
+  data.tar.gz: 6a8bffaabeed107e17a5f7ad4f04d3fb04823e83
+SHA512:
+  metadata.gz: a3edc748acc0b6c9cb8542bdf849f20ffbcbeed7a5e0ed3c045742e12268bc2f9d42b892e5eca11ef38d470d77b2910c2009a94ca42a89260f80e15b29aba89b
+  data.tar.gz: d881fd0b70f7d9b2b91ac27c0bc0b90a06b221b546ebcb0fcbd294f58b099f20e53d64c23aa8d6f3f546ec0dca066bc2a8e5e03bf14408ce7fa1482894cccfe3

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 yu-yamada
+
+MIT License
+
+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,52 @@
+# fluent-plugin-kubernetes, a plugin for [Fluentd](http://fluentd.org) 
+
+## Requirements
+
+Requires [fluent-plugin-docker-format](https://github.com/bwalex/fluent-plugin-docker-format)
+plugin.
+
+## Installation
+
+    gem install fluent-plugin-kubernetes
+
+## Configuration
+```
+<source>
+  type tail
+  path /var/lib/docker/containers/*/*-json.log
+  pos_file fluentd-docker.pos
+  time_format %Y-%m-%dT%H:%M:%S
+  tag docker.*
+  format json
+</source>
+
+<match docker.var.lib.docker.containers.*.*.log>
+  type docker_format
+  container_id ${tag_parts[5]}
+  tag docker.${name}
+</match>
+
+<match docker.**>
+  type kubernetes
+</match>
+
+<match kubernetes>
+  type stdout
+</match>
+```
+
+### Assuming following inputs are coming:
+    test.aa: {"container_name":"k8s_CONTAINER.2f44475a_POD.NAMESPACE.api_ae0aeb72-c44f-11e4-a274-54ee7527188d_d442134f", "json":"dayo"}
+### then output bocomes as belows
+    test.aa: {"container_name":"k8s_CONTAINER.2f44475a_POD.NAMESPACE.api_ae0aeb72-c44f-11e4-a274-54ee7527188d_d442134f", "pod":"POD", "pod_namespace":"NAMESPACE", "pod_container":"CONTAINER", "json":"dayo", "hoge":"moge","hogehoge":"mogemoge"}
+
+## 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
+
+## Copyright
+    Copyright (c) 2015 jimmidyson

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-kubernetes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# require 'fluent/plugin/add/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-kubernetes"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Jimmi Dyson"]
+  spec.email         = ["jimmidyson@gmail.com"]
+  spec.description   = %q{Output filter plugin to add Kubernetes metadata}
+  spec.summary       = %q{Output filter plugin to add Kubernetes metadata}
+  spec.homepage      = "https://github.com/jimmidyson/fluent-plugin-kubernetes"
+  spec.license       = "ASL2"
+
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.0"
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_kubernetes.rb

@@ -0,0 +1,39 @@
+require 'open3'
+
+class Fluent::KubernetesOutput < Fluent::Output
+  Fluent::Plugin.register_output('kubernetes', self)
+
+  K8S_CONTAINER_NAME_REGEX = '^[^_]+_([^\.]+)\.[^_]+_([^\.]+)\.([^\.]+)'
+
+  def initialize
+    super
+  end
+
+  def configure(conf)
+    super
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time,record|
+      Fluent::Engine.emit('kubernetes', time, enrich_record(record))
+    end
+
+    chain.next
+  end
+
+  def enrich_record(record)
+    if record.has_key? "container_name"
+      regex = Regexp.new(K8S_CONTAINER_NAME_REGEX)
+      match = record["container_name"].match(regex)
+      if match
+        pod_container_name, pod_name, pod_namespace =
+          match.captures
+        record["pod_namespace"] = pod_namespace
+        record["pod"] = pod_name
+        record["pod_container"] = pod_container_name
+      end
+    end
+    record
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,30 @@
+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 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/benchmark'
+$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_kubernetes'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_kubernetes.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class KubernetesOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::KubernetesOutput, tag).configure(conf)
+  end
+
+  def test_k8s_pod
+    d = create_driver
+
+    d.run do
+      d.emit("container_name" => "k8s_CONTAINER.ff8e9ce_POD.NAMESPACE.api_2b249189-c3e0-11e4-839d-54ee7527188d_c306d8a8")
+    end
+    mapped = {'pod' => 'POD', 'pod_namespace' => 'NAMESPACE', 'pod_container' => 'CONTAINER'}
+    assert_equal [
+      {"container_name" => "k8s_CONTAINER.ff8e9ce_POD.NAMESPACE.api_2b249189-c3e0-11e4-839d-54ee7527188d_c306d8a8"}.merge(mapped),
+    ], d.records
+
+    d.run
+  end
+
+  def test_non_k8s_container
+    d = create_driver
+
+    d.run do
+      d.emit("container_name" => "nonk8s")
+    end
+    assert_equal [
+      {"container_name" => "nonk8s"},
+    ], d.records
+
+    d.run
+  end
+
+  def bench_k8s_pod
+    input = {"container_name" => "k8s_CONTAINER.ff8e9ce_POD.NAMESPACE.api_2b249189-c3e0-11e4-839d-54ee7527188d_c306d8a8"}
+    plugin = Fluent::KubernetesOutput.new
+    plugin.configure({})
+    assert_performance_linear do |n|
+      n.times do
+        plugin.enrich_record(input)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kubernetes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmi Dyson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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 filter plugin to add Kubernetes metadata
+email:
+- jimmidyson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-kubernetes.gemspec
+- lib/fluent/plugin/out_kubernetes.rb
+- test/helper.rb
+- test/plugin/test_out_kubernetes.rb
+homepage: https://github.com/jimmidyson/fluent-plugin-kubernetes
+licenses:
+- ASL2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Output filter plugin to add Kubernetes metadata
+test_files:
+- test/helper.rb
+- test/plugin/test_out_kubernetes.rb