logstash-filter-rancher_metadata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e76fdee2884c47ea727fe867a3cfa5b65a50105e
+  data.tar.gz: 1baff144bf47f92e722c39859d9fd53046f76546
+SHA512:
+  metadata.gz: cacbb87ea9d3e63bf958df523044cd71106f4a9bede3b7aa5d2a6f410764a346b4fc25a003467b0a1128e40c24157083af5d9b3f7f267af08a9dbe95ea5ac514
+  data.tar.gz: 5f1c222089adb8a64b15cf968c78ecc05bd512dbcdbc2be78f8623287419b4a12c6335c2a2d85e29d06fb41d96c7926450bd750da274fae48f076189fb0f8efa

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+ - First release

data/CONTRIBUTORS

@@ -0,0 +1,9 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped.
+
+Contributors:
+
+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/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2016 Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+
+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/NOTICE.txt

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,91 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+This filter add rancher metadata to messages that contain a Docker container ID.
+
+At current, the filter enriches the messages with the following tags
+- Container name (name)
+- Container IP (primary_ip)
+- Container service name (service_name)
+- Container stack name (stack_name)
+
+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.
+
+## Usage
+
+Configuration used : `logstash agent -e "filter { rancher_metadata {} }"`
+
+```
+## Filter parameters
+
+| name                  | default value                 | comment |
+| :-------------         | :-------------                 | :------------- |
+| `api_url`          | `[]` | Rancher Metadata API URL |
+| `field_docker_id` | `'container_id'`                    | The docker container ID message field |
+| `cache_size`          | 100                           |  |
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+There are no tests units.
+
+#### Build gem
+```sh
+gem build logstash-filter-rancher_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-rancher_metadata", :path => "/your/local/logstash-filter-rancher_metadata"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter { rancher_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
+
+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-rancher_metadata.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-rancher_metadata.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+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.
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/lib/logstash/filters/rancher_metadata.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require "logstash/filters/base"
+require "logstash/namespace"
+require 'json'
+require 'lru_redux'
+require 'rancher-metadata'
+
+class LogStash::Filters::RancherMetadata < LogStash::Filters::Base
+
+  # Setting the config_name here is required.
+  config_name "rancher_metadata"
+
+
+  config :api_url,
+    :validate => :array,
+    :default => [],
+    :required => false,
+    :deprecated => false
+
+  config :field_docker_id,
+    :validate => :string,
+    :default => 'path',
+    :required => false,
+    :deprecated => false
+
+  config :tags,
+    :validate => :array,
+    :default => ["name", "primary_ip", "service_name", "stack_name"],
+    :required => false,
+    :deprecated => false
+
+  config :cache_size,
+    :validate => :number,
+    :default => 100,
+    :required => false,
+    :deprecated => false
+
+  def get_metadata(container_id)
+    self.metadata_api.get_containers.each do |container|
+      return if container['uuid'] == container_id
+    end
+
+    nil
+  end
+
+  public
+  def register
+    # Add instance variables
+    @metadata_api = RancherMetadata::API.new({:api_url => @api_url})
+
+    @cache = LruRedux::ThreadSafeCache.new(@cache_size)
+  end # def register
+
+  public
+  def filter(event)
+    if event[@field_docker_id]
+      container_id = event[@field_docker_id]
+      metadata = @cache.getset(container_id){self.get_metadata(container_id)}
+    end
+
+    if metadata
+      event['rancher'] = {}
+
+      @tags.each do |tag|
+        event['rancher'][tag] = metadata[tag]
+      end
+    end
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::RancherMetadata

data/logstash-filter-rancher_metadata.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-rancher_metadata'
+  s.version = '0.0.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter add rancher metadata to messages that contain a Docker container ID"
+  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"
+  s.authors = ["Matteo Cerutti"]
+  s.email = 'matteo.cerutti@hotmail.co.uk'
+  s.homepage = "http://github.com/m4ce/logstash-filter-rancher_metadata"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+  s.add_runtime_dependency "rancher-metadata", "0.0.2"
+  s.add_runtime_dependency "lru_redux"
+  s.add_runtime_dependency "json"
+
+  s.add_development_dependency 'logstash-devutils'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-rancher_metadata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rancher-metadata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !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: json
+  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: logstash-devutils
+  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: 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
+email: matteo.cerutti@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.txt
+- README.md
+- lib/logstash/filters/rancher_metadata.rb
+- logstash-filter-rancher_metadata.gemspec
+homepage: http://github.com/m4ce/logstash-filter-rancher_metadata
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: This filter add rancher metadata to messages that contain a Docker container
+  ID
+test_files: []