logstash-filter-docker_metadata 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e27085c3fc043610a6d2889c3c66d9e0d0b06e19
-  data.tar.gz: 7547457411708777837e20d757868d2caac358ca
+  metadata.gz: a66da1eeb97f430fd70b50c0f64e919720f4deb7
+  data.tar.gz: b7541a2bf62f822fa9451add76409f44a84a4cf2
 SHA512:
-  metadata.gz: 9ff8f359f4798bbb4a3ca51cd0fd1d47e48ca124b5a1c2f42ceeac16a55134398fe410e683baae481af3294295d7a88779cacd6620374fe96bca1c56f3794675
-  data.tar.gz: aa2abcd82f6e77e5c0f003c79ab3fd3c1fde3f6d78446df2ba418e6f019caf80d486c4abf256964fc1e3470de50ab59c4a89081c553017086917608b1f540f6d
+  metadata.gz: 18ec65c708656acbbd13a616cb575a731a773c440e6e5d2dbdadcf0138c0988b0380a246b4d545ca6772e29243c3ede67376b20113991a308a7eae9efcf4af47
+  data.tar.gz: 06873c46f5dc1bffcb953ddd7b358f55ba4958a7437797e0c1129edd9de573c3fea505d6528b33c3f95ed12a9958e4667838394a0d77ede70d5aa8e3dec789f0

data/README.md

@@ -2,18 +2,65 @@
 
 This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
 
-It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+This filter add docker metadata to messages that contain a docker ID. It's heavily inspired from [fluent-plugin-docker_metadata_filter](https://github.com/fabric8io/fluent-plugin-docker_metadata_filter).
 
-## Documentation
+This plugin use the Docker socket to call Docker API, therefore it needs the docker socket to be mounted (at least in read-only mode) inside the container. 
+Example : 
+```
+docker run -ti -v /var/run/docker.sock:/var/run/docker.sock:ro logstash 
+```  
+
+At this point, It add to the event :
+- name of the container
+- complete id of the container
+- image used
+- labels
+- environment variables injected inside the container
+
+But everything accessible from the docker API (or via `docker inspect `) can be exported.
+
+## Usage 
+
+Configuration used : `logstash agent -e "filter { docker_metadata{} }"`
+
+Another container is running with `-e jesuis=goleri` with ID `68073a44cdde2d2a14a91e06a036c9c03f8c3122deb47e44c908f5fb6391394e` .
+
+Input :
+```json
+ConfPath": "/var/lib/docker/containers/68073a44cdde2d2a14a91e06a036c9c03f8c3122deb47e44c908f5fb6391394e/resolv.conf",
+```
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash output :
+```
+{
+       "message" => "ConfPath\": \"/var/lib/docker/containers/68073a44cdde2d2a14a91e06a036c9c03f8c3122deb47e44c908f5fb6391394e/resolv.conf\",",
+      "@version" => "1",
+    "@timestamp" => "2015-08-04T14:49:51.807Z",
+          "type" => "stdin",
+          "host" => "4187a88a77cf",
+        "docker" => {
+                        :id => "68073a44cdde2d2a14a91e06a036c9c03f8c3122deb47e44c908f5fb6391394e",
+                      :name => "/serene_wilson",
+        :container_hostname => "68073a44cdde",
+                     :image => "kk_centos",
+                  :image_id => "c0050e8a70ae96325986222df1ce0b81e9170a01442173de39c6b622eb0bda22",
+                    :labels => {},
+                       :env => {
+            "jesuis" => "goleri",
+              "PATH" => "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+        }
+    }
+}
+```
+## Filter parameters
 
-- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+| name                  | default value                 | comment |
+| :-------------         | :-------------                 | :------------- |
+| `docker_url`          | `unix:///var/run/docker.sock` | make sure it match where you mount the docker socket |
+| `container_id_regexp` | `(\w{64})`                    | match the complete Id of a docker container |
+| `cache_size`          | 100                           |  |
 
-## Need Help?
 
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
 ## Developing
 
@@ -22,58 +69,51 @@ Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/log
 #### Code
 - To get started, you'll need JRuby with the Bundler gem installed.
 
-- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
-
 - Install dependencies
 ```sh
 bundle install
 ```
 
 #### Test
+There is no unit tests. 
+TODO : write unit tests
 
