fluent-plugin-out_apache_log_format 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e782ff8eb1ff4b9753bfdbbd7384bfc7d256250
+  data.tar.gz: 39937cbd2ab2bff12f3e2007bc18a01127863571
+SHA512:
+  metadata.gz: 5ec770ff0b24714859ac98673a8113758a731d1b8bb5e4ad09611b125a11998f2e6826069250f0cfa43e41eb9034bdf6ee7a0dc0d7dd98f49025d1f5143594ef
+  data.tar.gz: d9baca596404636e31e3ff8595196b206423c446fbd310fd243d6063830ff8c2c2769e20e7c513d8bf7671ca5f4a29d85e9b7ca5aa971cdae40c774568a0b867

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-fluent-plugin-out_apache_log_format.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 jorge moratilla
+
+MIT License
+
+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,76 @@
+# Fluentd output plugin from custom log format to Apache Common Combined Log Format.
+
+This is a quick and dirty try on creating an output filter for Fluentd (http://fluentd.org).
+
+This plugin doesn't work alone.  You need to install and configure the fluentd data collector.
+
+
+## Installation
+
+First, create an empty bundle project:
+
+    $ bundle init
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'fluentd'
+gem 'fluent-plugin-out_apache_log_format'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-out_apache_log_format
+
+## Usage
+
+This is an output plugin for Fluentd.  You need a fluentd config file to make it works.
+
+```
+# fluent conversor: from our custom log format to apache common combined log format 
+<source>
+  @type tail
+  format /\A(?<logid>(\d+) <(\d+)>(\d+)) (?<timestamp>\S+) app (?<host>\S+) - - \[REQUEST\] request_id='(?<request_id>.*?)' action='(?<action>.*?)' format='(?<format>.*?)' method='(?<method>.*?)' path='(?<path>.*?)' user_agent='(?<user_agent>.*?)' ip='(?<proxy_ip>.*?)' xff_ip='(?<ip_chain>.*?)' referer='(?<referer>.*?)' scheme='(?<scheme>.*?)' status='(?<status>.*?)' measuretime='(?<measuretime>.*?)'\z/
+  path inputfile
+  pos_file inputfile.pos
+  tag get_remote_host
+</source>
+
+# This filter helps to get the real source ip address from the connection.
+<filter get_remote_host>
+  @type record_transformer
+  enable_ruby true
+  <record>
+    ip ${ip_chain.split(',')[0]}
+  </record>
+</filter>
+
+# This output config will send everything to stdout
+<match *>
+  @type alf
+</match>
+
+```
+
+Now you can execute the following command:
+
+
+    $ fluentd -c fluentd.conf
+
+
+
+And send logs to the inputfile with:
+ 
+
+    $ cat logfile >> inputfile
+
+They will be filtered, parsed and converted to Apache Log Format.
+
+If you want to generate a file, then append a tee command to the fluentd command, like:
+
+    $ fluentd -qqc fluentd.conf | tee outputfile
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/fluent-plugin-out_apache_log_format.gemspec

@@ -0,0 +1,25 @@
+# coding: 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-out_apache_log_format"
+  spec.version       = '0.0.6'
+  spec.authors       = ["jorge moratilla"]
+  spec.email         = ["jorge@moratilla.com"]
+  spec.summary       = %q{This output filter generates Combined Common Log Format entries}
+  spec.description   = %q{This output filter generates Combined Common Log Format entries}
+  spec.homepage      = "https://bitbucket.org/jmoratilla/fluent-plugin-out_apache_log_format"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "fluentd"
+
+end

data/lib/fluent/plugin/out_alf.rb

@@ -0,0 +1,58 @@
+require 'fluent/output'
+
+module Fluent
+  class ApacheLogFormat < Output
+    # First, register the plugin. NAME is the name of this plugin
+    # and identifies the plugin in the configuration file.
+    Fluent::Plugin.register_output('alf', self)
+
+    # TODO: Add params to allow different field names for the log
+    # "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %D"
+    # config_param :host, :string
+    # config_param :time, :string
+    # config_param :method, :string
+    # config_param :path, :string
+    # config_param :status, :string
+    # config_param :size, :integer, :default => 0
+    # config_param :referer, :string, :default => ''
+    # config_param :user_agent, :string, :default => ''
+    # config_param :response_time, :integer, :default => ''
+
+    def configure(conf)
+      super
+    end
+
+    def initialize
+      super
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    # This method is called when an event reaches Fluentd.
+    # 'es' is a Fluent::EventStream object that includes multiple events.
+    # You can use 'es.each {|time,record| ... }' to retrieve events.
+    # 'chain' is an object that manages transactions. Call 'chain.next' at
+    # appropriate points and rollback if it raises an exception.
+    #
+    # NOTE! This method is called by Fluentd's main thread so you should not write slow routine here. It causes Fluentd's performance degression.
+    def emit(tag, es, chain)
+      chain.next
+      es.each {|time,record|
+        puts output_record(record)
+      }
+
+    end
+
+    private
+
+    def output_record(record)
+      "#{record['ip']} - - [#{DateTime.parse(record['timestamp']).strftime("%d/%b/%Y:%H:%M:%S %z")}] \"#{record['method']} #{record['path'].empty? ? '/' : record['path']}\" #{record['status']} 1024 \"#{record['referer']}\" \"#{record['user_agent']}\" #{record['measuretime']}"
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-out_apache_log_format
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- jorge moratilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  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'
+description: This output filter generates Combined Common Log Format entries
+email:
+- jorge@moratilla.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/out_apache_log_format.iml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-out_apache_log_format.gemspec
+- lib/fluent/plugin/out_alf.rb
+homepage: https://bitbucket.org/jmoratilla/fluent-plugin-out_apache_log_format
+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.4.3
+signing_key: 
+specification_version: 4
+summary: This output filter generates Combined Common Log Format entries
+test_files: []