apache_log_tail 0.0.1

data/lib/apache_log_tail.rb

@@ -0,0 +1,137 @@
+
+# Facilitates reading the most recent additions to a log file.
+#
+# Note that rotation of log files is *not* handled.
+#
+# Example:
+#   >> tail = LogTail.new "/var/log/apache2/access.log"
+#   >> tail.state_store.path_to_file = "/tmp/my-state.txt" # Optional: there is a default path
+#   >> tail.each_new_line {|line| puts line }
+#
+#
+class LogTail
+
+  def initialize path_to_file
+    @path_to_file = path_to_file
+  end
+
+
+  # Provides a StateStore object that provides persistent storage of a Hash.
+  #
+  def state_store
+    @state_store ||= FileStateStore.new
+  end
+
+  # Accepts a StateStore object that provides persistent storage of a Hash.
+  #
+  # Example:
+  #   >> tail.state_store = MyStateStore.new
+  #
+  # A StateStore object must provide these methods:
+  #
+  #  - remember( state:Hash)
+  #  - recall(): Hash
+  #
+  attr_writer :state_store
+
+
+  def each_new_line path_to_file = @path_to_file
+
+    # Recall the cursor ( the location in the log file where we left off
+    # reading last time)
+    state = state_store.recall
+    state[:cursor] ||= 0
+
+    File.open  path_to_file do |stream|
+      # Move the file reading "head" to the place where we left off reading
+      # last time
+      stream.seek  state[:cursor]
+
+      stream.each_line {|line| yield line }
+
+      # Remember where the log file reading cursor is for next time:
+      state[:cursor] = stream.tell
+      state_store.remember  state
+    end
+  end
+
+
+  # This is the default implementation of StateStore, which stores the state in
+  # a file ( by default in /tmp with a static name although this is
+  # configurable).
+  #
+  class FileStateStore
+
+    def path_to_file
+      @path_to_file ||= "/tmp/.apache_log_tail-state.yml"
+    end
+    attr_writer :path_to_file
+
+    require "yaml"
+
+    def recall
+      if not File.exists? path_to_file
+        {}
+      else
+        YAML.load File.read( path_to_file)
+      end
+    end
+
+    def remember state
+      File.open  path_to_file, "w" do |file|
+        file.write  state.to_yaml
+      end
+    end
+
+  end # of FileStateStore
+
+end
+
+
+# Note that this class does no parse Apache log entries, only knows how Apache
+# log files are rotated on Debian.  I have enjoyed using the apachelogregex gem
+# for parsing.
+#
+class ApacheLogTail < LogTail
+
+  # Note: This method must be invoked more frequently than the log file
+  # rotation period ( typically 1 week) otherwise an entire file will be
+  # missed.
+  #
+  def each_new_line
+    state = state_store.recall
+    first_line_now = first_line_of @path_to_file
+    # If the Apache log file has been rotated..
+    # The file has been rotated if it has been read ( cursor is remembered) but
+    # the first line is not as remembered
+    file_has_been_rotated = lambda { state[:cursor] and first_line_now != state[:first_line] }
+    if file_has_been_rotated[]
+      # Check that the renamed file is as we expect before reading the rest of it:
+      renamed_file = @path_to_file + ".1"
+      if first_line_of( renamed_file) != state[:first_line]
+        raise StandardError.new "Rotated file could not be found"
+      end
+      # Process the last lines of the rotated file:
+      super renamed_file
+      # Reset the cursor ready for the new file:
+      state[:cursor] = 0
+    end
+    if first_line_now != state[:first_line]
+      state[:first_line] = first_line_now
+      state_store.remember state
+    end
+    # Process the lines that have since been added to the new file:
+    super
+  end
+
+
+ private
+
+  def first_line_of file
+    File.open  file do |f|
+      f.gets
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: apache_log_tail
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Neil Stockbridge
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-30 00:00:00 Z
+dependencies: []
+
+description: Presents lines from an Apache log file that were written since the previous invocation.  Supports log file rotation.
+email: neil@dist.ro
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/apache_log_tail.rb
+homepage: http://rubygems.org/gems/apache_log_tail
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Process only the new lines from an Apache log file
+test_files: []
+