-- Update your dependencies
-
+#### Build gem
 ```sh
-bundle install
+gem build logstash-filter-docker_metadata.gemspec
 ```
 
-- Run tests
+### 2. Running your unpublished Plugin in Logstash
 
+#### 2.1 Run in a local Logstash Docker container
+There is a script which launch a docker container using the latest logstash image and mount this directory into the container at `/tmp/logstash-filter/`
+
+- Build the gem outside of the container
 ```sh
-bundle exec rspec
+gem build logstash-filter-docker_metadata.gemspec
 ```
 
-### 2. Running your unpublished Plugin in Logstash
-
-#### 2.1 Run in a local Logstash clone
-
-- Edit Logstash `Gemfile` and add the local plugin path, for example:
-```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+- start the docker container
+```sh
+./dockerTest.sh
 ```
+
 - Install plugin
 ```sh
-bin/plugin install --no-verify
+plugin install /tmp/logstash-filter/logstash-filter-docker_metadata-0.1.0.gem
 ```
 - Run Logstash with your plugin
 ```sh
-bin/logstash -e 'filter {awesome {}}'
+logstash agent -e "filter { docker_metadata{} }"
 ```
-At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
 
-#### 2.2 Run in an installed Logstash
+The 2 last steps can be done in one command using `setupPlugin` command.
+
+
+At this point any modifications to the plugin code will not be applied to this local Logstash setup.
+After modifying the plugin, rebuild the gem and reinstalle it inside the docker container.
 
-You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
 
-- Build your plugin gem
-```sh
-gem build logstash-filter-awesome.gemspec
-```
-- Install the plugin from the Logstash home
-```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
-```
-- Start Logstash and proceed to test the plugin
 
 ## Contributing
 
@@ -83,4 +123,7 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+
+## Licence
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

data/dockerTest.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+PWD=$(pwd)
+docker run -ti \
+-v $PWD:/tmp/logstash-filter \
+-v $PWD/setup.sh:/usr/local/bin/setupPlugin \
+-v /var/run/docker.sock:/var/run/docker.sock:ro \
+logstash bash

data/lib/logstash/filters/docker_metadata.rb

@@ -13,6 +13,7 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
   # Setting the config_name here is required.
   config_name "docker_metadata"
   
+
   config :docker_url,
     :validate => :string,
     :default => 'unix:///var/run/docker.sock',
@@ -63,7 +64,9 @@ class LogStash::Filters::DockerMetadata < LogStash::Filters::Base
   def filter(event)
 
     # get container id from message field
-    container_id = event["message"].match(@container_id_regexp_compiled)
+    if event["message"]
+      container_id = event["message"].match(@container_id_regexp_compiled)
+    end
 
     # if it failed fall back to source field
     if !container_id || !container_id[0]

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.0'
+  s.version         = '0.1.1'
   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"

data/setup.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+plugin install /tmp/logstash-filter/logstash-filter-docker_metadata-0.1.0.gem
+logstash agent -e "filter { docker_metadata{} }"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-docker_metadata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -93,19 +93,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- CHANGELOG.md
-- CONTRIBUTORS
-- DEVELOPER.md
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
 - Rakefile
+- dockerTest.sh
 - lib/logstash/filters/docker_metadata.rb
 - logstash-filter-docker_metadata.gemspec
+- setup.sh
 - spec/filters/docker_metadata_spec.rb
 - spec/spec_helper.rb
-- test.sh
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)

data/CONTRIBUTORS

@@ -1,11 +0,0 @@
-The following is a list of people who have contributed ideas, code, bug
-reports, or in general have helped logstash along its way.
-
-Contributors:
-* Aaron Mildenstein (untergeek)
-* Pier-Hugues Pellerin (ph)
-
-Note: If you've sent us patches, bug reports, or otherwise contributed to
-Logstash, and you aren't on the list above and want to be, please let us know
-and we'll make sure you're here. Contributions from folks like you are what make
-open source awesome.

data/DEVELOPER.md

@@ -1,2 +0,0 @@
-# logstash-filter-example
-Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/test.sh

@@ -1,4 +0,0 @@
-docker run -ti \
--v /home/germaint/dev/logstash-filter-docker-metadata:/tmp/logstash-filter \
--v /var/run/docker.sock:/var/run/docker.sock:ro \
-logstash bash