fluent-plugin-systemd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 473961511b5ecf9533e4e5276317fcd91553a9b4
+  data.tar.gz: b340367404c3b3851dcdb720320fb0e2442a6166
+SHA512:
+  metadata.gz: ba42443dc10da1c1824a73395be4dc82dca01a45eb7a60e8d7455d6fb837b9d491c2c5dcf4c95683c5dadfbe4881e8539812d450aa960ed1ec33f4074c184bc5
+  data.tar.gz: b1ccb5cb033c495200a500a029e8ad72ab45413d0a4c112c7d7916789fa4e2c80634f4474999f70451288ca08cb5b4cebf648ea0b5f06569b5a1c217c81ede0d

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+sudo: required
+services:
+  - docker

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM quay.io/assemblyline/buildpack_deps:15.10
+
+RUN echo "deb http://ppa.launchpad.net/brightbox/ruby-ng/ubuntu vivid main" | tee /etc/apt/sources.list.d/ruby-ng.list \
+      && echo "deb-src http://ppa.launchpad.net/brightbox/ruby-ng/ubuntu vivid main" | tee -a /etc/apt/sources.list.d/ruby-ng.list \
+      && apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C3173AA6 \
+      && apt-get update -q && apt-get install -qy --no-install-recommends \
+        ruby2.2 \
+        ruby2.2-dev \
+        libsystemd-dev \
+      && apt-get clean \
+      && rm -rf /var/lib/apt/lists/* \
+      && truncate -s 0 /var/log/*log \
+      && gem install bundler
+
+WORKDIR /usr/local/src
+
+COPY Gemfile ./
+COPY fluent-plugin-systemd.gemspec ./
+RUN bundle install -j4 -r3
+COPY . .
+RUN bundle exec rake

data/Gemfile

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

data/LICENCE

@@ -0,0 +1,25 @@
+Copyright (c) 2015 Edward Robinson
+
+
+
+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,73 @@
+# systemd input plugin for [Fluentd](http://github.com/fluent/fluentd)
+
+[<img src="https://travis-ci.org/reevoo/fluent-plugin-systemd.svg?branch=master"
+alt="Build Status" />](https://travis-ci.org/reevoo/fluent-plugin-systemd) [<img
+src="https://codeclimate.com/github/reevoo/fluent-plugin-systemd/badges/gpa.svg"
+/>](https://codeclimate.com/github/reevoo/fluent-plugin-systemd)
+
+## Overview
+
+**systemd** input plugin reads logs from the systemd journal
+
+## Installation
+
+Simply use RubyGems:
+
+    gem install fluent-plugin-systemd
+
+    or
+
+    fluent-gem install fluent-plugin-systemd
+
+    or
+
+    td-agent-gem install fluent-plugin-systemd
+
+## Configuration
+
+    <source>
+      type systemd
+      path /var/log/journal
+      filters [{ "_SYSTEMD_UNIT": "kube-proxy.service" }]
+      pos_file kube-proxy.pos
+      tag kube-proxy
+      read_from_head true
+    </source>
+
+**path**
+
+Path to the systemd journal, defaults to `/var/log/journal`
+
+**filters**
+
+Array of filters, see [here](http://www.rubydoc.info/gems/systemd-journal/Systemd%2FJournal%2FFilterable%3Afilter) for futher
+documentation, defaults to no filtering.
+
+**pos file**
+
+Path to pos file, stores the journald cursor. File is created if does not exist.
+
+**read_from_head**
+
+If true reads all avalible journal from head, otherwise starts reading from tail,
+ ignored if pos file exists. Defaults to false.
+
+**tag**
+
+Required the tag for events generated by this input plugin.
+
+## Dependencies
+
+This plugin depends on libsystemd
+
+## Running the tests
+
+To run the tests simply run `rake test`
+
+For systems without systemd the tests are run in a docker container. So you will need docker or systemd installed to work on this.
+
+## Licence etc
+
+[MIT](LICENCE)
+
+Issues and pull requests welcome

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'reevoocop/rake_task'
+
+ReevooCop::RakeTask.new(:reevoocop)
+
+Rake::TestTask.new(:tests) do |t|
+  t.test_files = Dir['test/**/test_*.rb']
+end
+
+task default: :test
+task build: :test
+task tests: :reevoocop
+
+namespace :docker do
+  task :test do
+    sh 'docker build .'
+  end
+end
+
+task :test do
+  if system('which journalctl')
+    Rake::Task['tests'].invoke
+  else
+    Rake::Task['docker:test'].invoke
+  end
+end

