Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-05 08:08:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Overhauling the internal reporting of messages to the user.

Browse source 
The Logger class is now in charge of reporting all errors, warnings,
informational messages, weirds, and syslogs. All other components
route their messages through the global bro_logger singleton.

The Logger class comes with these reporting methods:

    void Message(const char* fmt, ...);
    void Warning(const char* fmt, ...);
    void Error(const char* fmt, ...);
    void FatalError(const char* fmt, ...); // Terminate Bro.
    void Weird(const char* name);
    [ .. some more Weird() variants ... ]
    void Syslog(const char* fmt, ...);
    void InternalWarning(const char* fmt, ...);
    void InternalError(const char* fmt, ...); // Terminates Bro.

See Logger.h for more information on these.

Generally, the reporting now works as follows:

    - All non-fatal message are reported in one of two ways:

        (1) At startup (i.e., before we start processing packets),
            they are logged to stderr.

        (2) During processing, they turn into events:

            event log_message%(msg: string, location: string%);
            event log_warning%(msg: string, location: string%);
            event log_error%(msg: string, location: string%);

            The script level can then handle them as desired.

            If we don't have an event handler, we fall back to
            reporting on stderr.

    - All fatal errors are logged to stderr and Bro terminates
      immediately.

    - Syslog(msg) directly syslogs, but doesn't do anything else.

The three main types of messages can also be generated on the
scripting layer via new Log::* bifs:

    Log::error(msg: string);
    Log::warning(msg: string);
    Log::message(msg: string);

These pass through the bro_logger as well and thus are handled in the
same way. Their output includes location information.

More changes:

    - Removed the alarm statement and the alarm_hook event.

    - Adapted lots of locations to use the bro_logger, including some
      of the messages that were previously either just written to
      stdout, or even funneled through the alarm mechanism.

    - No distinction anymore between Error() and RunTime(). There's
      now only one class of errors; the line was quite blurred already
      anyway.

    - util.h: all the error()/warn()/message()/run_time()/pinpoint()
      functions are gone. Use the bro_logger instead now.

    - Script errors are formatted a bit differently due to the
      changes. What I've seen so far looks ok to me, but let me know
      if there's something odd.

Notes:

    - The default handlers for the new log_* events are just dummy
      implementations for now since we need to integrate all this into
      the new scripts anyway.

    - I'm not too happy with the names of the Logger class and its
      instance bro_logger. We now have a LogMgr as well, which makes
      this all a bit confusing. But I didn't have a good idea for
      better names so I stuck with them for now.

      Perhaps we should merge Logger and LogMgr?
This commit is contained in:
Robin Sommer 2011-06-24 21:33:05 -07:00
parent ff7b92ffc8
commit 93894eed9b
140 changed files with 2453 additions and 1054 deletions
Download patch file Download diff file Expand all files Collapse all files

44
src/main.cc
View file

