fluent-plugin-rancher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43a15167cc445c2c3d4337de1563f2fce60ea59b
+  data.tar.gz: fe4eb713ffdb23c2789b685ee9c7bd7db70e12eb
+SHA512:
+  metadata.gz: ae19b3bcdd897fef96221d362bea736cf82d0821609a6fee7a406b01336a1887ae466720bdfcad804b7a01a49c4aa5d23a4ce4c846d834754cc32a90ed2c4467
+  data.tar.gz: de0f424fa36e434c4cd67b8759f7b6b3ec168829bf0dee6b1f896d8b40a40946bbc0cd2bbfddb15c9241f225c5d6d4a0ed6ff2bdf346e12265aaccc33b4fa61e

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,8 @@
+source 'https://rubygems.org'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+gem 'test-unit'
+
+# Specify your gem's dependencies in fluent-plugin-add.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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,106 @@
+# fluent-plugin-kubernetes, a plugin for [Fluentd](http://fluentd.org)
+[![Circle CI](https://circleci.com/gh/fabric8io/fluent-plugin-kubernetes.svg?style=svg)](https://circleci.com/gh/fabric8io/fluent-plugin-kubernetes)
+[![Code Climate](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes/badges/gpa.svg)](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes)
+[![Test Coverage](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes/badges/coverage.svg)](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes)
+
+## 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
+  read_from_head true
+</source>
+
+<match docker.var.lib.docker.containers.*.*.log>
+  type kubernetes
+  container_id ${tag_parts[5]}
+  tag docker.${name}
+</match>
+
+<match kubernetes>
+  type stdout
+</match>
+```
+
+Docker logs in JSON format. Log files are normally in
+`/var/lib/docker/containers/*/*-json.log`, depending on what your Docker
+data directory is.
+
+Assuming following inputs are coming from a log file:
+0bbc558cca13c5a92cc59f33626db0aaa2afea24742d2fbe549e3a30faf7ab09-json.log:
+```
+{
+  "log": "Something happened\n",
+  "stream": "stdout",
+  "time": "2015-03-07T20:04:17.604503223Z"
+}
+```
+
+Then output becomes as belows
+```
+{
+  "log": "Something happened\n",
+  "stream": "stdout",
+  "time": "2015-03-07T20:04:17.604503223Z"
+  "container_id": "0bbc558cca13c5a92cc59f33626db0aaa2afea24742d2fbe549e3a30faf7ab09",
+  "container_name": "k8s_CONTAINER.2f44475a_POD.NAMESPACE.api_ae0aeb72-c44f-11e4-a274-54ee7527188d_d442134f",
+  "pod": "POD",
+  "pod_namespace": "NAMESPACE",
+  "pod_container": "CONTAINER"
+}
+```
+
+## JSON logging
+
+Logging requires context to be really useful. Context can either be derived
+from log lines from known formats, but this is error prone & requires
+processing power. The logging application is the best place to add
+context.
+
+If you use JSON for your application logs you can add context to your logs
+as you go. This plugin will parse your log lines & if it sees that they are
+JSON it will merge it in to the top level record so your contextual logging
+will be nicely searchable.
+
+Something like this:
+
+```
+{
+  "log": "{\"context\":\"something\"}",
+  "stream": "stdout",
+  "time": "2015-03-07T20:04:17.604503223Z"
+}
+```
+
+Then output becomes as belows
+```
+{
+  "context": "something",
+  "stream": "stdout",
+  "time": "2015-03-07T20:04:17.604503223Z"
+  "container_id": "0bbc558cca13c5a92cc59f33626db0aaa2afea24742d2fbe549e3a30faf7ab09",
+  "container_name": "k8s_CONTAINER.2f44475a_POD.NAMESPACE.api_ae0aeb72-c44f-11e4-a274-54ee7527188d_d442134f",
+  "pod": "POD",
+  "pod_namespace": "NAMESPACE",
+  "pod_container": "CONTAINER"
+}
+```
+
+## 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,29 @@
+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
+
+desc "Add copyright headers"
+task :headers do
+  require 'rubygems'
+  require 'copyright_header'
+
+  args = {
+    :license => 'ASL2',
+    :copyright_software => 'Fluentd Rancher Output Plugin',
+    :copyright_software_description => "Enrich Fluentd events with Rancher metadata",
+    :copyright_holders => ['Red Hat, Inc.'],
+    :copyright_years => ['2015'],
+    :add_path => 'lib:test',
+    :output_dir => '.'
+  }
+
+  command_line = CopyrightHeader::CommandLine.new( args )
+  command_line.execute
+end

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  override:
+    - bundle exec rake test

data/fluent-plugin-rancher.gemspec

@@ -0,0 +1,28 @@
+# 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-rancher"
+  spec.version       = "0.1.0"
+  spec.authors       = ["BinZhao"]
+  spec.email         = ["jimmidyson@gmail.com"]
+  spec.description   = %q{Output filter plugin to add rancher metadata}
+  spec.summary       = %q{Output filter plugin to add rancher metadata}
+  spec.homepage      = "https://github.com/we87/fluent-plugin-rancher"
+  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_development_dependency "copyright-header"
+  spec.add_development_dependency "minitest-vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_runtime_dependency "fluentd"
+  spec.add_runtime_dependency "docker-api"
+end

data/lib/fluent/plugin/out_rancher.rb

@@ -0,0 +1,116 @@
+#
+# Fluentd Kubernetes Output Plugin - Enrich Fluentd events with Kubernetes
+# metadata
+#
+# Copyright 2015 Red Hat, Inc.
+#
+# 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.
+#
+class Fluent::RancherOutput < Fluent::Output
+  Fluent::Plugin.register_output('rancher', self)
+
+  config_param :container_id, :string
+  config_param :tag, :string
+
+  def initialize
+    super
+  end
+
+  def configure(conf)
+    super
+
+    require 'docker'
+    require 'json'
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time,record|
+      Fluent::Engine.emit('rancher',
+                          time,
+                          enrich_record(tag, record))
+    end
+
+    chain.next
+  end
+
+  private
+
+  def interpolate(tag, str)
+    tag_parts = tag.split('.')
+
+    str.gsub(/\$\{tag_parts\[(\d+)\]\}/) { |m| tag_parts[$1.to_i] }
+  end
+
+  def enrich_record(tag, record)
+    id = interpolate(tag, @container_id)
+    if !id.empty?
+      record['container_id'] = id
+      record = enrich_container_data(id, record)
+      record = merge_json_log(record)
+    end
+    record
+  end
+
+  def enrich_container_data(id, record)
+    container = Docker::Container.get(id)
+    if container
+      container_name = container.json['Name']
+      if container_name
+        record["container_name"] = container_name[1..-1] if container_name[0] == '/'
+      end
+
+      config = container.json["Config"]
+      labels = config["Labels"] if config and config["Labels"]
+      if labels
+        if labels["io.kubernetes.pod.namespace"]
+          record["project"] = labels["io.kubernetes.pod.namespace"]
+          record["service"] = labels["io.kubernetes.pod.name"] if labels["io.kubernetes.pod.name"]
+          record["container"] = labels["io.kubernetes.container.name"] if labels["io.kubernetes.container.name"]
+        elsif labels["io.kubernetes.pod.name"]
+          svc, *pod = labels["io.kubernetes.pod.name"].split("/", 2)
+          record["project"] = svc
+          record["service"] = pod[-1] if pod[-1]
+          record["container"] = labels["io.kubernetes.container.name"] if labels["io.kubernetes.container.name"]
+        else labels["io.rancher.project.name"]
+          record["project"] = labels["io.rancher.project.name"]
+          # 2. service name & container name
+          svc_container_name = labels["io.rancher.project_service.name"]
+          if svc_container_name
+            svc, *cnames = svc_container_name.split('/', 3)
+            record["service"] = svc
+            record["container"] = cnames[-1] if cnames[-1]
+          end
+        end
+      end
+    end
+    record
+  end
+
+  def merge_json_log(record)
+    if record.has_key?('log')
+      log = record['log'].strip
+      if log[0].eql?('{') && log[-1].eql?('}')
+        begin
+          parsed_log = JSON.parse(log)
+          record = record.merge(parsed_log)
+          unless parsed_log.has_key?('log')
+            record.delete('log')
+          end
+        rescue JSON::ParserError
+        end
+      end
+    end
+    record
+  end
+
+end