https://github.com/bgreenlee/pygtail

Pygtail reads log file lines that have not been read. It will even handle log files that have been rotated. Based on logcheck's logtail2 (http://logcheck.org)
https://github.com/bgreenlee/pygtail

Last synced: 15 days ago
JSON representation

Pygtail reads log file lines that have not been read. It will even handle log files that have been rotated. Based on logcheck's logtail2 (http://logcheck.org)

• Host: GitHub
• URL: https://github.com/bgreenlee/pygtail
• Owner: bgreenlee
• License: gpl-2.0
• Created: 2011-06-30T05:32:08.000Z (over 13 years ago)
• Default Branch: main
• Last Pushed: 2024-07-28T15:00:48.000Z (4 months ago)
• Last Synced: 2024-08-31T15:52:36.852Z (2 months ago)
• Language: Python
• Homepage:
• Size: 114 KB
• Stars: 248
• Watchers: 16
• Forks: 79
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
pygtail

=======

A python "port" of [logcheck's logtail2](http://logcheck.org).

Pygtail reads log file lines that have not been read. It will even handle log

files that have been rotated.

Usage

-----

From the command line:

    Usage: pygtail.py [options] logfile

    Print log file lines that have not been read.

    Options:

      -h, --help            show this help message and exit

      -o OFFSET_FILE, --offset-file=OFFSET_FILE

                            File to which offset data is written (default:

                            .offset).

      -p, --paranoid        Update the offset file every time we read a line

                            (as opposed to only when we reach the end of the

                            file).

      -n N, --every-n=N     Update the offset file every N'th time we read a

                            line (as opposed to only when we reach the end of

                            the file).

      --no-copytruncate     Don't support copytruncate-style log rotation.

                            Instead, if the log file shrinks, print a warning.

      --read-from-end       Read log file from the end if offset file is

                            missing. Useful for large files.

      --log-pattern         Custom log rotation glob pattern. Use %s to

                            represent the original filename. You may use this

                            multiple times to provide multiple patterns.

      --full_lines          Only log when line ends in a newline `\n`

                            (default: False)

      --encoding ENCODING   Encoding to use for reading files (default: system

                            encoding)

      --version             Print version and exit.

In your code:

```python

from pygtail import Pygtail

for line in Pygtail("some.log"):

    sys.stdout.write(line)

```

An example showing iterating over lines with offsets and manual control over offset updates:

```python

import pygtail

tail = pygtail.Pygtail(logfile, save_on_end=False, copytruncate=False)

for line, offset in tail.with_offsets():

    # Do someting

 # figure out right offset to save

 tail.write_offset_to_file(right_offset)

```

Contributing

------------

Pull requests are very much welcome, but I will not merge your changes if you don't include a test. Run tests with `python setup.py test`.

Build status

------------

[![Build Status](https://secure.travis-ci.org/bgreenlee/pygtail.png)](http://travis-ci.org/bgreenlee/pygtail)