fluent-plugin-docker_metadata_filter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d52408bfaa987e90dd6c2580d1fde98dc475dcb
+  data.tar.gz: 2239ccbf754b937d14c7b2441a768ace87b0ec55
+SHA512:
+  metadata.gz: 5238ebd8328d7c48e26fdffcb2c30da1a02be7bacdc1d07fd622612cc9ec886893ea78f63c258f33a583de5c35490c4819d2f752d4b9ac8a67ebdd22e94c8100
+  data.tar.gz: 9e7c04cb9587d00eefa67385830471a0e217e4b61b937c865e5bccc64d5240ed2d733f15afc751a29755dce4aba7f6fd859c4079372f0573f336ed311c757a49

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,6 @@
+source 'https://rubygems.org'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+# 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,70 @@
+# fluent-plugin-docker_metadata_filter, a plugin for [Fluentd](http://fluentd.org)
+[![Circle CI](https://circleci.com/gh/fabric8io/fluent-plugin-docker_metadata_filter?style=svg)](https://circleci.com/gh/fabric8io/fluent-plugin-docker_metadata_filter)
+[![Code Climate](https://codeclimate.com/github/fabric8io/fluent-plugin-docker_metadata_filter/badges/gpa.svg)](https://codeclimate.com/github/fabric8io/fluent-plugin-docker_metadata_filter)
+[![Test Coverage](https://codeclimate.com/github/fabric8io/fluent-plugin-docker_metadata_filter/badges/coverage.svg)](https://codeclimate.com/github/fabric8io/fluent-plugin-docker_metadata_filter)
+
+## Installation
+
+    gem install fluent-plugin-docker_metadata_filter
+
+## 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>
+
+<filter docker.var.lib.docker.containers.*.*.log>
+  type docker_metadata
+</filter>
+
+<match **>
+  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:
+df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115-json.log:
+```
+{
+  "log": "2015/05/05 19:54:41 \n",
+  "stream": "stderr",
+  "time": "2015-05-05T19:54:41.240447294Z"
+}
+```
+
+Then output becomes as belows
+```
+{
+  "log": "2015/05/05 19:54:41 \n",
+  "stream": "stderr",
+  "docker": {
+    "id": "df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115",
+    "name": "/k8s_fabric8-console-container.efbd6e64_fabric8-console-controller-9knhj_default_8ae2f621-f360-11e4-8d12-54ee7527188d_7ec9aa3e",
+    "container_hostname": "fabric8-console-controller-9knhj",
+    "image": "fabric8/hawtio-kubernetes:latest",
+    "image_id": "b2bd1a24a68356b2f30128e6e28e672c1ef92df0d9ec01ec0c7faea5d77d2303",
+    "labels": {}
+  }
+}
+```
+
+## 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,36 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :test => [:base_test]
+
+task :default => [:test, :build]
+
+desc 'Run test_unit based test'
+Rake::TestTask.new(:base_test) do |t|
+  # To run test for only one file (or file path pattern)
+  #  $ bundle exec rake base_test TEST=test/test_specified_path.rb
+  #  $ bundle exec rake base_test TEST=test/test_*.rb
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+  #t.warning = true
+end
+
+desc "Add copyright headers"
+task :headers do
+  require 'rubygems'
+  require 'copyright_header'
+
+  args = {
+    :license => 'ASL2',
+    :copyright_software => 'Fluentd Docker Metadata Filter Plugin',
+    :copyright_software_description => "Enrich Fluentd events with Docker 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-docker_metadata_filter.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-docker_metadata_filter"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Jimmi Dyson"]
+  gem.email         = ["jimmidyson@gmail.com"]
+  gem.description   = %q{Filter plugin to add Docker metadata}
+  gem.summary       = %q{Filter plugin to add Docker metadata}
+  gem.homepage      = "https://github.com/fabric8io/fluent-plugin-docker_metadata_filter"
+  gem.license       = "ASL2"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.has_rdoc = false
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "docker-api"
+  gem.add_runtime_dependency "lru_redux"
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 4.0"
+  gem.add_development_dependency "test-unit", "~> 3.0.2"
+  gem.add_development_dependency "test-unit-rr", "~> 1.0.3"
+  gem.add_development_dependency "copyright-header"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "vcr"
+end

data/lib/fluent/plugin/filter_docker_metadata.rb

@@ -0,0 +1,80 @@
+#
+# Fluentd Docker Metadata Filter Plugin - Enrich Fluentd events with Docker
+# 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.
+#
+module Fluent
+  class DockerMetadataFilter < Fluent::Filter
+    Fluent::Plugin.register_filter('docker_metadata', self)
+
+    config_param :docker_url, :string,  :default => 'unix:///var/run/docker.sock'
+    config_param :cache_size, :integer, :default => 100
+    config_param :container_id_regexp, :string, :default => '(\w{64})'
+
+    def self.get_metadata(container_id)
+      begin
+        Docker::Container.get(container_id).info
+      rescue Docker::Error::NotFoundError
+        nil
+      end
+    end
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      super
+
+      require 'docker'
+      require 'json'
+      require 'lru_redux'
+
+      Docker.url = @docker_url
+
+      @cache = LruRedux::ThreadSafeCache.new(@cache_size)
+      @container_id_regexp_compiled = Regexp.compile(@container_id_regexp)
+    end
+
+    def filter_stream(tag, es)
+      new_es = es
+      container_id = tag.match(@container_id_regexp_compiled)
+      if container_id && container_id[0]
+        container_id = container_id[0]
+        metadata = @cache.getset(container_id[0]){DockerMetadataFilter.get_metadata(container_id)}
+
+        if metadata
+          new_es = MultiEventStream.new
+
+          es.each {|time, record|
+            record[:docker] = {
+              :id => metadata['id'],
+              :name => metadata['Name'],
+              :container_hostname => metadata['Config']['Hostname'],
+              :image => metadata['Config']['Image'],
+              :image_id => metadata['Image'],
+              :labels => metadata['Config']['Labels']
+            }
+            new_es.add(time, record)
+          }
+        end
+      end
+
+      return new_es
+    end
+  end
+
+end

data/test/cassettes/docker_metadata.yml

@@ -0,0 +1,47 @@
+#
+# Fluentd Docker Metadata Filter Plugin - Enrich Fluentd events with Docker
+# 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.
+#
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://unix/v1.16/containers/df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115/json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Swipely/Docker-API 1.21.4
+      Content-Type:
+      - text/plain
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Thu, 07 May 2015 11:33:53 GMT
+    body:
+      encoding: UTF-8
+      string: |
+        {"AppArmorProfile":"","Args":["-p","9090","-c","/site/osconsole/config.js.tmpl=/site/osconsole/config.js","-s","/kubernetes/api/v1beta2/proxy/services/app-library/=http://app-library/","-s","/kubernetes/api/v1beta2/proxy/services/app-library-jolokia/=http://app-library-jolokia:8778/","-s","/kubernetes/api/=https://kubernetes/api/","-s","/kubernetes/osapi/=https://kubernetes/osapi/","--skip-cert-validation","--default-page=/index.html","--max-age=24h","--compress"],"Config":{"AttachStderr":false,"AttachStdin":false,"AttachStdout":false,"Cmd":["-p","9090","-c","/site/osconsole/config.js.tmpl=/site/osconsole/config.js","-s","/kubernetes/api/v1beta2/proxy/services/app-library/=http://app-library/","-s","/kubernetes/api/v1beta2/proxy/services/app-library-jolokia/=http://app-library-jolokia:8778/","-s","/kubernetes/api/=https://kubernetes/api/","-s","/kubernetes/osapi/=https://kubernetes/osapi/","--skip-cert-validation","--default-page=/index.html","--max-age=24h","--compress"],"CpuShares":0,"Cpuset":"","Domainname":"","Entrypoint":["/kuisp"],"Env":["OAUTH_CLIENT_ID=fabric8-console","OAUTH_AUTHORIZE_URI=https://localhost:8443/oauth/authorize","CDELIVERY_PORT_9595_TCP=tcp://172.30.17.131:9595","FABRIC8_CONSOLE_SERVICE_SERVICE_PORT=80","FABRIC8_CONSOLE_SERVICE_PORT_80_TCP=tcp://172.30.17.116:80","KIBANA_SERVICE_PORT_80_TCP_PORT=80","JBPM_DESIGNER_PORT=tcp://172.30.17.24:80","ELASTICSEARCH_PORT_9200_TCP_PORT=9200","KUBERNETES_RO_PORT=tcp://172.30.17.1:80","APP_LIBRARY_JOLOKIA_SERVICE_HOST=172.30.17.150","KUBERNETES_PORT_443_TCP_PROTO=tcp","GOGS_SSH_SERVICE_SERVICE_PORT=22","ROUTER_PORT=tcp://172.30.17.64:80","FABRIC8_CONSOLE_SERVICE_PORT=tcp://172.30.17.116:80","HUBOT_WEB_HOOK_PORT_8080_TCP_PORT=8080","GOGS_SSH_SERVICE_PORT_22_TCP_PROTO=tcp","HUBOT_SERVICE_PORT=6667","HUBOT_PORT=tcp://172.30.17.98:6667","FABRIC8_FORGE_PORT_80_TCP_ADDR=172.30.17.25","GOGS_HTTP_SERVICE_SERVICE_HOST=172.30.17.119","HUBOT_WEB_HOOK_PORT=tcp://172.30.17.137:8080","HUBOT_WEB_HOOK_PORT_8080_TCP_ADDR=172.30.17.137","LETSCHAT_PORT_80_TCP_PROTO=tcp","KIBANA_SERVICE_PORT_80_TCP_ADDR=172.30.17.72","ROUTER_PORT_80_TCP=tcp://172.30.17.64:80","KUBERNETES_RO_PORT_80_TCP=tcp://172.30.17.1:80","KUBERNETES_SERVICE_PORT=443","KUBERNETES_RO_SERVICE_PORT=80","CDELIVERY_PORT_9595_TCP_ADDR=172.30.17.131","JBPM_DESIGNER_PORT_80_TCP_ADDR=172.30.17.24","APP_LIBRARY_JOLOKIA_PORT_8778_TCP=tcp://172.30.17.150:8778","HUBOT_PORT_6667_TCP_PORT=6667","APP_LIBRARY_PORT_80_TCP=tcp://172.30.17.123:80","KUBERNETES_RO_SERVICE_HOST=172.30.17.1","APP_LIBRARY_SERVICE_HOST=172.30.17.123","LETSCHAT_SERVICE_PORT=80","KUBERNETES_PORT_443_TCP_PORT=443","FABRIC8_CONSOLE_SERVICE_PORT_80_TCP_PORT=80","FABRIC8_CONSOLE_SERVICE_PORT_80_TCP_ADDR=172.30.17.116","KUBERNETES_RO_PORT_80_TCP_PORT=80","APP_LIBRARY_JOLOKIA_PORT_8778_TCP_PORT=8778","ELASTICSEARCH_SERVICE_PORT=9200","CDELIVERY_PORT_9595_TCP_PORT=9595","JBPM_DESIGNER_PORT_80_TCP_PORT=80","APP_LIBRARY_JOLOKIA_PORT_8778_TCP_ADDR=172.30.17.150","GOGS_HTTP_SERVICE_PORT_443_TCP=tcp://172.30.17.119:443","GOGS_SSH_SERVICE_PORT=tcp://172.30.17.249:22","CDELIVERY_PORT_9595_TCP_PROTO=tcp","DOCKER_REGISTRY_PORT=tcp://172.30.17.192:5000","FABRIC8_FORGE_SERVICE_PORT=80","FABRIC8_FORGE_PORT_80_TCP_PORT=80","LETSCHAT_PORT=tcp://172.30.17.245:80","INFLUXDB_SERVICE_PORT_8086_TCP_PORT=8086","ROUTER_PORT_80_TCP_PORT=80","KIBANA_SERVICE_PORT_80_TCP=tcp://172.30.17.72:80","ELASTICSEARCH_PORT=tcp://172.30.17.53:9200","HUBOT_WEB_HOOK_SERVICE_HOST=172.30.17.137","DOCKER_REGISTRY_PORT_5000_TCP_PROTO=tcp","DOCKER_REGISTRY_PORT_5000_TCP_PORT=5000","GOGS_HTTP_SERVICE_PORT=tcp://172.30.17.119:443","APP_LIBRARY_JOLOKIA_SERVICE_PORT=8778","GOGS_SSH_SERVICE_PORT_22_TCP_PORT=22","DOCKER_REGISTRY_SERVICE_HOST=172.30.17.192","INFLUXDB_SERVICE_PORT=tcp://172.30.17.227:8086","ELASTICSEARCH_PORT_9200_TCP_PROTO=tcp","FABRIC8_FORGE_PORT_80_TCP=tcp://172.30.17.25:80","LETSCHAT_PORT_80_TCP_PORT=80","KUBERNETES_PORT_443_TCP_ADDR=172.30.17.2","KUBERNETES_RO_PORT_80_TCP_ADDR=172.30.17.1","KIBANA_SERVICE_SERVICE_PORT=80","HUBOT_PORT_6667_TCP=tcp://172.30.17.98:6667","HUBOT_PORT_6667_TCP_PROTO=tcp","FABRIC8_FORGE_PORT_80_TCP_PROTO=tcp","HUBOT_WEB_HOOK_PORT_8080_TCP_PROTO=tcp","KUBERNETES_SERVICE_HOST=172.30.17.2","ROUTER_SERVICE_PORT=80","KIBANA_SERVICE_PORT_80_TCP_PROTO=tcp","JBPM_DESIGNER_SERVICE_PORT=80","FABRIC8_FORGE_PORT=tcp://172.30.17.25:80","HUBOT_WEB_HOOK_PORT_8080_TCP=tcp://172.30.17.137:8080","CDELIVERY_SERVICE_PORT=9595","APP_LIBRARY_PORT=tcp://172.30.17.123:80","HUBOT_SERVICE_HOST=172.30.17.98","HUBOT_PORT_6667_TCP_ADDR=172.30.17.98","KUBERNETES_PORT=tcp://172.30.17.2:443","KIBANA_SERVICE_PORT=tcp://172.30.17.72:80","JBPM_DESIGNER_PORT_80_TCP=tcp://172.30.17.24:80","DOCKER_REGISTRY_PORT_5000_TCP=tcp://172.30.17.192:5000","DOCKER_REGISTRY_PORT_5000_TCP_ADDR=172.30.17.192","APP_LIBRARY_JOLOKIA_PORT_8778_TCP_PROTO=tcp","GOGS_HTTP_SERVICE_SERVICE_PORT=443","ROUTER_SERVICE_HOST=172.30.17.64","INFLUXDB_SERVICE_PORT_8086_TCP_ADDR=172.30.17.227","ELASTICSEARCH_SERVICE_HOST=172.30.17.53","FABRIC8_FORGE_SERVICE_HOST=172.30.17.25","GOGS_SSH_SERVICE_PORT_22_TCP_ADDR=172.30.17.249","APP_LIBRARY_PORT_80_TCP_PROTO=tcp","GOGS_HTTP_SERVICE_PORT_443_TCP_PORT=443","KUBERNETES_PORT_443_TCP=tcp://172.30.17.2:443","GOGS_SSH_SERVICE_PORT_22_TCP=tcp://172.30.17.249:22","INFLUXDB_SERVICE_PORT_8086_TCP=tcp://172.30.17.227:8086","KIBANA_SERVICE_SERVICE_HOST=172.30.17.72","DOCKER_REGISTRY_SERVICE_PORT=5000","INFLUXDB_SERVICE_PORT_8086_TCP_PROTO=tcp","APP_LIBRARY_PORT_80_TCP_PORT=80","GOGS_HTTP_SERVICE_PORT_443_TCP_ADDR=172.30.17.119","LETSCHAT_SERVICE_HOST=172.30.17.245","LETSCHAT_PORT_80_TCP_ADDR=172.30.17.245","ROUTER_PORT_80_TCP_ADDR=172.30.17.64","APP_LIBRARY_PORT_80_TCP_ADDR=172.30.17.123","HUBOT_WEB_HOOK_SERVICE_PORT=8080","CDELIVERY_PORT=tcp://172.30.17.131:9595","FABRIC8_CONSOLE_SERVICE_SERVICE_HOST=172.30.17.116","KUBERNETES_RO_PORT_80_TCP_PROTO=tcp","JBPM_DESIGNER_SERVICE_HOST=172.30.17.24","ELASTICSEARCH_PORT_9200_TCP=tcp://172.30.17.53:9200","GOGS_HTTP_SERVICE_PORT_443_TCP_PROTO=tcp","LETSCHAT_PORT_80_TCP=tcp://172.30.17.245:80","INFLUXDB_SERVICE_SERVICE_PORT=8086","ELASTICSEARCH_PORT_9200_TCP_ADDR=172.30.17.53","GOGS_SSH_SERVICE_SERVICE_HOST=172.30.17.249","JBPM_DESIGNER_PORT_80_TCP_PROTO=tcp","INFLUXDB_SERVICE_SERVICE_HOST=172.30.17.227","APP_LIBRARY_SERVICE_PORT=80","CDELIVERY_SERVICE_HOST=172.30.17.131","ROUTER_PORT_80_TCP_PROTO=tcp","FABRIC8_CONSOLE_SERVICE_PORT_80_TCP_PROTO=tcp","APP_LIBRARY_JOLOKIA_PORT=tcp://172.30.17.150:8778","PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin","KUISP_VERSION=0.10"],"ExposedPorts":{"9090/tcp":{}},"Hostname":"fabric8-console-controller-9knhj","Image":"fabric8/hawtio-kubernetes:latest","Labels":{},"MacAddress":"","Memory":0,"MemorySwap":0,"NetworkDisabled":false,"OnBuild":null,"OpenStdin":false,"PortSpecs":null,"StdinOnce":false,"Tty":false,"User":"nobody","Volumes":null,"WorkingDir":"/site"},"Created":"2015-05-05T19:54:32.049030413Z","Driver":"devicemapper","ExecDriver":"native-0.2","ExecIDs":null,"HostConfig":{"Binds":["/var/lib/openshift/openshift.local.volumes/pods/8ae2f621-f360-11e4-8d12-54ee7527188d/volumes/kubernetes.io~secret/openshift-cert-secrets:/etc/secret-volume:ro","/var/lib/openshift/openshift.local.volumes/pods/8ae2f621-f360-11e4-8d12-54ee7527188d/containers/fabric8-console-container/df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115:/dev/termination-log"],"CapAdd":null,"CapDrop":null,"CgroupParent":"","ContainerIDFile":"","CpuShares":0,"CpusetCpus":"","Devices":null,"Dns":["192.168.0.6","8.8.8.8","4.4.4.4"],"DnsSearch":["default.local","local","localnet"],"ExtraHosts":null,"IpcMode":"container:bde11471511521766a33235c030b32821b007daca302e72e8eb877dbcbee4e8c","Links":null,"LogConfig":{"Config":null,"Type":"json-file"},"LxcConf":null,"Memory":0,"MemorySwap":0,"MountRun":false,"NetworkMode":"container:bde11471511521766a33235c030b32821b007daca302e72e8eb877dbcbee4e8c","PidMode":"","PortBindings":null,"Privileged":false,"PublishAllPorts":false,"ReadonlyRootfs":false,"RestartPolicy":{"MaximumRetryCount":0,"Name":""},"SecurityOpt":null,"Ulimits":null,"VolumesFrom":null},"HostnamePath":"/var/lib/docker/containers/bde11471511521766a33235c030b32821b007daca302e72e8eb877dbcbee4e8c/hostname","HostsPath":"/var/lib/docker/containers/bde11471511521766a33235c030b32821b007daca302e72e8eb877dbcbee4e8c/hosts","Id":"df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115","Image":"b2bd1a24a68356b2f30128e6e28e672c1ef92df0d9ec01ec0c7faea5d77d2303","LogPath":"/var/lib/docker/containers/df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115/df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115-json.log","MountLabel":"system_u:object_r:svirt_sandbox_file_t:s0:c49,c148","Name":"/k8s_fabric8-console-container.efbd6e64_fabric8-console-controller-9knhj_default_8ae2f621-f360-11e4-8d12-54ee7527188d_7ec9aa3e","NetworkSettings":{"Bridge":"","Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"IPAddress":"","IPPrefixLen":0,"IPv6Gateway":"","LinkLocalIPv6Address":"","LinkLocalIPv6PrefixLen":0,"MacAddress":"","PortMapping":null,"Ports":null},"Path":"/kuisp","ProcessLabel":"system_u:system_r:svirt_lxc_net_t:s0:c49,c148","ResolvConfPath":"/var/lib/docker/containers/bde11471511521766a33235c030b32821b007daca302e72e8eb877dbcbee4e8c/resolv.conf","RestartCount":0,"State":{"Dead":false,"Error":"","ExitCode":137,"FinishedAt":"2015-05-05T21:09:29.955742402Z","OOMKilled":false,"Paused":false,"Pid":0,"Restarting":false,"Running":false,"StartedAt":"2015-05-05T19:54:32.664668594Z"},"Volumes":{"/dev/termination-log":"/var/lib/openshift/openshift.local.volumes/pods/8ae2f621-f360-11e4-8d12-54ee7527188d/containers/fabric8-console-container/df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115","/etc/secret-volume":"/var/lib/openshift/openshift.local.volumes/pods/8ae2f621-f360-11e4-8d12-54ee7527188d/volumes/kubernetes.io~secret/openshift-cert-secrets"},"VolumesRW":{"/dev/termination-log":true,"/etc/secret-volume":false},"VolumesRelabel":{"/dev/termination-log":"","/etc/secret-volume":"ro"}}
+    http_version: 
+  recorded_at: Thu, 07 May 2015 11:33:53 GMT
+recorded_with: VCR 2.9.3

data/test/helper.rb

@@ -0,0 +1,81 @@
+#
+# Fluentd Docker Metadata Filter Plugin - Enrich Fluentd events with Docker
+# 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.
+#
+# 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
+
+require 'rr'
+require 'test/unit'
+require 'test/unit/rr'
+require 'fileutils'
+require 'fluent/log'
+require 'fluent/test'
+require 'webmock/test_unit'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "test/cassettes"
+  config.hook_into :webmock # or :fakeweb
+end
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end
+
+def unused_port
+  s = TCPServer.open(0)
+  port = s.addr[1]
+  s.close
+  port
+end
+
+def ipv6_enabled?
+  require 'socket'
+
+  begin
+    TCPServer.open("::1", 0)
+    true
+  rescue
+    false
+  end
+end
+
+$log = Fluent::Log.new(Fluent::Test::DummyLogDevice.new, Fluent::Log::LEVEL_WARN)

data/test/plugin/test_filter_docker_metadata.rb

@@ -0,0 +1,88 @@
+#
+# Fluentd Docker Metadata Filter Plugin - Enrich Fluentd events with Docker
+# 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.
+#
+require_relative '../helper'
+require 'fluent/plugin/filter_docker_metadata'
+
+require 'webmock/test_unit'
+WebMock.disable_net_connect!
+
+class DockerMetadataFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(DockerMetadataFilter).configure(conf, true)
+  end
+
+  sub_test_case 'configure' do
+    test 'check default' do
+      d = create_driver
+      assert_equal(d.instance.docker_url, 'unix:///var/run/docker.sock')
+      assert_equal(100, d.instance.cache_size)
+    end
+
+    test 'docker url' do
+      d = create_driver(%[docker_url http://docker-url])
+      assert_equal('http://docker-url', d.instance.docker_url)
+      assert_equal(100, d.instance.cache_size)
+    end
+
+    test 'cache size' do
+      d = create_driver(%[cache_size 1])
+      assert_equal('unix:///var/run/docker.sock', d.instance.docker_url)
+      assert_equal(1, d.instance.cache_size)
+    end
+  end
+
+  sub_test_case 'filter_stream' do
+    def messages
+      [
+        "2013/01/13T07:02:11.124202 INFO GET /ping",
+        "2013/01/13T07:02:13.232645 WARN POST /auth",
+        "2013/01/13T07:02:21.542145 WARN GET /favicon.ico",
+        "2013/01/13T07:02:43.632145 WARN POST /login",
+      ]
+    end
+
+    def emit(config, msgs)
+      d = create_driver(config)
+      d.run {
+        msgs.each { |msg|
+          d.emit_with_tag('df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115', {'foo' => 'bar', 'message' => msg}, @time)
+        }
+      }.filtered
+    end
+
+    test 'docker metadata' do
+      VCR.use_cassette('docker_metadata') do
+        es = emit('', messages)
+        assert_equal(4, es.instance_variable_get(:@record_array).size)
+        assert_equal('df14e0d5ae4c07284fa636d739c8fc2e6b52bc344658de7d3f08c36a2e804115', es.instance_variable_get(:@record_array)[0][:docker][:id])
+        assert_equal('/k8s_fabric8-console-container.efbd6e64_fabric8-console-controller-9knhj_default_8ae2f621-f360-11e4-8d12-54ee7527188d_7ec9aa3e', es.instance_variable_get(:@record_array)[0][:docker][:name])
+        assert_equal('fabric8-console-controller-9knhj', es.instance_variable_get(:@record_array)[0][:docker][:container_hostname])
+        assert_equal('b2bd1a24a68356b2f30128e6e28e672c1ef92df0d9ec01ec0c7faea5d77d2303', es.instance_variable_get(:@record_array)[0][:docker][:image_id])
+        assert_equal('fabric8/hawtio-kubernetes:latest', es.instance_variable_get(:@record_array)[0][:docker][:image])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-docker_metadata_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmi Dyson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-07 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: docker-api
+  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: lru_redux
+  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.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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: copyright-header
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: Filter plugin to add Docker metadata
+email:
+- jimmidyson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- fluent-plugin-docker_metadata_filter.gemspec
+- lib/fluent/plugin/filter_docker_metadata.rb
+- test/cassettes/docker_metadata.yml
+- test/helper.rb
+- test/plugin/test_filter_docker_metadata.rb
+homepage: https://github.com/fabric8io/fluent-plugin-docker_metadata_filter
+licenses:
+- ASL2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Filter plugin to add Docker metadata
+test_files:
+- test/cassettes/docker_metadata.yml
+- test/helper.rb
+- test/plugin/test_filter_docker_metadata.rb