plextail 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pat Allan
+
+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,44 @@
+# Plextail
+
+Plextail tails a group of files, and passes them through to Heroku's Logplex.
+
+## Installation
+
+It's a gem, so use it like you would any other gem - probably by putting it in your Gemfile:
+
+    gem 'plextail', '0.0.1'
+
+## Usage
+
+Track some log files, and make sure both the Logplex token and process id are set:
+
+    Plextail.track("path", "to", "*.log") do |line|
+      line.token      = '...'
+      line.process_id = 'daemon.1'
+    end
+
+The line will be sent through to Heroku using the provided details. If you want to change the server, use the LOGPLEX_URI environment variable – otherwise, the default is https://east.logplex.io.
+
+You can customise the following attributes on the yielded line object:
+
+* `token` – the logplex token,
+* `version` – the logplex version, which defaults to '<134>1',
+* `timestamp` – the timestamp for the line, which defaults to the current time, in the following format: '%Y-%m-%dT%H:%M:%S.ms+00:00',
+* `hostname` – host name of the log source (doesn't seem to impact Heroku's output),
+* `process_id` – the source of the log file (e.g. web.1)
+* `message_id` – defaults to '- -', and
+* `message` – the remainder/core of the log line, which defaults to the entire raw line from the file.
+
+The line also has two attributes available to help any custom logic you may involve in the processing: `file` (the file that has a new line appended) and `raw` (the raw line that has appeared in the file).
+
+## Contributing
+
+1. Fork it
+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
+
+## Credits
+
+Copyright (c) 2013, Plextail is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/plextail/line.rb

@@ -0,0 +1,52 @@
+class Plextail::Line
+  DEFAULTS = {
+    :version    => '<134>1',
+    :hostname   => `hostname`.strip,
+    :message_id => '- -'
+  }
+
+  attr_accessor :file, :raw, :token, :version, :timestamp, :hostname,
+    :process_id, :message_id, :message
+
+  def initialize(file, raw)
+    @file, @raw = file, raw
+    @version    = DEFAULTS[:version]
+    @timestamp  = current_timestamp
+    @hostname   = DEFAULTS[:hostname]
+    @message_id = DEFAULTS[:message_id]
+    @message    = raw.dup
+  end
+
+  def to_s
+    unless valid?
+      raise Plextail::InvalidLineError, "Missing #{missing_parts.join(', ')}"
+    end
+
+    string = parts.join(' ')
+
+    "#{string.bytes.to_a.length} #{string}"
+  end
+
+  def valid?
+    parts.all? { |part| part && part.length > 0 }
+  end
+
+  private
+
+  def current_timestamp
+    time     = Time.now
+    fraction = (".%06i" % time.usec)[0, 7]
+    "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}+00:00"
+  end
+
+  def missing_parts
+    [
+      :version, :timestamp, :hostname, :token, :process_id, :message_id,
+      :message
+    ].select { |part| send(part).nil? || send(part).length == 0 }
+  end
+
+  def parts
+    [version, timestamp, hostname, token, process_id, message_id, message]
+  end
+end

data/lib/plextail/tracker.rb

@@ -0,0 +1,46 @@
+require 'pty'
+require 'faraday'
+
+class Plextail::Tracker
+  URL = ENV['LOGPLEX_URI'] || 'https://east.logplex.io'
+
+  def initialize(*glob)
+    @glob = File.join *glob
+  end
+
+  def pipe(&block)
+    file = Dir[glob].first
+    PTY.spawn("tail -f #{glob}") do |stdin, stdout, pid|
+      stdin.each do |string|
+        string.strip!
+        if string[/^==> (.+) <==$/]
+          file = $1
+        elsif string.length > 0
+          line = Plextail::Line.new file, string
+          block.call line
+          to_plex line
+        end
+      end
+    end
+  rescue PTY::ChildExited
+    puts "The child process exited!"
+  end
+
+  private
+
+  attr_reader :glob
+
+  def connection
+    @connection ||= Faraday.new(:url => URL) do |connection|
+      connection.use Faraday::Adapter::NetHttp
+    end
+  end
+
+  def to_plex(line)
+    connection.basic_auth 'token', line.token
+    connection.post('/logs', line.to_s) do |request|
+      request.headers['Content-Type']   = 'application/logplex-1'
+      request.headers['Content-Length'] = line.to_s.bytes.to_a.length.to_s
+    end
+  end
+end

