RFC: Automatic logger module

balajiram has asked for the wisdom of the Perl Monks concerning the following question:

I have written a Perl module that redirects the the output of STDOUT and STDERR to a file very easily. For example:

use Auto::Log;

my $log = new Auto::Log, "some.log";
...Write some code here...
print "INFO: This gets printed to the log file"
$log->DESTROY;
[download]

One could also use the log file in tee mode using a simple option.

I wanted to hear from users as to how they feel about this. What do you think? Do you think you'd like to use such a Perl module?

The principal use of this module is that all that a user ever needs to do is to use the print, or warn statements. One doesn't have to open a new file using open() or anything. In my opinion this saves effort for a regular programmer who wants to get code written fast.

Let me know what you think though.

Also, please do give some suggestions for the module name. Do you like the name 'Auto::Log'?

Balaji

Comment on RFC: Automatic logger module Download Code

Replies are listed 'Best First'.
Re: RFC: Automatic logger module by Anonymous Monk on Mar 24, 2015 at 07:31 UTC
What do you think? I think its fantastic you want to share code ie contribute something :) Do you think you'd like to use such a Perl module? Nope, because it already exists :) ALMOST its called Capture::Tiny/IO::Capture::Stderr/IO::Capture::Stdout/Tie::STDERR/Tie::STDOUT almost exists but not exactly identical to your usage/api So is there room for your module on CPAN? yes there is room, CPAN not afraid of crowding :) Do you like the name 'Auto::Log'? No, it introduces a new namespace "Auto" and auto is a meaningless filler word, like "API" .. its a stopword ... yes, CPAN is full of APIs that do stuff automatically ... even log stuff "automatically" ... auto is one of http://pause.perl.org/pause/query?ACTION=pause_namingmodules#NAMES_TO_AVOID Also, your module is not really a "Logging" module, all it does is redirect STDOUT/STDERR while most "logging" module provide granularity/filtering/timestamps... You can learn lots about naming APIs by reading these nodes http://perldoc.perl.org/perlnewmod.html#What-should-I-make-into-a-module%3f Regrettable module names Naming of modules that are mean to be inherited only? Naming convention for variables, subroutines, modules, etc.. and variable declaration Advice please on variable naming style in modules Module naming problems, or time ill spent. Module naming issues Module Naming Conventions Perl Naming Conventions Module Naming Advice Naming a Mail Action Module CPAN Module Naming Suggestions. Module naming advice ?node_id=3989;HIT=name%20mod;re=N Module name suggestion RFC: Best name for this module? Namespace for local/internal modules? Should I register a namespace in PAUSE before every cpan module upload? Module's name and file's name Names and ideas for new CPAN modules Simplifying CPAN module namespace Top Level Module Namespace Table Hmmm, how should I name this new module/library ? What's the general rule for naming modules with that extra 'x' in the namespace? appropriate name/place for module which does JIT loading of modules Registering CPAN module namespace RFC: Name that Module module name: Algorithm::RectanglesContainingDot? RFC: Module namespace suggestion Help with module name Module Name Help! Correct namespace of module I wrote Namespaces and module suggestions again, OBDII CamelCase in module names What should I name my module? Funniest Module Name Changing a module's namespace on CPAN Suggestion for module namespace assignment What to name a module? Re^2: Naming a module that handles SIP2 (library protocol stopwords) Re: Submitting a module to cpan (Annovar::Wrapper Runner::Init ) Re: RFC: Name and/or API for module ("Type::FromData") ( infer sql best guess cast type match sqltranslator ) Re: Announcing Data::DynamicValidator Re: cpan test redux...better, but... still shouldn't be on CPAN	[reply]
Re: RFC: Automatic logger module by afoken (Chancellor) on Mar 24, 2015 at 07:12 UTC
I have written a Perl module that redirects the the output of STDOUT and STDERR to a file very easily In one word: Why? I don't understand why this should ever be useful. From a shell environment (i.e. during development), I/O redirection can be done at the shell level very easily. `perl myscript.pl < source.txt > output.txt 2> errors.txt` or perhaps `generator foo bar \| perl myscript.pl 2> errors.txt \| tee output.txt \| grep waddawadda \| sort`. Or very simple: `perl myscript.pl 2>&1 \| less` For "daemonized" environments, where a perl script runs "in background", the daemonizing environment handles I/O redirection and especially logging in any way you can think of, without changing a single bit of the source code. Syslog, simple logfile, rotated logfile, database, whatever. Started from inetd and tools like tcpserver, STDOUT is used to answer requests coming in via STDIN. Moving output from STDOUT to a logfile instantly makes the program useless. For use in interactive programs, redirecting both STDOUT and STDERR to a logfile is almost always wrong. STDOUT is for results, STDERR is for warnings and errors. When STDOUT is redirected to a logfile and mixed with warnings and errors, it is impossible to post-process the results. Things like `perl myscript.pl foo bar \| grep waddawadda \| sort` simply won't work any more. Also, please do give some suggestions for the module name. Do you like the name 'Auto::Log'? No, I don't like it. The primary purpose is logging, not "Auto". So I think the name should start with "Log". "Auto" does not describe at all what this module does. "CaptureAllOutput" does. So perhaps "Log::CaptureAllOutput"? Or "Log::I::don't::like::shell::redirections"? ;-) Alexander -- Today I will gladly share my knowledge and experience, for there are no sweeter words than "I told you so". ;-)	[reply] [d/l] [select]