fluent-plugin-docker-format 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b01883397bc25c175beeb51f0dee5eeb0418eb83
+  data.tar.gz: b0a4bc332d9c179b789e1392d30d9eee0a21d31c
+SHA512:
+  metadata.gz: c235243284c7146c68712b0be4f7f655903fea69113e4594818671c81835b76be9e0e4679b8b7b1a48ec7b93074f333ec706673d1e610aff63c1fa0700814b16
+  data.tar.gz: 11915f2fd54669bf12cdab326b891076971bc404fe0abfcaadea1db0a404d22b756dd1c400a6a7d25af780331bec2d34e888df35fd6b15dc52d6c5f4b095b612

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Hornung
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Fluent::Plugin::Docker::Format
+
+This fluentd output filter plugin can parse a docker container's config.json associated with a certain log entry and add information from config.json to the record.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-docker-format'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-docker-format
+
+
+## Usage
+
+```
+<match docker.var.lib.docker.containers.*.*.log>
+  type docker_format
+  docker_containers_path /var/lib/docker/containers
+  container_id ${tag_parts[5]}
+  tag docker.all
+</match>
+```
+
+The `docker_containers_path` is optional and defaults to `/var/lib/docker/containers`.
+
+The `container_id` parameter can either be a string with the id, or use the special interpolated substitution `${tag_parts[<some number>]}`. The tag parts are the dot-separated parts of the incoming tag, so that in the above example they would match the first star.
+
+A full example:
+
+```
+<source>
+  type tail
+  path /var/lib/docker/containers/*/*-json.log
+  pos_file /var/log/fluentd-docker.pos
+  time_format %Y-%m-%dT%H:%M:%S
+  tag docker.*
+  format json
+</source>
+
+<match docker.var.lib.docker.containers.*.*.log>
+  type docker_format
+  container_id ${tag_parts[5]}
+  tag docker.all
+</match>
+```
+
+The output record will have two additional fields, `container_id` and `container_name`.
+
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/fluent-plugin-docker-format.gemspec

@@ -0,0 +1,25 @@
+# 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-docker-format"
+  spec.version       = File.read("VERSION").strip
+  spec.authors       = ["Alex Hornung"]
+  spec.email         = ["alex@alexhornung.com"]
+  spec.description   = %q{fluentd output filter plugin to parse the docker config.json related to a container log file.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/bwalex/fluent-plugin-docker-format"
+  spec.license       = "MIT"
+  spec.has_rdoc      = false
+
+  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", "~> 10.4.2"
+
+  spec.add_dependency "fluentd", "~> 0.10.17"
+end

data/lib/fluent/plugin/out_docker_format.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module Fluent
+  class DockerFormatOutput < Output
+    Fluent::Plugin.register_output('docker_format', self)
+    config_param :tag, :string
+    config_param :container_id, :string
+    config_param :docker_containers_path, :string, :default => '/var/lib/docker/containers'
+
+    def configure(conf)
+      super
+      @id_to_name = {}
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time,record|
+        Engine.emit(@tag, time, format_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 get_name_from_cfg(id)
+      begin
+        docker_cfg = JSON.parse(File.read("#{@docker_containers_path}/#{id}/config.json"))
+        container_name = docker_cfg['Name']
+      rescue
+        container_name = "<unknown>"
+      end
+      container_name
+    end
+
+    def get_name(id)
+      @id_to_name[id] = get_name_from_cfg(id) unless @id_to_name.has_key? id
+      @id_to_name[id]
+    end
+
+    def format_record(tag, record)
+      id = interpolate(tag, @container_id)
+      record['container_id'] = id
+      record['container_name'] = get_name(id)
+      record
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-docker-format
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Hornung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+description: fluentd output filter plugin to parse the docker config.json related
+  to a container log file.
+email:
+- alex@alexhornung.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-docker-format.gemspec
+- lib/fluent/plugin/out_docker_format.rb
+homepage: https://github.com/bwalex/fluent-plugin-docker-format
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: fluentd output filter plugin to parse the docker config.json related to a
+  container log file.
+test_files: []