mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
9cea1d3b27
* origin/topic/seth/reporter-to-stderr: A couple of tests for printing reporter messages to STDERR. Small improvements for printing reporter messages to STDERR. Reporter warnings and error now print to stderr by default. Closes #836.
90 lines
3 KiB
Text
90 lines
3 KiB
Text
##! This framework is intended to create an output and filtering path for
|
|
##! internal messages/warnings/errors. It should typically be loaded to
|
|
##! avoid Bro spewing internal messages to standard error and instead log
|
|
##! them to a file in a standard way. Note that this framework deals with
|
|
##! the handling of internally-generated reporter messages, for the
|
|
##! interface into actually creating reporter messages from the scripting
|
|
##! layer, use the built-in functions in :doc:`/scripts/base/reporter.bif`.
|
|
|
|
module Reporter;
|
|
|
|
export {
|
|
## The reporter logging stream identifier.
|
|
redef enum Log::ID += { LOG };
|
|
|
|
## An indicator of reporter message severity.
|
|
type Level: enum {
|
|
## Informational, not needing specific attention.
|
|
INFO,
|
|
## Warning of a potential problem.
|
|
WARNING,
|
|
## A non-fatal error that should be addressed, but doesn't
|
|
## terminate program execution.
|
|
ERROR
|
|
};
|
|
|
|
## The record type which contains the column fields of the reporter log.
|
|
type Info: record {
|
|
## The network time at which the reporter event was generated.
|
|
ts: time &log;
|
|
## The severity of the reporter message.
|
|
level: Level &log;
|
|
## An info/warning/error message that could have either been
|
|
## generated from the internal Bro core or at the scripting-layer.
|
|
message: string &log;
|
|
## This is the location in a Bro script where the message originated.
|
|
## Not all reporter messages will have locations in them though.
|
|
location: string &log &optional;
|
|
};
|
|
|
|
## Tunable for sending reporter warning messages to STDERR. The option to
|
|
## turn it off is presented here in case Bro is being run by some
|
|
## external harness and shouldn't output anything to the console.
|
|
const warnings_to_stderr = T &redef;
|
|
|
|
## Tunable for sending reporter error messages to STDERR. The option to
|
|
## turn it off is presented here in case Bro is being run by some
|
|
## external harness and shouldn't output anything to the console.
|
|
const errors_to_stderr = T &redef;
|
|
}
|
|
|
|
global stderr: file;
|
|
|
|
event bro_init() &priority=5
|
|
{
|
|
Log::create_stream(Reporter::LOG, [$columns=Info]);
|
|
|
|
if ( errors_to_stderr || warnings_to_stderr )
|
|
stderr = open("/dev/stderr");
|
|
}
|
|
|
|
event reporter_info(t: time, msg: string, location: string) &priority=-5
|
|
{
|
|
Log::write(Reporter::LOG, [$ts=t, $level=INFO, $message=msg, $location=location]);
|
|
}
|
|
|
|
event reporter_warning(t: time, msg: string, location: string) &priority=-5
|
|
{
|
|
if ( warnings_to_stderr )
|
|
{
|
|
if ( t > double_to_time(0.0) )
|
|
print stderr, fmt("WARNING: %.6f %s (%s)", t, msg, location);
|
|
else
|
|
print stderr, fmt("WARNING: %s (%s)", msg, location);
|
|
}
|
|
|
|
Log::write(Reporter::LOG, [$ts=t, $level=WARNING, $message=msg, $location=location]);
|
|
}
|
|
|
|
event reporter_error(t: time, msg: string, location: string) &priority=-5
|
|
{
|
|
if ( errors_to_stderr )
|
|
{
|
|
if ( t > double_to_time(0.0) )
|
|
print stderr, fmt("ERROR: %.6f %s (%s)", t, msg, location);
|
|
else
|
|
print stderr, fmt("ERROR: %s (%s)", msg, location);
|
|
}
|
|
|
|
Log::write(Reporter::LOG, [$ts=t, $level=ERROR, $message=msg, $location=location]);
|
|
}
|