Module: File::Tail

Included in:
Logfile
Defined in:
lib/file/tail.rb,
lib/file/tail/group.rb,
lib/file/tail/tailer.rb,
lib/file/tail/logfile.rb,
lib/file/tail/version.rb,
lib/file/tail/line_extension.rb

Overview

This module can be included in your own File subclasses or used to extend files you want to tail.

Defined Under Namespace

Modules: LineExtension Classes: BreakException, DeletedException, Group, Logfile, ReopenException, ReturnException, TailException, Tailer

Constant Summary collapse

VERSION =

File::Tail version

'1.1.1'
VERSION_ARRAY =

:nodoc:

VERSION.split('.').map(&:to_i)
VERSION_MAJOR =

:nodoc:

VERSION_ARRAY[0]
VERSION_MINOR =

:nodoc:

VERSION_ARRAY[1]
VERSION_BUILD =

:nodoc:

VERSION_ARRAY[2]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#break_if_eof ⇒ Object

If this attribute is set to a true value, File::Fail’s tail method raises a BreakException if the end of the file is reached.



86
87
88
 
# File 'lib/file/tail.rb', line 86

def break_if_eof
  @break_if_eof
end

#default_bufsize ⇒ Object

Default buffer size, that is used while going backward from a file’s end. This defaults to nil, which means that File::Tail attempts to derive this value from the filesystem block size.



95
96
97
 
# File 'lib/file/tail.rb', line 95

def default_bufsize
  @default_bufsize
end

#interval ⇒ Object

The start value of the sleep interval. This value goes against max_interval if the tailed file is silent for a sufficient time.



54
55
56
 
# File 'lib/file/tail.rb', line 54

def interval
  @interval
end

#max_interval ⇒ Object

The maximum interval File::Tail sleeps, before it tries to take some action like reading the next few lines or reopening the file.



49
50
51
 
# File 'lib/file/tail.rb', line 49

def max_interval
  @max_interval
end

#reopen_deleted ⇒ Object

If this attribute is set to a true value, File::Tail persists on reopening a deleted file waiting max_interval seconds between the attempts. This is useful if logfiles are moved away while rotation occurs but are recreated at the same place after a while. It defaults to true.



61
62
63
 
# File 'lib/file/tail.rb', line 61

def reopen_deleted
  @reopen_deleted
end

#reopen_suspicious ⇒ Object

If this attribute is set to a true value, File::Tail attempts to reopen it’s tailed file after suspicious_interval seconds of silence.



66
67
68
 
# File 'lib/file/tail.rb', line 66

def reopen_suspicious
  @reopen_suspicious
end

#return_if_eof ⇒ Object

If this attribute is set to a true value, File::Fail’s tail method just returns if the end of the file is reached.



90
91
92
 
# File 'lib/file/tail.rb', line 90

def return_if_eof
  @return_if_eof
end

#suspicious_interval ⇒ Object

This attribute is the invterval in seconds before File::Tail gets suspicious that something has happend to it’s tailed file and an attempt to reopen it is made.

If the attribute reopen_suspicious is set to a non true value, suspicious_interval is meaningless. It defaults to 60 seconds.



82
83
84
 
# File 'lib/file/tail.rb', line 82

def suspicious_interval
  @suspicious_interval
end

Instance Method Details

#after_reopen(&block) ⇒ Object

The callback is called with self as an argument after a reopen has occured. This allows a tailing script to find out, if a logfile has been rotated.



71
72
73
 
# File 'lib/file/tail.rb', line 71

def after_reopen(&block)
  @after_reopen = block
end

#backward(n = 0, bufsize = nil) ⇒ Object

Rewind the last n lines of this file, starting from the end. The default is to start tailing directly from the end of the file.

The additional argument bufsize is used to determine the buffer size that is used to step through the file backwards. It defaults to the block size of the filesystem this file belongs to or 8192 bytes if this cannot be determined.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/file/tail.rb', line 117

def backward(n = 0, bufsize = nil)
  if n <= 0
    seek(0, File::SEEK_END)
    return self
  end
  bufsize ||= default_bufsize || stat.blksize || 8192
  size = stat.size
  begin
    if bufsize < size
      seek(0, File::SEEK_END)
      while n > 0 and tell > 0 do
        seek(-bufsize, File::SEEK_CUR)
        buffer = read(bufsize)
        n -= buffer.count("\n")
        seek(-bufsize, File::SEEK_CUR)
      end
    else
      rewind
      buffer = read(size)
      n -= buffer.count("\n")
      rewind
    end
  rescue Errno::EINVAL
    size = tell
    retry
  end
  pos = -1
  while n < 0  # forward if we are too far back
    pos = buffer.index("\n", pos + 1)
    n += 1
  end
  seek(pos + 1, File::SEEK_CUR)
  self
end

#forward(n = 0) ⇒ Object

Skip the first n lines of this file. The default is to don’t skip any lines at all and start at the beginning of this file.



99
100
101
102
103
104
105
106
 
# File 'lib/file/tail.rb', line 99

def forward(n = 0)
  rewind
  while n > 0 and not eof?
    readline
    n -= 1
  end
  self
end

#tail(n = nil, &block) ⇒ Object

This method tails this file and yields to the given block for every new line that is read. If no block is given an array of those lines is returned instead. (In this case it’s better to use a reasonable value for n or set the return_if_eof or break_if_eof attribute to a true value to stop the method call from blocking.)

If the argument n is given, only the next n lines are read and the method call returns. Otherwise this method call doesn’t return, but yields to block for every new line read from this file for ever.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/file/tail.rb', line 164

def tail(n = nil, &block) # :yields: line
  @n = n
  result = []
  array_result = false
  unless block
    block = lambda { |line| result << line }
    array_result = true
  end
  preset_attributes unless defined? @lines
  loop do
    begin
      restat
      read_line(&block)
      redo
    rescue ReopenException => e
      until eof? || @n == 0
        block.call readline
        @n -= 1 if @n
      end
      reopen_file(e.mode)
      @after_reopen.call self if defined? @after_reopen
    rescue ReturnException
      return array_result ? result : nil
    end
  end
end