base/bif/reporter.bif.bro

GLOBAL

Reporter

The reporter built-in functions allow for the scripting layer to generate messages of varying severity. If no event handlers exist for reporter messages, the messages are output to stderr. If event handlers do exist, it’s assumed they take care of determining how/where to output the messages.

See base/frameworks/reporter/main.bro for a convenient reporter message logging framework.

Namespaces:GLOBAL, Reporter Source File:/scripts/base/bif/reporter.bif.bro

Summary

Functions

Reporter::conn_weird: function	Generates a “conn” weird.
Reporter::error: function	Generates a non-fatal error indicative of a definite problem that should be addressed.
Reporter::fatal: function	Generates a fatal error on stderr and terminates program execution.
Reporter::flow_weird: function	Generates a “flow” weird.
Reporter::info: function	Generates an informational message.
Reporter::net_weird: function	Generates a “net” weird.
Reporter::warning: function	Generates a message that warns of a potential problem.

Detailed Interface

Functions

Reporter::conn_weird

Type:function (name: string, c: connection, addl: string &default = "" &optional) : bool

Generates a “conn” weird.

Name:the name of the weird. C:the connection associated with the weird. Addl:additional information to accompany the weird. Returns:Always true.

Reporter::error

Type:function (msg: string) : bool

Generates a non-fatal error indicative of a definite problem that should be addressed. Program execution does not terminate.

Msg:The error message to report. Returns:Always true.

See also: reporter_error

Reporter::fatal

Type:function (msg: string) : bool

Generates a fatal error on stderr and terminates program execution.

Msg:The error message to report. Returns:Always true.

Reporter::flow_weird

Type:function (name: string, orig: addr, resp: addr) : bool

Generates a “flow” weird.

Name:the name of the weird. Orig:the originator host associated with the weird. Resp:the responder host associated with the weird. Returns:Always true.

Reporter::info

Type:function (msg: string) : bool

Generates an informational message.

Msg:The informational message to report. Returns:Always true.

See also: reporter_info

Reporter::net_weird

Type:function (name: string) : bool

Generates a “net” weird.

Name:the name of the weird. Returns:Always true.

Reporter::warning

Type:function (msg: string) : bool

Generates a message that warns of a potential problem.

Msg:The warning message to report. Returns:Always true.

See also: reporter_warning