Skip to content

Commit

Permalink
Updated the DESCRIPTION section of the POD.
Browse files Browse the repository at this point in the history
  • Loading branch information
kablamo committed Apr 15, 2012
1 parent 74d6f51 commit af9c63c
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions lib/Log/JSON.pm
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -24,17 +24,18 @@ use Path::Class::File;
This module logs a hash to a file as JSON. The keys are printed in sorted order. This module logs a hash to a file as JSON. The keys are printed in sorted order.
Using JSON in your log file means each piece of information is labeled and the Log files often end up with lots of raw numbers and strings whose meaning was
file is more human readable. Sometimes log files end up with lots of lots of obvious when the code was written but forgotten later on. And the more columns
raw numbers and strings which were obvious when the code was written but there are in a row, the more of a problem this becomes. Using JSON in your log
forgotten later on. And the more columns there are in a row, the more file provides a label for each piece of information which may make it more
difficult it is. human readable.
Having a log file with JSON formatted text also means its easy to parse and use A log file with JSON formatted text is also convenient to parse and it becomes
the data structure in the log file -- similar to using L<Storable>. In fact easy to revive the data structures. Using Log::JSON this way makes it similar
Storable is a good alternative for creating log files. The advantage of this to L<Storable>. In fact, Storable is a good alternative for creating log
module is that Storable adds some version numbers and other data which make it files. Probably the only advantage this module has over Storable is that
less friendly to humans reading the raw file. Storable adds version numbers and other data to the serialized string which
make it less friendly to humans reading the raw file.
=head1 METHODS =head1 METHODS
Expand Down

0 comments on commit af9c63c

Please sign in to comment.