@ -73,9 +73,7 @@ char* writefile = 0;
name_list prefixes;
DNS_Mgr* dns_mgr;
TimerMgr* timer_mgr;
Logger* bro_logger;
LogMgr* log_mgr;
Func* alarm_hook = 0;
Stmt* stmts;
EventHandlerPtr bro_signal = 0;
EventHandlerPtr net_done = 0;
@ -283,7 +281,6 @@ void terminate_bro()
remote_serializer->LogStats();
delete timer_mgr;
delete bro_logger;
delete dns_mgr;
delete persistence_serializer;
delete event_player;
@ -295,6 +292,7 @@ void terminate_bro()
delete remote_serializer;
delete dpm;
delete log_mgr;
delete bro_logger;
}
void termination_signal()
@ -302,7 +300,7 @@ void termination_signal()
set_processing_status("TERMINATING", "termination_signal");
Val sval(signal_val, TYPE_COUNT);
message("received termination signal");
bro_logger->Message("received termination signal");
net_get_final_stats();
done_with_network();
net_delete();
@ -654,6 +652,7 @@ int main(int argc, char** argv)
set_processing_status("INITIALIZING", "main");
bro_start_time = current_time(true);
bro_logger = new Logger();
init_random_seed(seed, seed_load_file, seed_save_file);
// DEBUG_MSG("HMAC key: %s\n", md5_digest_print(shared_hmac_md5_key));
@ -754,7 +753,7 @@ int main(int argc, char** argv)
return 0;
}
if ( nerr > 0 )
if ( bro_logger->Errors() > 0 )
{
delete dns_mgr;
exit(1);
@ -767,7 +766,7 @@ int main(int argc, char** argv)
ID* id = global_scope()->Lookup("cmd_line_bpf_filter");
if ( ! id )
internal_error("global cmd_line_bpf_filter not defined");
bro_logger->InternalError("global cmd_line_bpf_filter not defined");
id->SetVal(new StringVal(user_pcap_filter));
}
@ -803,11 +802,6 @@ int main(int argc, char** argv)
// ### Add support for debug command file.
dbg_init_debugger(0);
Val* bro_alarm_file = internal_val("bro_alarm_file");
bro_logger = new Logger("bro",
bro_alarm_file ?
bro_alarm_file->AsFile() : new BroFile(stderr));
if ( (flow_files.length() == 0 || read_files.length() == 0) &&
(netflows.length() == 0 || interfaces.length() == 0) )
{
@ -832,15 +826,8 @@ int main(int argc, char** argv)
writefile, "tcp or udp or icmp",
secondary_path->Filter(), do_watchdog);
if ( ! reading_traces )
// Only enable actual syslog'ing for live input.
bro_logger->SetEnabled(enable_syslog);
else
bro_logger->SetEnabled(0);
BroFile::SetDefaultRotation(log_rotate_interval, log_max_size);
alarm_hook = internal_func("alarm_hook");
bro_signal = internal_handler("bro_signal");
net_done = internal_handler("net_done");
@ -861,10 +848,7 @@ int main(int argc, char** argv)
dns_mgr->Resolve();
if ( ! dns_mgr->Save() )
{
bro_logger->Log("**Can't update DNS cache");
exit(1);
}
bro_logger->FatalError("can't update DNS cache");
mgr.Drain();
delete dns_mgr;
@ -906,10 +890,7 @@ int main(int argc, char** argv)
ID* id = global_scope()->Lookup(id_name);
if ( ! id )
{
fprintf(stderr, "No such ID: %s\n", id_name);
exit(1);
}
bro_logger->FatalError("No such ID: %s\n", id_name);
ODesc desc;
desc.SetQuotes(true);
@ -951,9 +932,9 @@ int main(int argc, char** argv)
if ( dead_handlers->length() > 0 && check_for_unused_event_handlers )
{
warn("event handlers never invoked:");
bro_logger->Warning("event handlers never invoked:");
for ( int i = 0; i < dead_handlers->length(); ++i )
warn("\t", (*dead_handlers)[i]);
bro_logger->Warning("\t", (*dead_handlers)[i]);
}
delete dead_handlers;
@ -963,9 +944,9 @@ int main(int argc, char** argv)
if ( alive_handlers->length() > 0 && dump_used_event_handlers )
{
message("invoked event handlers:");
bro_logger->Message("invoked event handlers:");
for ( int i = 0; i < alive_handlers->length(); ++i )
message((*alive_handlers)[i]);
bro_logger->Message((*alive_handlers)[i]);
}
delete alive_handlers;
@ -987,6 +968,8 @@ int main(int argc, char** argv)
dpm->PostScriptInit();
bro_logger->ReportViaEvents(true);
mgr.Drain();
have_pending_timers = ! reading_traces && timer_mgr->Size() > 0;
@ -1007,6 +990,7 @@ int main(int argc, char** argv)
}
#endif
net_run();
done_with_network();
net_delete();