data/lib/plextail.rb

@@ -0,0 +1,11 @@
+module Plextail
+  class InvalidLineError < StandardError
+  end
+
+  def self.track(*glob, &block)
+    Plextail::Tracker.new(*glob).pipe(&block)
+  end
+end
+
+require 'plextail/line'
+require 'plextail/tracker'

data/plextail.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'plextail'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = 'Pipes tailed files to Heroku Logplex'
+  spec.description   = 'Takes tailed files in a single tail call and sends them through to Heroku Logplex with custom logplex tokens.'
+  spec.homepage      = 'https://github.com/flying-sphinx/plextail'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'faraday', '~> 0.8'
+
+  spec.add_development_dependency 'fakeweb',         '~> 1.3.0'
+  spec.add_development_dependency 'fakeweb-matcher', '~> 1.2.2'
+  spec.add_development_dependency 'rake',            '~> 10.0.4'
+  spec.add_development_dependency 'rspec',           '~> 2.13.0'
+end

data/spec/acceptance/plextail_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'fileutils'
+require 'tmpdir'
+require 'timeout'
+require 'fakeweb_matcher'
+
+describe 'Plextail' do
+  let(:directory) { Dir.mktmpdir }
+
+  before :each do
+    FakeWeb.allow_net_connect = false
+
+    FakeWeb.register_uri :post, %r{east\.logplex\.io/logs}, :body => 'OK'
+
+    File.open(File.join(directory, 'data.log'), 'w')  { |f| f.puts 'stuff' }
+    File.open(File.join(directory, 'error.log'), 'w') { |f| f.puts 'nonsense' }
+  end
+
+  after :each do
+    FileUtils.rm_rf directory
+  end
+
+  def track(&block)
+    begin
+      Timeout.timeout(0.1) do
+        Plextail.track(directory, "*.log", &block)
+      end
+    rescue Timeout::Error
+      #
+    end
+  end
+
+  it "passes each line through to Logplex" do
+    track do |line|
+      line.token      = 'token'
+      line.process_id = 'spec'
+    end
+
+    FakeWeb.should have_requested(:post, %r{east\.logplex\.io/logs})
+  end
+
+  it "prompts with the correct file and line details" do
+    yielded_file, yielded_line = nil, nil
+
+    track do |line|
+      yielded_file, yielded_line = line.file, line.raw
+
+      line.token      = 'token'
+      line.process_id = 'spec'
+    end
+
+    yielded_file.should == File.join(directory, 'error.log')
+    yielded_line.should == 'nonsense'
+  end
+
+  it "handles single files matching the glob" do
+    FileUtils.rm File.join(directory, 'error.log')
+    yielded_file, yielded_line = nil, nil
+
+    track do |line|
+      yielded_file, yielded_line = line.file, line.raw
+
+      line.token      = 'token'
+      line.process_id = 'spec'
+    end
+
+    yielded_file.should == File.join(directory, 'data.log')
+    yielded_line.should == 'stuff'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+
+Bundler.require :default, :development

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: plextail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb-matcher
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Takes tailed files in a single tail call and sends them through to Heroku
+  Logplex with custom logplex tokens.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/plextail.rb
+- lib/plextail/line.rb
+- lib/plextail/tracker.rb
+- plextail.gemspec
+- spec/acceptance/plextail_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flying-sphinx/plextail
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -273195946337692726
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -273195946337692726
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pipes tailed files to Heroku Logplex
+test_files:
+- spec/acceptance/plextail_spec.rb
+- spec/spec_helper.rb