data/fluent-plugin-systemd.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: 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-systemd'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Ed Robinson']
+  spec.email         = ['ed@reevoo.com']
+
+  spec.summary       = 'Input plugin to read from systemd journal.'
+  spec.description   = 'This is a fluentd input plugin. It reads logs from the systemd journal.'
+  spec.homepage      = 'https://github.com/assemblyline/fluent-plugin-systemd'
+  spec.license       = 'MIT'
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'test-unit', '~> 3.1'
+  spec.add_development_dependency 'reevoocop'
+
+  spec.add_runtime_dependency 'fluentd', '~> 0.12'
+  spec.add_runtime_dependency 'systemd-journal', '~> 1.2'
+end

data/lib/fluent/plugin/in_systemd.rb

@@ -0,0 +1,62 @@
+require 'systemd/journal'
+require 'fluent/plugin/systemd/pos_writer'
+
+module Fluent
+  class SystemdInput < Input
+    Fluent::Plugin.register_input('systemd', self)
+
+    config_param :path, :string, default: '/var/log/journal'
+    config_param :filters, :array, default: []
+    config_param :pos_file, :string, default: nil
+    config_param :read_from_head, :bool, default: false
+    config_param :tag, :string
+
+    attr_reader :tag
+
+    def configure(conf)
+      super
+      @pos_writer = PosWriter.new(conf['pos_file'])
+      @journal = Systemd::Journal.new(path: path)
+      journal.filter(*filters)
+      read_from = @pos_writer.cursor || (conf['read_from_head'] ? :head : :tail)
+      journal.seek(read_from)
+    end
+
+    def start
+      super
+      @running = true
+      pos_writer.start
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      @running = false
+      @thread.join
+      pos_writer.shutdown
+    end
+
+    private
+
+    attr_reader :journal, :running, :lock, :cursor, :path, :pos_writer
+
+    def run
+      watch do |entry|
+        router.emit(tag, entry.realtime_timestamp.to_i, formatted(entry))
+      end
+    end
+
+    def formatted(entry)
+      entry.to_h
+    end
+
+    def watch
+      while running
+        next unless journal.wait(1_000_000)
+        while journal.move_next && running
+          yield journal.current_entry
+          pos_writer.update(journal.cursor)
+        end
+      end
+    end
+  end
+end

data/lib/fluent/plugin/systemd/pos_writer.rb

@@ -0,0 +1,58 @@
+module Fluent
+  class SystemdInput < Input
+    class PosWriter
+      def initialize(pos_file)
+        @path = pos_file
+        setup
+      end
+
+      attr_reader :cursor
+
+      def start
+        return unless path
+        @running = true
+        @thread = Thread.new(&method(:work))
+      end
+
+      def shutdown
+        return unless path
+        @running = false
+        thread.join
+        write_pos
+      end
+
+      def update(c)
+        return unless path
+        lock.synchronize { @cursor = c }
+      end
+
+      private
+
+      attr_reader :path, :lock, :thread, :running
+
+      def setup
+        return unless path
+        @lock = Mutex.new
+        @cursor = IO.read(path).chomp if File.exist?(path)
+      end
+
+      def work
+        while running
+          write_pos
+          sleep 1
+        end
+      end
+
+      def write_pos
+        lock.synchronize do
+          if @written_cursor != cursor
+            file = File.open(path, 'w+')
+            file.print cursor
+            file.close
+            @written_cursor = cursor
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-systemd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: reevoocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: systemd-journal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: This is a fluentd input plugin. It reads logs from the systemd journal.
+email:
+- ed@reevoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- fluent-plugin-systemd.gemspec
+- lib/fluent/plugin/in_systemd.rb
+- lib/fluent/plugin/systemd/pos_writer.rb
+homepage: https://github.com/assemblyline/fluent-plugin-systemd
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Input plugin to read from systemd journal.
+test_files: []