fluent-tail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13b33dca730d228105b39647de7cf4810d485faa
+  data.tar.gz: 8fcbe2060535a0d84a0efe6fce02b17c3c38d12f
+SHA512:
+  metadata.gz: 87cbc96521d825e47a4a4d16d6c9e6a8fb6dca34f07b79f9caee632cff6d2d565e82e6af13eca52e100e72cb5d699dd82913ddf6733b5188f3f83995e3fc22b9
+  data.tar.gz: 6fbfd0a972be084ee6ff4c0409ad6cedd6d0aa2b7e3690cd8607ef923ebc4190d1283fdf255faaa3e14629abd80c832c7907187d68f1a1600ddeca2a90a305f9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,3 @@
+Copyright (c) 2014 OKUNO Akihiro
+
+Apache License, Version 2.0

data/README.md

@@ -0,0 +1,71 @@
+# Fluent::Tail
+
+Using fluent-tail, you can tail [fluentd](http://fluentd.org/) event stream without any configuration changes.
+
+## Caution
+
+Because tool modify the running fluentd process using `drb` and `instance_eval', there is a potential risk that the process could be broken unexpectedly.
+
+In addition, this tool might degrade the perfermance of the fluentd process.
+
+*Use this tool at your own risk.*
+
+## Installation
+
+```
+$ fluent-gem install fluent-tail
+```
+
+## Prerequisite
+
+`in_debug_agent` plugin is required to be enabled.
+
+```
+<source>
+  type debug_agent
+</source>
+```
+
+## Usage
+
+```
+$ fluent-tail <tag_pattern>
+```
+
+You can specify a pattern of tag with the same format as fluentd match tag.
+
+e.g.
+
+
+```
+$ fluent-tail foo.**
+```
+
+then events with tag, such as "foo" , "foo.bar" and "foo.bar.foo" etc., will be shown in your console.
+
+```
+2014-03-06 14:22:21 +0900 foo: {"hoge":"fuga"}
+2014-03-06 14:22:23 +0900 foo.bar: {"hoge":"fuga"}
+2014-03-06 14:22:27 +0900 foo.bar.foo: {"hoge":"fuga"}
+```
+
+## Option
+
+|parameter|description|default|
+|---|---|---|
+|-h, --host HOST|fluent host|127.0.0.1|
+|-p, --port PORT|debug_agent|24230|
+|-u, --unix PATH|use unix socket instead of tcp||
+|-t, --output-type TYPE|output format of record. available types are 'json' or 'hash'.|json|
+
+## Copyright
+
+See LICENSE.txt
+
+## Contributing
+
+1. Fork it ( http://github.com/choplin/fluent-tail/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/fluent-tail

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless defined?(gem)
+here = File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path(File.join(here, '..', 'lib'))
+require 'fluent/tail'

data/fluent-tail.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluent/tail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-tail"
+  spec.version       = Fluent::Tail::VERSION
+  spec.authors       = ["OKUNO Akihiro"]
+  spec.email         = ["okuno.akihiro@gmail.com"]
+  spec.summary       = %q{Tools for tailing fluentd stream events}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/choplin/fluent-tail"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fluent/tail/version.rb

@@ -0,0 +1,5 @@
+module Fluent
+  module Tail
+    VERSION = "0.0.1"
+  end
+end

data/lib/fluent/tail.rb

@@ -0,0 +1,131 @@
+require 'optparse'
+require 'drb/drb'
+require 'fluent/load'
+
+def parse_options
+  op = OptionParser.new
+  op.banner += ' <pattern>'
+
+  (class<<self;self;end).module_eval do
+    define_method(:usage) do |msg|
+      puts op.to_s
+      puts "error: #{msg}" if msg
+      exit 1
+    end
+  end
+
+  opts = {
+    host: '127.0.0.1',
+    port: 24230,
+    unix: nil,
+    pattern: nil,
+    output_type: :json,
+  }
+
+  op.on('-h', '--host HOST', "fluent host (default: #{opts[:host]})") {|v|
+    opts[:host] = v
+  }
+
+  op.on('-p', '--port PORT', "debug_agent tcp port (default: #{opts[:host]})", Integer) {|v|
+    opts[:port] = v
+  }
+
+  op.on('-u', '--unix PATH', "use unix socket instead of tcp") {|v|
+    opts[:unix] = b
+  }
+
+  op.on('-t', '--output-type TYPE', "output format of record. available types are 'json' or 'hash'. (default: #{opts[:output_type]})") {|v|
+    case v.downcase
+    when 'json'
+      opts[:output_type] = :json
+    when 'hash'
+      opts[:output_type] = :hash
+    else
+      raise ConfigError, "output_type must be 'json' or 'hash'"
+    end
+  }
+
+  begin
+    op.parse!(ARGV)
+    opts[:pattern] = ARGV.shift
+
+    if opts[:pattern].nil?
+      usage "a pattern must be specified"
+    end
+  rescue
+    usage $!.to_s
+  end
+
+  opts
+end
+
+def format(tag, time, record)
+  "#{Time.at(time).localtime} #{tag}: #{@output_proc.call(record)}"
+end
+
+def main
+  opts = parse_options
+
+  @output_proc = case opts[:output_type]
+                 when :json then Proc.new {|record| Yajl.dump(record) }
+                 when :hash then Proc.new {|record| record.to_s }
+                 end
+
+  unless opts[:unix].nil?
+    uri = "drbunix:#{opts[:unix]}"
+  else
+    uri = "druby://#{opts[:host]}:#{opts[:port]}"
+  end
+
+  $remote_engine = DRb::DRbObject.new_with_uri(uri)
+
+  remote_code = <<-CODE
+    alias :original_emit_staream :emit_stream
+    @fluent_tail_queue = Queue.new
+    @fluent_tail_match_pattern = Fluent::MatchPattern.create("#{opts[:pattern]}")
+    @fluent_tail_match_cache = {}
+
+    def emit_stream(tag, es)
+      matched = @fluent_tail_match_cache[tag]
+
+      if matched.nil?
+        matched = @fluent_tail_match_pattern.match(tag)
+        @fluent_tail_match_cache[tag] = matched
+      end
+
+      @fluent_tail_queue.push([tag, es.dup]) if matched
+
+      original_emit_staream(tag, es)
+    end
+
+    def pop
+      @fluent_tail_queue.pop
+    end
+  CODE
+
+  if $remote_engine.respond_to?(:original_emit_staream)
+    abort 'another client has already connected to the server. abort.'
+  end
+
+  begin
+    $remote_engine.method_missing(:instance_eval, remote_code)
+
+    while e = $remote_engine.pop
+      tag, es = e
+      es.each do |time,record|
+        STDOUT.puts format(tag, time, record)
+      end
+    end
+  ensure
+    if not $remote_engine.nil? and $remote_engine.respond_to?(:original_emit_staream)
+      remote_code = <<-CODE
+        @fluent_tail_queue = nil
+        alias :emit_stream :original_emit_staream
+        undef :original_emit_staream
+      CODE
+      $remote_engine.method_missing(:instance_eval, remote_code)
+    end
+  end
+end
+
+main

data/spec/fluent_tail/fluent.conf

@@ -0,0 +1,11 @@
+<source>
+  type debug_agent
+</source>
+
+<source>
+  type forward
+</source>
+
+<match **>
+  type stdout
+</match>

data/spec/fluent_tail/tail_spec.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'spec_helper'
+require 'fluent/tail/version'
+
+describe Fluent::Tail do
+  TAG_PATTER = 'foo.**'
+  CONFIG_PATH = File.join(File.dirname(__FILE__), 'fluent.conf')
+  BIN_DIR = File.join(ROOT, 'bin')
+
+  LOG = File.join(File.dirname(__FILE__), 'test.log')
+
+  before :all do
+    @fluentd_pid = spawn('fluentd', '-c', CONFIG_PATH, out: '/dev/null')
+    sleep 2
+
+    @r,w = IO.pipe
+    @fluent_tail_pid = spawn("#{File.join(BIN_DIR, 'fluent-tail')} #{TAG_PATTER}", out: w)
+    sleep 1
+  end
+
+  after :all do
+    Process.kill(:TERM, @fluent_tail_pid)
+    sleep 1
+    Process.kill(:TERM, @fluentd_pid)
+    Process.waitall
+  end
+
+  it 'have a version number' do
+    expect(Fluent::Tail::VERSION).not_to be_nil
+  end
+
+  it 'show matched events' do
+    tag = 'foo.bar'
+    time = Time.now
+    event = {'foo' => 'bar'}
+
+    client = FluentdClient.connect
+    client.write(tag, time.to_i, event)
+
+    line = @r.gets
+    expect(line).to eq("#{time.localtime} #{tag}: #{event.to_json}\n")
+  end
+
+  it 'does not show matched events' do
+    tag = 'hoge'
+    time = Time.now
+    event = {'foo' => 'bar'}
+
+    client = FluentdClient.connect
+    client.write(tag, time.to_i, event)
+
+    expect {@r.read_nonblock(10)}.to raise_error(Errno::EAGAIN)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+ROOT = File.expand_path('../../', __FILE__)
+$LOAD_PATH.unshift File.join(ROOT, 'lib')
+
+require 'socket'
+
+
+class FluentdClient
+  def self.connect
+    conn = TCPSocket.open('127.0.0.1', 24224)
+    self.new(conn)
+  end
+
+  def write(tag, time, event)
+    @conn.write [tag, time, event].to_json
+  end
+
+  private
+
+  def initialize(conn)
+    @conn = conn
+  end
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fluent-tail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- OKUNO Akihiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Tools for tailing fluentd stream events
+email:
+- okuno.akihiro@gmail.com
+executables:
+- fluent-tail
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fluent-tail
+- fluent-tail.gemspec
+- lib/fluent/tail.rb
+- lib/fluent/tail/version.rb
+- spec/fluent_tail/fluent.conf
+- spec/fluent_tail/tail_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/choplin/fluent-tail
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Tools for tailing fluentd stream events
+test_files:
+- spec/fluent_tail/fluent.conf
+- spec/fluent_tail/tail_spec.rb
+- spec/spec_helper.rb