<commit_before>
What is it?
===========

A simple log prettifier extensible with syntax parsers for various log formats.

Components are log entries are colored for easy skimming, and data parts are printed as pretty JSON.


Usage
-----

	tail -f /var/log/php5-fpm.log | prettylog

Arguments
---------

To print only messages matching or above the specified [monolog](https://github.com/Seldaek/monolog)
level (see [RFC5424](http://tools.ietf.org/html/rfc5424)):

	--min-level="debug|info|notice|warning|error|critical|alert|emergency"

Alternative short syntax:

	-l debug|info|notice|warning|error|critical|alert|emergency

When filtered for log level, prettylog will print a dot for each omitted log message. Disable this by:

	--no-dots

Prettylog will also add a yellow "time gap" line between log entries that are more than 30 seconds apart. Disable this by:

	--no-gaps

To print the usage and options:

	--help


Version 0.1-dev
===============

This is a very early release. Use at your own risk. Comments and suggestions are welcome.

Building
========

Install [composer](https://getcomposer.org/): 

	curl -sS https://getcomposer.org/installer | php

Install [box](http://box-project.org/): 

	curl -LSs https://box-project.github.io/box2/installer.php | php
	sudo mv box.phar /usr/local/bin/box<commit_msg>add brief documentation for existing/planned parsers<commit_after>
What is it?
===========

A simple log prettifier extensible with syntax parsers for various log formats.

Components are log entries are colored for easy skimming, and data parts are printed as pretty JSON.


Usage
-----

	tail -f /var/log/php5-fpm.log | prettylog

Arguments
---------

To print only messages matching or above the specified [monolog](https://github.com/Seldaek/monolog)
level (see [RFC5424](http://tools.ietf.org/html/rfc5424)):

	--min-level="debug|info|notice|warning|error|critical|alert|emergency"

Alternative short syntax:

	-l debug|info|notice|warning|error|critical|alert|emergency

When filtered for log level, prettylog will print a dot for each omitted log message. Disable this by:

	--no-dots

Prettylog will also add a yellow "time gap" line between log entries that are more than 30 seconds apart. Disable this by:

	--no-gaps

To print the usage and options:

	--help

Supported formats
-----------------

Currently there are parsers for:

- [monolog](https://github.com/Seldaek/monolog) `LineFormatter` syntax (such as [Symfony](http://symfony.com/) application logs)
- [php-fpm](http://php-fpm.org/) logs
- [syslog](http://en.wikipedia.org/wiki/Syslog) files

As part of my daily routine I tend to deal with the following log formats too, so I will probably add parsers for:

- [nginx](http://nginx.org/) access and error logs (need to add support for multi-line log entries)
- [supervisor](http://supervisord.org/) logs


Version 0.1-dev
===============

This is a very early release. Use at your own risk. Comments and suggestions are welcome.

Building
========

Install [composer](https://getcomposer.org/): 

	curl -sS https://getcomposer.org/installer | php

Install [box](http://box-project.org/): 

	curl -LSs https://box-project.github.io/box2/installer.php | php
	sudo mv box.phar /usr/local/bin/box
{'fraction_non_alphanumeric': 0.13551980198019803, 'fraction_numerical': 0.008663366336633664, 'mean_word_length': 3.93587786259542, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3883810', 'n_tokens_mistral': 1055, 'n_tokens_neox': 974, 'n_words': 345}