logstash-filter-docker_metadata 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 000be01a06b8f7d60099cf0b4fb958cc8f4f1620
-  data.tar.gz: 36332effcda2cd70d8d404b1066d1d6346a337ae
+  metadata.gz: 14333113d790da8f7dcb90098edff17202415619
+  data.tar.gz: 32845e1df70de9b55094da11470edb0c9d89d5a0
 SHA512:
-  metadata.gz: 926be3f80c06cf3d560775bc4122e62c52de798328931233b38f68f6f04a98d1bbdf53b1eae860806ff6f054a1d20c5e7050feb9b02cef9a5716558bad68a374
-  data.tar.gz: 8f906e5bb6ab7c8e9db7d3069cd8248f7d5918d09824ea727fbc7b50260cb7985e0f508d7ecb1fb4abc05cbd036bb8630fd9c987992da80748d3f420dc5fe7f2
+  metadata.gz: 47377aa16c3664d128ba4fa9e3e74bf147826e4e9f2401bc0d2938c2c995e4c33735b8105bdf3f74081a1663b5fae4be821a32ed739e6fa1085ae57d5adbc932
+  data.tar.gz: e3b6c7c146f68229d9c37ca9a13aed3ff5f1fa84d085f108aff73340b158f1d6dc9dacbbfc69cc175337b2dc92e774bab43976195dcfed3089adf538a8ee0991

data/lib/logstash/filters/docker_hash.rb

@@ -0,0 +1,7 @@
+require 'hashie'
+
+class DockerHash < Hash
+
+  include Hashie::Extensions::IndifferentAccess
+
+end

data/lib/logstash/filters/docker_metadata.rb

@@ -4,7 +4,9 @@ require "logstash/namespace"
 require 'docker'
 require 'json'
 require 'lru_redux'
-# This example filter will replace the contents of the default 
+
+require_relative 'docker_hash'
+# This example filter will replace the contents of the default
 # message field with whatever you specify in the configuration.
 #
 # It is only intended to be used as an example.
@@ -12,7 +14,7 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
 
   # Setting the config_name here is required.
   config_name "docker_metadata"
-  
+
 
   config :docker_url,
     :validate => :string,
@@ -37,7 +39,7 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
     :default => '(\w{64})',
     :required => false,
     :deprecated => false
-  
+
   def get_metadata(container_id)
     begin
       Docker::Container.get(container_id).info
@@ -59,7 +61,7 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
 
   public
   def register
-    # Add instance variables 
+    # Add instance variables
     Docker.url = @docker_url
 
     @cache = LruRedux::ThreadSafeCache.new(@cache_size)
@@ -68,13 +70,11 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
 
   public
   def filter(event)
-
     # get container id from @field_docker_id field
     if event[@field_docker_id]
       container_id = event[@field_docker_id].match(@container_id_regexp_compiled)
     end
 
-
     if container_id && container_id[0]
       container_id = container_id[0]
       # try the cache else call the docker API
@@ -83,16 +83,17 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
 
     if metadata
       # add a docker field with all informations
-      event["docker"] = {
-
-        :id                 => metadata['id'],
-        :name               => metadata['Name'],
-        :container_hostname => metadata['Config']['Hostname'],
-        :image              => metadata['Config']['Image'],
-        :image_id           => metadata['Image'],
-        :labels             => metadata['Config']['Labels'],
-        :env                => self.format_env(metadata['Config']['Env'])
-      }
+      # Added as custom hash so we get easy IndifferentAccess as symbol keys
+      # proved pretty hard to work with in logstash config
+      event["docker"] = DockerHash.new
+      event["docker"][:id]                  = metadata['id']
+      event["docker"][:name]                = metadata['Name']
+      event["docker"][:container_hostname]  = metadata['Config']['Hostname'],
+      event["docker"][:image]               = metadata['Config']['Image'],
+      event["docker"][:image_id]            = metadata['Image'],
+      event["docker"][:labels]              = metadata['Config']['Labels'],
+      event["docker"][:env]                 = self.format_env(metadata['Config']['Env'])
+
     end
 
     # filter_matched should go in the last line of our successful code

data/logstash-filter-docker_metadata.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-docker_metadata'
-  s.version         = '0.1.4'
+  s.version         = '0.1.5'
   s.licenses = ['Apache License (2.0)']
   s.summary = "This filter add docker metadata to messages that contain a docker ID. It's heavily inspired from https://github.com/fabric8io/fluent-plugin-docker_metadata_filter."
   s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -18,10 +18,11 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
-  s.add_runtime_dependency 'docker-api'  
-  s.add_runtime_dependency 'lru_redux'   
-  s.add_runtime_dependency 'json'        
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+  s.add_runtime_dependency 'docker-api'
+  s.add_runtime_dependency 'lru_redux'
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'hashie'
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/filters/docker_metadata_spec.rb

@@ -1,20 +1,44 @@
-require 'spec_helper'
-require "logstash/filters/dockerMetadata"
+require_relative "../spec_helper"
+require "logstash/filters/docker_metadata"
 
-describe LogStash::Filters::dockerMetadata do
-  describe "Set to Hello World" do
+describe LogStash::Filters::DockerMetadata do
+
+  let(:container_info) do
+    metadata = {}
+    metadata['id'] = "123456789"
+    metadata['Name'] = "container"
+    metadata['Image'] = "image_id"
+    metadata['Config'] = {}
+    metadata['Config']['Hostname'] = "hostname"
+    metadata['Config']['Image'] = "image"
+    metadata['Config']['Labels'] = { "label1" => "label_value"}
+    metadata['Config']['Env'] = [
+      "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
+      "NGINX_VERSION=1.9.5-1~jessie"
+    ]
+    metadata
+  end
+
+
+  describe "Docker container metadada as symbol keys in hash by default" do
     let(:config) do <<-CONFIG
       filter {
         docker_metadata {
-          
+
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
-      expect(subject).to include("message")
-      expect(subject['message']).to eq('Hello World')
+    sample("path" => "/var/lib/docker/containers/d58155b6b2979776ef3594838536375ec19c6452431888f1d71bb7b2d5b8d84b/d58155b6b2979776ef3594838536375ec19c6452431888f1d71bb7b2d5b8d84b-json.log") do
+      c = double()
+      expect(Docker::Container).to receive(:get).with('d58155b6b2979776ef3594838536375ec19c6452431888f1d71bb7b2d5b8d84b').and_return(c)
+      expect(c).to receive(:info).and_return(container_info)
+
+      expect(subject['docker']).not_to be_nil
+      expect(subject['docker']['name']).to eq('container')
+      expect(subject['docker']['name']).to eq(subject['docker'][:name])
+      expect(subject['docker']['env']['NGINX_VERSION']).to eq('1.9.5-1~jessie')
     end
   end
 end

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-docker_metadata
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   name: logstash-core
   prerelease: false
   type: :runtime
@@ -26,10 +26,10 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -72,6 +72,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: hashie
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -99,6 +113,7 @@ files:
 - README.md
 - Rakefile
 - dockerTest.sh
+- lib/logstash/filters/docker_hash.rb
 - lib/logstash/filters/docker_metadata.rb
 - logstash-filter-docker_metadata.gemspec
 - setup.sh