ant31-logstash-filter-kubernetes 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c5e7e5922310a9d9df5e7a65ac465b8483b087c
+  data.tar.gz: 4186881eb76c366fa9073a771f5e30a3897e1013
+SHA512:
+  metadata.gz: 19742e9de3d8ebd4891b8f32c8dd53989a3c683fb84862f0d6374f3dbab829763e550b14452595ef879ad3ea5db5685350b41941a60ba2949e894e3f65b24523
+  data.tar.gz: 0b6fbc21e9fb2f396e73ee483c34903f72f23033e6895cf2b28c98b2b316e7bd31ac6af7d11a23f9257f9915f85760fec480697ecef73fb4f77c32ba55b55de4

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Vaidas Jablonskis <jablonskis@gmail.com>
+
+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,114 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/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.
+
+Rubygems: https://rubygems.org/gems/logstash-filter-kubernetes
+
+## Documentation
+
+This plugin does not require access to Kubernetes API.
+
+### Example configuration
+```ruby
+input {
+  file {
+    # Path to kubelet created symlinks to docker logs, by default, symlinks look like
+    # /var/log/containers/*.log --> /var/lib/docker/containers/*/*-json.log
+    path => "/var/log/containers/*.log"
+  }
+}
+
+filter {
+  kubernetes {}
+}
+
+output {
+  stdout {}
+}
+```
+
+If you're running logstash in a container, make sure that you mount both,
+`/var/log/containers` and `/var/lib/docker/containers` for logstash input to be
+able to follow symlinks.
+
+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.elastic.co/guide/en/logstash/current/).
+
+- 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/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### 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
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 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-kubernetes", :path => "/your/local/logstash-filter-kubernetes"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {kubernetes {}}'
+```
+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-kubernetes.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-kubernetes.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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/ant31-logstash-filter-kubernetes.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'ant31-logstash-filter-kubernetes'
+  s.version         = '5.0.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter extracts useful kubernetes information from kubelet logfile symlinks."
+  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 = ["Vaidas Jablonskis"]
+  s.email = 'jablonskis@gmail.com'
+  s.homepage = "https://github.com/vaijab/logstash-filter-kubernetes"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+   # 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"
+  s.add_development_dependency 'logstash-devutils', '~> 0'
+end

data/lib/logstash/filters/kubernetes.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This filter plugin allows you extract Pod, Namespace, etc from kubernetes.
+# The way this filter works is very simple. It looks at an event field which
+# contains full path to kubelet created symlinks to docker container logs and
+# extracts useful information from a symlink name. No access to Kubernetes API
+# is required.
+class LogStash::Filters::Kubernetes < LogStash::Filters::Base
+
+  # This is how you configure this filter from your Logstash config.
+  #
+  # Example:
+  # [source,ruby]
+  # input {
+  #   file {
+  #     # Path to kubelet symlinks to docker logs, by default, symlinks look like
+  #     # /var/log/containers/*.log --> /var/lib/docker/containers/*/*-json.log
+  #     path => "/var/log/containers/*.log"
+  #   }
+  # }
+  #
+  # filter {
+  #   kubernetes {
+  #     source => "path"
+  #     target => "kubernetes"
+  #   }
+  # }
+  #
+  config_name "kubernetes"
+
+  # The source field name which contains full path to kubelet log file.
+  config :source, :validate => :string, :default => "path"
+
+  # The target field name to write event kubernetes metadata.
+  config :target, :validate => :string, :default => "kubernetes"
+
+
+  public
+  def register
+    # Nothing to do
+  end # def register
+
+  public
+  def filter(event)
+
+    if @source and event[@source]
+      parts = event[@source].split(File::SEPARATOR).last.gsub(/.log$/, '').split('_')
+
+      # We do not care about empty POD log files
+      if parts.length != 3 || parts[2].start_with?('POD-')
+        return
+      else
+        kubernetes = {}
+        kubernetes['replication_controller'] = parts[0].gsub(/-[0-9a-z]*$/, '')
+        kubernetes['pod'] = parts[0]
+        kubernetes['namespace'] = parts[1]
+        kubernetes['container_name'] = parts[2].gsub(/-[0-9a-z]*$/, '')
+        kubernetes['container_id'] = parts[2].split('-').last
+
+        event[@target] = kubernetes
+      end
+    end
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::Kubernetes

data/spec/filters/kubernetes_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require "logstash/filters/kubernetes"
+
+describe LogStash::Filters::Kubernetes do
+  describe "Split path into kubernetes key-value pairs." do
+    let(:config) do <<-CONFIG
+      filter {
+        kubernetes {
+          source => "path"
+        }
+      }
+    CONFIG
+    end
+
+    sample("path" => "/var/log/containers/kube-dns-v9-6mnxk_default_skydns-47d3a3bfb112dbd2fd6e255e1e3d9eb91a10b62342e620e4917e2f5e24398507.log") do
+      insist { subject["kubernetes"] } == {"replication_controller"=>"kube-dns-v9", "pod"=>"kube-dns-v9-6mnxk", "namespace"=>"default", "container_name"=>"skydns", "container_id"=>"47d3a3bfb112dbd2fd6e255e1e3d9eb91a10b62342e620e4917e2f5e24398507"}
+    end
+  end
+end
+
+describe LogStash::Filters::Kubernetes do
+  describe "Set target field name." do
+    let(:config) do <<-CONFIG
+      filter {
+        kubernetes {
+          source => "path"
+          target => "foobar"
+        }
+      }
+    CONFIG
+    end
+
+    sample("path" => "/var/log/containers/kube-dns-v9-6mnxk_default_skydns-47d3a3bfb112dbd2fd6e255e1e3d9eb91a10b62342e620e4917e2f5e24398507.log") do
+      insist { subject["foobar"] } == {"replication_controller"=>"kube-dns-v9", "pod"=>"kube-dns-v9-6mnxk", "namespace"=>"default", "container_name"=>"skydns", "container_id"=>"47d3a3bfb112dbd2fd6e255e1e3d9eb91a10b62342e620e4917e2f5e24398507"}
+    end
+  end
+end
+
+describe LogStash::Filters::Kubernetes do
+  describe "Skip parsing empty POD event." do
+    let(:config) do <<-CONFIG
+      filter {
+        kubernetes {
+          source => "path"
+        }
+      }
+    CONFIG
+    end
+
+    sample("path" => "/var/log/containers/kube-dns-v9-6mnxk_default_POD-eaca2cf56e761c25dc4878d48fbe056402ba01f3f6448650d93f988ec121b8cd.log") do
+      insist { subject["kubernetes"] } == nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: ant31-logstash-filter-kubernetes
+version: !ruby/object:Gem::Version
+  version: 5.0.0
+platform: ruby
+authors:
+- Vaidas Jablonskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  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: jablonskis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- ant31-logstash-filter-kubernetes.gemspec
+- lib/logstash/filters/kubernetes.rb
+- spec/filters/kubernetes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vaijab/logstash-filter-kubernetes
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This filter extracts useful kubernetes information from kubelet logfile symlinks.
+test_files:
+- spec/filters/kubernetes_spec.rb
+- spec/spec_helper.rb