fluent-plugin-ecs-filter 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWM4ZTNjMDFjZTg1OTAxNDg0YjQ4MmE3ZDJiYTgyYjUyYWFkYzNlOA==
+  data.tar.gz: !binary |-
+    YzczZjYwZjNkYjEyYjUzMDM5YzljNThmODNlMjVjOTdjMDhlYTk2ZA==
+SHA512:
+  metadata.gz: !binary |-
+    NDhiZjVhM2NhMGQwZjljNzFhNzA3YTE2YjllYTdiYmNiZTIyMTU5MGFlY2I5
+    MjkzZjM2NTgwNDk5MWU4MTU3MTIwZDMzNTFhMzIzNDVjOGY0NDRjMjAzNGM1
+    NWQ1NzE1ZTQ1N2M0ZGIyNTlhZTM1MTdmZmYxZTBlMDAyYjVlM2U=
+  data.tar.gz: !binary |-
+    OWVhMWM3MDJiNWIzZWYzYmJkNzFmM2VlYTUxYzliNmVkYzk3MGIwM2IyMzVj
+    ZjU5ODMyY2VjMGRjMGI4N2FmYTJhMTlmMjcwOWI3OWRiNjg2ODI1ZDdhODU1
+    NmNhMjIyY2M2NDk3NzE2MmMwMzVjNTE1NTI5ZDc4YjcxYTg5ZWQ=

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p551

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+- 2.1.7
+- 1.9.3-p551
+addons:
+  code_climate:
+    repo_token:
+      secure: "TTJV+tkPbGVjCQDZNH5NEVr9HbVheUk0BZjAvJbYRtdIwAHzvVwbe5H24E8V1hq0E/5ECvZPN/mwRDXq5wJ9bT7vx3OasLVIDhlTcDExirgfFCeVQGd0lVyQYjSFMgK9j6iKr4LkHBj2uxBz26Q1UrT0KwXZ4zQ1RWFu8T2VAoqhO8UzDiR5j7ho34rTSqVFJgF7zFz3YPOr8jgK1vynrcNBFe82ElA8bjH+UkVB8p2bG5ib4i+vUqMSXPOBCo+qZ9OGEzmm2dNjRp8VNUBd0JwWrs/1HhGKeQQ7kbpiS8H6mYNJQtiGFgJWrGFjGFlUny09bWT1JRSuBtEZNotGHtZDidxkXHK3yys6ZOyrnAm6DWlYzK2mNzyp/FY+5aSKMnwB+eZ6YrKPPK0CjwXfoAUiOjK2VMJUXWrF5atjiXFrTVEnurDZW7h4vxJb7EDkvb+tuT9aPtxQoS6BrWUKTkl9rT1Xsp+NfBHuTHZMYyv05HsS7RgqXb7bOrPTAGwdam9xCafFOOrwQRF5OkJovZ13UobWzmgqscu4o39HmLXwWnKyC1QQ7FJ8NYLDQEQjQi7FjdCdmmYHhh/Y28brhSW8ar1EaZ1iPTuqsjdYzDqusjtRP5svpoV5RJ5Fes1pdoeXFv2YMaZVFc5RvmlRp8nlwyC9F9PhyjJWwK9f18w="
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "BbwV2W8hxxLaYM1luukejgmgm0ODHFw3CNgQbK15D9tK1VoQqNxCxQzmCYgi2FG1MYYAQcTcVj7W+cd76REmKDEhxEyZUVmIQF+N16Zl2vR/UegsbXVd2Gpel2tyykO9ebSlkXHkwzcCMksIhwCdELJORbxGSqVxTl6FaNPS3bfylev5Cumk8SCKXEvg2BMH0BPFpXZSpijdVv5xTuzM0qQUx/thvEHcm9o9q1JEhM4XbEdffBSOM3BWM9yCoSshKO2GmCBNJOOp8JsDmRR3F+ynuTdV5b8AGSHd7oubh6OxZ26jusJXzIgxZ99hi4FTDRuvvyOcmKn6Of7DN6K3rBNoDmxf4E3OdujSJSRuDG2wbQz/1R7isBniabqxogeCgMEHabXP2QRN+SOkpLQthaFhr+ISMuH5ZRKRYcRBTJ6J/QGDPOxYe0JWJpwVhvE4jDK/UaGph6kt/DLrWR/SLXa2kPDlrWl2xe4z3SwuJRPhkfwHGVLIZSZR21bJ4ONnBYkXbFI8lTsLno7JA6SXPfTODRnJrlUWqV0xIwyWTsoxcgssMVUH2RgqiBHWxGIOJShVwoX5JEx3M5SRC7xvnwW5xF5+KHCxMKB5wXEfQRpZUBX+KKCBn5PP0U21QjHhUbYhy8k85QEaL+LWOX6BqZikBw/5QaZijNYvhCtZbQs="
+  gem: fluent-plugin-ecs-filter
+  on:
+    repo: joshughes/fluent-plugin-ecs-filter
+    branch: master

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,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,111 @@
+#Mesosphere Fluentd Filter
+[![Code Climate](https://codeclimate.com/github/joshughes/fluent-plugin-ecs-filter/badges/gpa.svg)](https://codeclimate.com/github/joshughes/fluent-plugin-ecs-filter)
+[![Test Coverage](https://codeclimate.com/github/joshughes/fluent-plugin-ecs-filter/badges/coverage.svg)](https://codeclimate.com/github/joshughes/fluent-plugin-ecs-filter/coverage)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-ecs-filter.svg)](https://badge.fury.io/rb/fluent-plugin-ecs-filter)
+[![Inline docs](http://inch-ci.org/github/joshughes/fluent-plugin-ecs-filter.svg?branch=master)](http://inch-ci.org/github/joshughes/fluent-plugin-ecs-filter)
+[![Dependency Status](https://www.versioneye.com/user/projects/5658d10aaef3b5003e000000/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5658d10aaef3b5003e000000)
+
+Marathon, Chronos and Mesos combined can allow for teams to build a great solution for deploying and scaling containers. The issue is when you have a system like Kibana it can be hard to identify what container or task a log is coming from.
+
+This filter aims to solve that issue by inspecting containers to inject Mesosphere metatdata into the Fluentd event stream.
+
+##What gets injected?
+###Marathon
+
+|`key`|  Description  |
+|---|---|
+|`app`|  The application name in marathon  |
+|  `mesos_framework` |  marathon |
+| `mesos_task_id` | The unique Mesos task id running the docker container |
+
+###Chronos
+Chronos does not have the idea of an 'application'. Just jobs. We run a lot of jobs that relate to our applications so we use a naming scheme that allows us to extract the marathon application that is running the Chronos task.
+
+An example of a Chronos Job name is the following.
+
+`some-task-app2-11182015-1718-deployTasks-1-144786721`
+
+With the default regex in the plugin we extract the following data and inject it into the event stream.
+
+|`key`|  Description  | Value |
+|---|---|---|
+|`app`|  The application name running the task  | some-task-app2 |
+|  `mesos_framework` |  chronos | chronos |
+| `mesos_task_id` | The unique Mesos task id running the docker container | |
+| `chronos_task_type` | The task type our application is running. We run deployment and scheduled tasks. | deployTasks |
+
+##Configuration
+
+If your using the docker fluentd logging plugin your configuration should look something like this.
+
+
+
+```
+<source>
+  type forward
+  port 24224
+  bind 0.0.0.0
+</source>
+
+<filter docker.*>
+  type mesosphere_filter
+  cache_size 1000
+  cache_ttl 3600
+  merge_json_log true
+  cronos_task_regex (?<app>[a-z0-9]([-a-z0-9]*[a-z0-9]))-(?<date>[^-]+)-(?<time>[^-]+)-(?<task_type>[^-]+)-(?<run>[^-]+)-(?<epoc>[^-]+)
+</filter>
+
+<match docker.*>
+  type stdout
+</match>
+```
+
+|`key`|  Description  | Default |
+|---|---|---|
+|`cache_size`|  This plugin will cache information from the docker daemon. This configuration determine how large that cache is. | 1000 |
+|  `cache_ttl ` |  How long to keep items in the cache. | 3600 |
+| `merge_json_log ` | If your application logs in a valid json format, this will merge that into the event stream. | true |
+| `cronos_task_regex ` | If you don't provide a valid regex here then you will only get the mesos_task id from until you create a standard chronos job name that is parseable by a ruby regex. | **See example above** |
+
+
+##Example
+We have an application called `hello-world`. That application is deployed via marathon and has the following environment variables.
+
+|`key`|  value  |
+|---|---|
+| `MESOS_TASK_ID` | `hello-world.14b0596d-93ea-11e5-a134-124eefe69197`|
+| `MARATHON_APP_ID` | `/hello-world`|
+
+Like all great hello world applications. This docker container just execute:
+
+```bash
+echo '{"say":"Hello World"}'
+```
+
+Without this filter fluentd would process the docker log and output the following.
+
+```json
+{
+	"container_id": "ce327cb0de115f7dbfcd2c6055ba945436dada26035a62587b951332a028a530",
+	"container_name": "/some_random_meaningless_name",
+	"source": "stdout",
+	"log": "{\"say\":\"Hello World\"}\r"
+}
+```
+
+With the filter in place that log will become the following.
+
+```json
+{
+	"container_id": "ce327cb0de115f7dbfcd2c6055ba945436dada26035a62587b951332a028a530",
+	"container_name": "/some_random_meaningless_name",
+	"say": "Hello World",
+	"mesos_framework": "marathon",
+	"app": "hello-world",
+	"mesos_task_id": "unquie_task_id",
+	"source": "stdout",
+	"log": "{\"say\":\"Hello World\"}\r"
+}
+```
+
+So now in Kibana you can filter on many more fields and more easily track down issues when `hello-world` may be running in multiple containers that are associated with different Mesos tasks.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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-ecs-filter.gemspec

@@ -0,0 +1,36 @@
+# 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-ecs-filter'
+  gem.version       = '0.1.0'
+  gem.authors       = ['Joseph Hughes']
+  gem.email         = ['jjhughes57@gmail.com']
+  gem.description   = 'Filter plugin to add AWS ECS metadata'
+  gem.summary       = 'Filter plugin to add AWS ECS metadata to fluentd'
+  gem.homepage      = 'https://github.com/joshughes/fluent-plugin-ecs-filter'
+  gem.license       = 'ASL2'
+
+  gem.files         = `git ls-files`.split($RS)
+  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 = '>= 2.0.0'
+
+  gem.add_runtime_dependency 'fluentd', '>= 0.10.43'
+  gem.add_runtime_dependency 'lru_redux', '~> 1.1'
+  gem.add_runtime_dependency 'docker-api', '~> 1.28'
+  gem.add_runtime_dependency 'oj', '>= 2.15.1'
+
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'codeclimate-test-reporter'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'timecop'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'minitest', '~> 4.0'
+end

data/lib/fluent/plugin/filter_ecs_filter.rb

@@ -0,0 +1,161 @@
+#
+# Fluentd ECS Metadata Filter Plugin
+#
+# 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
+  # Parses ECS data from docker to make fluentd logs more
+  # useful.
+  class ECSFilter < Filter
+    Fluent::Plugin.register_filter('ecs_filter', self)
+
+    config_param :cache_size, :integer, default: 1000
+    config_param :cache_ttl, :integer, default: 60 * 60
+    config_param :container_id_attr, :string, default: 'container_id'
+
+    config_param :merge_json_log, :bool, default: true
+
+    # Get the configuration for the plugin
+    def configure(conf)
+      super
+
+      require 'docker-api'
+      require 'lru_redux'
+      require 'oj'
+      require 'time'
+
+      @cache_ttl = :none if @cache_ttl < 0
+
+      @cache = LruRedux::TTL::ThreadSafeCache.new(@cache_size, @cache_ttl)
+
+    end
+
+    # Gets the log event stream and moifies it. This is where the plugin hooks
+    # into the fluentd envent stream.
+    def filter_stream(tag, es)
+      new_es = MultiEventStream.new
+
+      container_id = get_container_id_from_tag(tag)
+
+      es.each do |time, record|
+        container_id =
+          get_container_id_from_record(record) if container_id.empty?
+        next unless container_id
+        new_es.add(time, modify_record(record, get_ecs_data(container_id)))
+      end
+      new_es
+    end
+
+    # Injects the ecs data into the record and also merges
+    # the json log if that configuration is enabled.
+    #
+    # ==== Attributes:
+    # * +record+ - The log record being processed
+    # * +ecs_data+ - The ecs data retrived from the docker container
+    #
+    # ==== Returns:
+    # * A record hash that has ecs data and optinally log data added
+    def modify_record(record, ecs_data)
+      modified_record = record.merge(ecs_data)
+      modified_record = merge_json_log(modified_record) if @merge_json_log
+      modified_record
+    end
+
+    # Gets the ecs data about a container from the cache or calls the Docker
+    # api to retrieve the data about the container and store it in the cache.
+    #
+    # ==== Attributes:
+    # * +container_id+ - The container_id where the log record originated from.
+    # ==== Returns:
+    # * A hash of data that describes a ecs task
+    def get_ecs_data(container_id)
+      @cache.getset(container_id) do
+        get_container_metadata(container_id)
+      end
+    end
+
+    # Goes out to docker container to pull ecs data from labels.
+    #
+    # ==== Attributes:
+    # * +id+ - The id of the container to look at for ecs metadata.
+    # ==== Returns:
+    # * A hash that describes a ecs task gathered from the Docker API
+    def get_container_metadata(id)
+      task_data = {}
+      container = Docker::Container.get(id)
+      if container
+        labels = container.json['Config']['Labels']
+        task_data['task_family']  = labels['com.amazonaws.ecs.task-definition-family']
+        task_data['task_version'] = labels['com.amazonaws.ecs.task-definition-version']
+        task_data['task_id']      = labels['com.amazonaws.ecs.task-arn'].split('/').last
+      end
+      task_data
+    end
+
+    # Gets the container id from the last element in the tag. If the user has
+    # configured container_id_attr the container id can be gathered from the
+    # record if it has been inserted there.
+    #
+    # ==== Attributes:
+    # * +tag+ - The tag of the log being processed
+    # ==== Returns:
+    # * A docker container id
+    def get_container_id_from_tag(tag)
+      tag.split('.').last
+    end
+
+    # If the user has configured container_id_attr the container id can be
+    # gathered from the record if it has been inserted there. If no container_id
+    # can be found, the record is not processed.
+    #
+    # ==== Attributes::
+    # * +record+ - The record that is being transformed by the filter
+    # ==== Returns:
+    # * A docker container id
+    def get_container_id_from_record(record)
+      record[@container_id_attr]
+    end
+
+    # Look at the log value and if it is valid json then we will parse the json
+    # and merge it into the log record.  If a namespace is present then the log
+    # record is placed under that key.
+    # ==== Attributes:
+    # * +record+ - The record we are transforming in the fluentd event stream.
+    # ==== Examples
+    # # Docker captures stdout and passes it in the 'log' record attribute.
+    # # We try to discover is the value of 'log' is json, if it is then we
+    # # will parse the json and add the keys and values to the record.
+    # ==== Returns:
+    # * A record hash that has json log data merged into the record
+    def merge_json_log(record)
+      if record.key?('log')
+        log = record['log'].strip
+        namespace = record['namespace']
+        if log[0].eql?('{') && log[-1].eql?('}')
+          begin
+            log_json = Oj.load(log)
+            if namespace
+              record[namespace] = log_json
+            else
+              record = log_json.merge(record)
+            end
+          rescue Oj::ParseError
+          end
+        end
+      end
+      record
+    end
+  end
+end

data/test/containers/ecs.json

@@ -0,0 +1,192 @@
+{
+  "Id": "foobar123",
+  "Created": "2015-11-26T06:57:56.560006039Z",
+  "Path": "/bin/sh",
+  "Args": [
+    "-c",
+    "exec fluentd -c /fluentd/etc/$FLUENTD_CONF -p /fluentd/plugins $FLUENTD_OPT"
+  ],
+  "State": {
+    "Status": "running",
+    "Running": true,
+    "Paused": false,
+    "Restarting": false,
+    "OOMKilled": false,
+    "Dead": false,
+    "Pid": 6563,
+    "ExitCode": 0,
+    "Error": "",
+    "StartedAt": "2015-11-26T07:00:45.707356204Z",
+    "FinishedAt": "2015-11-26T07:00:43.278299772Z"
+  },
+  "Image": "7cd5efd43c5097c8e6a9b6bdc050f887e0e1dee49a79b7eb920e2d741c36b3b5",
+  "ResolvConfPath": "/mnt/sda1/var/lib/docker/containers/110e3bd749e33e3b55bb55bec44a192457d722607afb1e6423e6a45a1c1e8b45/resolv.conf",
+  "HostnamePath": "/mnt/sda1/var/lib/docker/containers/110e3bd749e33e3b55bb55bec44a192457d722607afb1e6423e6a45a1c1e8b45/hostname",
+  "HostsPath": "/mnt/sda1/var/lib/docker/containers/110e3bd749e33e3b55bb55bec44a192457d722607afb1e6423e6a45a1c1e8b45/hosts",
+  "LogPath": "/mnt/sda1/var/lib/docker/containers/110e3bd749e33e3b55bb55bec44a192457d722607afb1e6423e6a45a1c1e8b45/110e3bd749e33e3b55bb55bec44a192457d722607afb1e6423e6a45a1c1e8b45-json.log",
+  "Name": "/fluentddockertest_fluentd_server_1",
+  "RestartCount": 0,
+  "Driver": "aufs",
+  "ExecDriver": "native-0.2",
+  "MountLabel": "",
+  "ProcessLabel": "",
+  "AppArmorProfile": "",
+  "ExecIDs": null,
+  "HostConfig": {
+    "Binds": [
+      "/Users/A658307/fluentd_docker_test/fluentd/etc:/fluentd/etc:rw",
+      "/Users/A658307/fluentd_docker_test/fluentd/logs:/fluentd/log:rw",
+      "/Users/A658307/fluentd_docker_test/fluentd/plugins:/fluentd/plugins:rw"
+    ],
+    "ContainerIDFile": "",
+    "LxcConf": null,
+    "Memory": 0,
+    "MemoryReservation": 0,
+    "MemorySwap": 0,
+    "KernelMemory": 0,
+    "CpuShares": 0,
+    "CpuPeriod": 0,
+    "CpusetCpus": "",
+    "CpusetMems": "",
+    "CpuQuota": 0,
+    "BlkioWeight": 0,
+    "OomKillDisable": false,
+    "MemorySwappiness": null,
+    "Privileged": false,
+    "PortBindings": {
+      "24224/tcp": [{
+        "HostIp": "",
+        "HostPort": "24224"
+      }]
+    },
+    "Links": null,
+    "PublishAllPorts": false,
+    "Dns": null,
+    "DnsOptions": null,
+    "DnsSearch": null,
+    "ExtraHosts": [],
+    "VolumesFrom": [],
+    "Devices": null,
+    "NetworkMode": "default",
+    "IpcMode": "",
+    "PidMode": "",
+    "UTSMode": "",
+    "CapAdd": null,
+    "CapDrop": null,
+    "GroupAdd": null,
+    "RestartPolicy": {
+      "Name": "",
+      "MaximumRetryCount": 0
+    },
+    "SecurityOpt": null,
+    "ReadonlyRootfs": false,
+    "Ulimits": null,
+    "LogConfig": {
+      "Type": "json-file",
+      "Config": {}
+    },
+    "CgroupParent": "",
+    "ConsoleSize": [
+      0,
+      0
+    ],
+    "VolumeDriver": ""
+  },
+  "GraphDriver": {
+    "Name": "aufs",
+    "Data": null
+  },
+  "Volumes": {
+    "/fluentd/etc": "/Users/A658307/fluentd_docker_test/fluentd/etc",
+    "/fluentd/log": "/Users/A658307/fluentd_docker_test/fluentd/logs",
+    "/fluentd/plugins": "/Users/A658307/fluentd_docker_test/fluentd/plugins"
+  },
+  "VolumesRW": {
+    "/fluentd/etc": true,
+    "/fluentd/log": true,
+    "/fluentd/plugins": true
+  },
+  "Config": {
+    "Hostname": "110e3bd749e3",
+    "Domainname": "",
+    "User": "ubuntu",
+    "AttachStdin": false,
+    "AttachStdout": false,
+    "AttachStderr": false,
+    "Tty": false,
+    "OpenStdin": false,
+    "StdinOnce": false,
+    "Env": [
+      "FLUENTD_OPT=-vv",
+      "MESOS_TASK_ID=hello-world.14b0596d-93ea-11e5-a134-124eefe69197",
+      "MARATHON_APP_ID=/hello-world",
+      "FLUENTD_CONF=test.conf",
+      "PATH=/home/ubuntu/ruby/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
+      "FLUENTD_OPT=",
+      "NAMESPACE=ns"
+    ],
+    "Cmd": [
+      "/bin/sh",
+      "-c",
+      "exec fluentd -c /fluentd/etc/$FLUENTD_CONF -p /fluentd/plugins $FLUENTD_OPT"
+    ],
+    "Image": "fluent/fluentd:latest",
+    "Volumes": {
+      "/fluentd/etc": {},
+      "/fluentd/log": {},
+      "/fluentd/plugins": {}
+    },
+    "WorkingDir": "/home/ubuntu",
+    "Entrypoint": null,
+    "OnBuild": null,
+    "Labels": {
+      "com.amazonaws.ecs.container-name" :"unifi-video",
+      "com.amazonaws.ecs.task-arn" : "arn:aws:ecs:us-west-2:111600242540:task/fdb86b4f-b919-4a65-89eb-4b3761eb8952",
+      "com.amazonaws.ecs.task-definition-family" : "unifi-video",
+      "com.amazonaws.ecs.task-definition-version" :"9", 
+      "Description": "Fluentd docker image",
+      "Vendor": "Fluent Organization",
+      "Version": "1.0",
+      "com.docker.compose.config-hash": "7a03ce1e88388255c166fa62dcad89a43d43034ce605265094cf9c9951dcc9f0",
+      "com.docker.compose.container-number": "1",
+      "com.docker.compose.oneoff": "False",
+      "com.docker.compose.project": "fluentddockertest",
+      "com.docker.compose.service": "fluentd_server",
+      "com.docker.compose.version": "1.5.1"
+    },
+    "MacAddress": "",
+    "NetworkDisabled": false,
+    "ExposedPorts": {
+      "24224/tcp": {}
+    },
+    "VolumeDriver": "",
+    "Memory": 0,
+    "MemorySwap": 0,
+    "CpuShares": 0,
+    "Cpuset": ""
+  },
+  "NetworkSettings": {
+    "Bridge": "",
+    "SandboxID": "f304aa3b0e20fe1e0edb5984aedd03b7d5df999ff5ff9bd3ef8f831923e5f96a",
+    "HairpinMode": false,
+    "LinkLocalIPv6Address": "",
+    "LinkLocalIPv6PrefixLen": 0,
+    "Ports": {
+      "24224/tcp": [{
+        "HostIp": "0.0.0.0",
+        "HostPort": "24224"
+      }]
+    },
+    "SandboxKey": "/var/run/docker/netns/f304aa3b0e20",
+    "SecondaryIPAddresses": null,
+    "SecondaryIPv6Addresses": null,
+    "EndpointID": "7c6889977686db7c2b2042798b021a03df61c4273dcfd84fb2a9e5830fcb71a9",
+    "Gateway": "172.17.0.1",
+    "GlobalIPv6Address": "",
+    "GlobalIPv6PrefixLen": 0,
+    "IPAddress": "172.17.0.2",
+    "IPPrefixLen": 16,
+    "IPv6Gateway": "",
+    "MacAddress": "02:42:ac:11:00:02"
+  }
+}

data/test/helper.rb

@@ -0,0 +1,51 @@
+require "simplecov"
+SimpleCov.start
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'rubygems'
+require 'bundler'
+require 'docker'
+require 'timecop'
+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'
+require 'pry'
+
+
+require "simplecov"
+require "codeclimate-test-reporter"
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join("..", "..", "..", ENV['CIRCLE_ARTIFACTS'], "coverage")
+  SimpleCov.coverage_dir(dir)
+end
+
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+require 'webmock/test_unit'
+WebMock.disable_net_connect!(:allow => "codeclimate.com")
+
+if ENV.has_key?('VERBOSE')
+  $log = Fluent::Log.new(Fluent::Test::DummyLogDevice.new, Fluent::Log::LEVEL_TRACE)
+else
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+Docker.url = 'tcp://example.com:5422'
+require 'fluent/plugin/filter_ecs_filter'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_mesosphere.rb

@@ -0,0 +1,128 @@
+require 'helper'
+
+class ECSFilterTest < Test::Unit::TestCase
+  def setup
+    unless defined?(Fluent::Filter)
+      omit('Fluent::Filter is not defined. Use fluentd 0.12 or later.')
+    end
+
+    Fluent::Test.setup
+  end
+
+  # config_param :ratio, :float
+  # config_param :key_names, :string, :default => nil
+  # config_param :key_pattern, :string, :default => nil
+  # config_param :floor, :bool, :default => false
+  # config_param :remove_prefix, :string, :default => nil
+  # config_param :add_prefix, :string, :default => nil
+
+  CONFIG = %[]
+  CONFIG2 = %[
+    cache_size 2000
+    cache_ttl 300
+  ]
+  CONFIG3 = %[
+    get_container_id_tag true
+    container_id_attr container_id
+  ]
+
+  def create_driver(conf = CONFIG, tag = 'test')
+    Fluent::Test::FilterTestDriver.new(Fluent::ECSFilter, tag).configure(conf)
+  end
+
+  def setup_docker_stub(file, docker_api_url)
+    stub_request(:get, docker_api_url)
+      .to_return(status: 200, body: file, headers: {})
+  end
+
+  def setup_ecs_container(container_id, file_name)
+    docker_api_url = "http://tcp//example.com:5422/v1.16/containers/#{container_id}/json"
+    file = File.open("test/containers/#{file_name}.json", 'rb')
+    setup_docker_stub(file, docker_api_url)
+  end
+
+
+  def test_ecs_filter
+    setup_ecs_container('foobar123', 'ecs')
+
+    d1 = create_driver(CONFIG, 'docker.foobar123')
+    d1.run do
+      d1.filter('log' => 'Hello World 1')
+    end
+    filtered = d1.filtered_as_array
+
+    task_id = 'fdb86b4f-b919-4a65-89eb-4b3761eb8952'
+
+    log_entry = filtered[0][2]
+
+    assert_equal 'unifi-video', log_entry['task_family']
+    assert_equal '9', log_entry['task_version']
+    assert_equal task_id, log_entry['task_id']
+  end
+
+  def test_container_cache
+    setup_ecs_container('foobar123', 'ecs')
+
+    d1 = create_driver(CONFIG, 'docker.foobar123')
+    d1.run do
+      1000.times do
+        d1.filter('log' => 'Hello World 4')
+      end
+    end
+    docker_api_url = 'http://tcp//example.com:5422/v1.16/containers/foobar123/json'
+
+    assert_equal 1000, d1.filtered_as_array.length
+    assert_requested(:get, docker_api_url, times: 2)
+  end
+
+  def test_container_cache_expiration
+    setup_ecs_container('foobar123', 'ecs')
+
+    d1 = create_driver(CONFIG2, 'docker.foobar123')
+    d1.run do
+      d1.filter('log' => 'Hello World 4')
+    end
+
+    Timecop.travel(Time.now + 10 * 60)
+
+    d1.run do
+      d1.filter('log' => 'Hello World 4')
+    end
+
+    Timecop.return
+
+    docker_api_url = 'http://tcp//example.com:5422/v1.16/containers/foobar123/json'
+
+    assert_requested(:get, docker_api_url, times: 4)
+  end
+
+  def test_merge_json
+    setup_ecs_container('foobar123', 'ecs')
+
+    d1 = create_driver(CONFIG, 'docker.foobar123')
+    d1.run do
+      d1.filter('log' => '{"test_key":"Hello World"}')
+    end
+    filtered = d1.filtered_as_array
+    log_entry = filtered[0][2]
+
+    assert_equal 'Hello World', log_entry['test_key']
+  end
+
+  def test_bad_merge_json
+    setup_ecs_container('foobar123', 'ecs')
+    bad_json1 = '{"test_key":"Hello World"'
+    bad_json2 = '{"test_key":"Hello World", "badnews"}'
+
+    d1 = create_driver(CONFIG, 'docker.foobar123')
+    d1.run do
+      d1.filter('log' => bad_json1)
+      d1.filter('log' => bad_json2)
+    end
+    filtered = d1.filtered_as_array
+
+    assert_equal bad_json1, filtered[0][2]['log']
+    assert_equal bad_json2, filtered[1][2]['log']
+  end
+
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-ecs-filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.43
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.43
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.15.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: codeclimate-test-reporter
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: timecop
+  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: simplecov
+  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'
+description: Filter plugin to add AWS ECS metadata
+email:
+- jjhughes57@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-ecs-filter.gemspec
+- lib/fluent/plugin/filter_ecs_filter.rb
+- test/containers/ecs.json
+- test/helper.rb
+- test/plugin/test_mesosphere.rb
+homepage: https://github.com/joshughes/fluent-plugin-ecs-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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Filter plugin to add AWS ECS metadata to fluentd
+test_files:
+- test/containers/ecs.json
+- test/helper.rb
+- test/plugin/test_mesosphere.rb