fourtrack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a33b2a5e13cf6c134db5b352a27e3c096b4893f
+  data.tar.gz: 710204e5a058e83d29b47d41224393fc8363a1c3
+SHA512:
+  metadata.gz: 3ef58accda8208ff7b24efff6201675235a456a8b90e48ed5d24ba93b3ff15ada3a08eb26dfe99785846d508228c9373ad01406020d5f18061d23d102d476897
+  data.tar.gz: a0205fbaab1f55f2a882bbc9d5685406e1aec00fbbac9597589cc9946b9f824de1bc08760b323835af4454cbfb8fadbaae63aec87960bcedf2b880e75590531a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 WeTransfer
+
+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,54 @@
+# Fourtrack
+
+A gem for massive, parallel recording of streaming event logs for later replay. You know when you need one.
+
+## Usage
+
+To record **all of your SQL:**
+
+```ruby
+recorder = Fourtrack::Recorder.new(output_path: Rails.root.join('log/sql.jsonlines.gz'), flush_after: 1024)
+ActiveSupport::Notifications.subscribe('sql.active_record') do |_, started, finished, id, payload|
+  recorder << JSON.dump(payload)
+end
+```
+
+and to replay later:
+
+```ruby
+File.open(Rails.root.join('log/sql.jsonlines.gz')) do |f|
+  player = Fourtrac::Player.new(f)
+  player.each_line do |line|
+    puts JSON.load(line)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fourtrack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fourtrack
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WeTransfer/fourtrack.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/fourtrack.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fourtrack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fourtrack"
+  spec.version       = Fourtrack::VERSION
+  spec.authors       = ["Julik Tarkhanov"]
+  spec.email         = ["me@julik.nl"]
+
+  spec.summary       = %q{Store massive ordered log records into a single .gz file.}
+  spec.description   = %q{and replay them one by one}
+  spec.homepage      = "https://github.com/WeTransfer/fourtrack"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fourtrack.rb

@@ -0,0 +1,6 @@
+require "fourtrack/version"
+module Fourtrack
+  require 'zlib'
+  require_relative 'fourtrack/recorder'
+  require_relative 'fourtrack/player'
+end

data/lib/fourtrack/player.rb

@@ -0,0 +1,26 @@
+class Fourtrack::Player
+  def initialize(io)
+    @io = io
+  end
+
+  def readlines
+    [].tap {|o|  each_line{|line| o << line }}
+  end
+
+  def each_line(&blk)
+    # https://github.com/exAspArk/multiple_files_gzip_reader
+    # https://bugs.ruby-lang.org/issues/9790
+    loop do
+      break if @io.eof?
+      zr = Zlib::GzipReader.new(@io)
+      zr.each_line(&blk)
+      unused_bytestr = zr.unused
+      zr.finish
+      if unused_bytestr && unused_bytestr.bytesize.nonzero?
+        @io.pos -= unused_bytestr.bytesize
+      else
+        break
+      end
+    end
+  end
+end

data/lib/fourtrack/recorder.rb

@@ -0,0 +1,80 @@
+# A class used as a destination for periodically writing out batch-written
+# JSON formattable payloads. Can be used for stats logs, SQL replay logs and the like.
+# Is thread safe and uses gzip compression. Writes are performed using a binary UNIX
+# append, which with a small-ish record size should guarantee atomic append.
+class Fourtrack::Recorder
+  require 'logger'
+  NULL_LOGGER = Logger.new(nil)
+  def initialize(output_path:, flush_after_n:, logger: NULL_LOGGER)
+    @output_path = File.expand_path(output_path)
+    @pid_at_create = Process.pid
+    @logger = logger
+    @buf = []
+    @mux = Mutex.new
+    @flush_every = flush_after_n
+    # Attempt to open the file for writing,
+    # which will raise an exception outright if we do not have access
+    File.open(@output_path, 'a') {}
+    # and once we know we were able to open it, install an at_exit block for ourselves
+    install_at_exit_hook!
+  end
+  
+  def pending?
+    len = @mux.synchronize { @buf.length }
+    len.nonzero?
+  end
+  
+  def <<(payload)
+    # Get the current PID.
+    mypid = Process.pid
+    len_so_far  = @mux.synchronize {
+      # If the current PID doesn't match the one
+      # that was set at instantiation, it means the process was
+      # forked and we now possible also hold records for the parent
+      # process, which we have to discard (it is the responsibility
+      # of the parent to flush it's records, not ours!).
+      if mypid != @pid_at_create
+        @pid_at_create = mypid
+        @buf.clear
+      end
+      @buf << payload
+      @buf.length
+    }
+    flush! if len_so_far > @flush_every
+    self
+  end
+  
+  def flush!
+    # Refuse to flush and empty the buffer if flush! is called
+    # within a child and the object still has records pending
+    mypid = Process.pid
+    if mypid != @pid_at_create
+      @logger.debug { "%s: Flush requested child PID %d, will inhibit flush and empty the record log first" % mypid }
+      # Do not flush since we are in the child now
+      @mux.synchronize { @buf.clear }
+      return
+    end
+
+    io_buf = StringIO.new
+
+    @mux.synchronize do
+      @logger.debug { "%s: Compressing %d records from PID %d" % [self, @buf.length, Process.pid] }
+      z = Zlib::GzipWriter.new(io_buf)
+      @buf.each {|record| z.puts(JSON.dump(record) + "\n") }
+      z.finish
+      @buf.clear
+    end
+
+    @logger.debug { "%s: Flushing to %s, size before flush %d" % [self, @output_path, File.size(@output_path)] }
+    File.open(@output_path, 'ab') { |f| f << io_buf.string }
+    @logger.debug { "%s: After flush to %s size %d" % [self, @output_path, File.size(@output_path)] }
+
+    io_buf.truncate(0)
+  end
+
+  private
+
+  def install_at_exit_hook!
+    at_exit { flush! if pending? }
+  end
+end

data/lib/fourtrack/version.rb

@@ -0,0 +1,3 @@
+module Fourtrack
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: fourtrack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: and replay them one by one
+email:
+- me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fourtrack.gemspec
+- lib/fourtrack.rb
+- lib/fourtrack/player.rb
+- lib/fourtrack/recorder.rb
+- lib/fourtrack/version.rb
+homepage: https://github.com/WeTransfer/fourtrack
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Store massive ordered log records into a single .gz file.
+test_files: []