reporter.bif.zeek

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.zeek for a convenient reporter message logging framework.

Namespaces:: GLOBAL, Reporter

Summary

Functions

`Reporter::conn_weird`: `function`	Generates a “conn” weird.
`Reporter::error`: `function`	Generates a usually 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::fatal_error_with_core`: `function`	Generates a fatal error on stderr and terminates program execution after dumping a core file
`Reporter::file_weird`: `function`	Generates a “file” weird.
`Reporter::flow_weird`: `function`	Generates a “flow” weird.
`Reporter::get_weird_sampling_duration`: `function`	Gets the current weird sampling duration.
`Reporter::get_weird_sampling_global_list`: `function`	Gets the weird sampling global list
`Reporter::get_weird_sampling_rate`: `function`	Gets the current weird sampling rate.
`Reporter::get_weird_sampling_threshold`: `function`	Gets the current weird sampling threshold
`Reporter::get_weird_sampling_whitelist`: `function`	Gets the weird sampling whitelist
`Reporter::info`: `function`	Generates an informational message.
`Reporter::net_weird`: `function`	Generates a “net” weird.
`Reporter::set_weird_sampling_duration`: `function`	Sets the current weird sampling duration.
`Reporter::set_weird_sampling_global_list`: `function`	Sets the weird sampling global list
`Reporter::set_weird_sampling_rate`: `function`	Sets the weird sampling rate.
`Reporter::set_weird_sampling_threshold`: `function`	Sets the current weird sampling threshold
`Reporter::set_weird_sampling_whitelist`: `function`	Sets the weird sampling whitelist
`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, source: string &default = "" &optional) : bool

Generates a “conn” weird.

Parameters:

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 usually non-fatal error indicative of a definite problem that should be addressed. Program execution does not terminate unless the error is reported during initialization (e.g., zeek_init).

Parameters:: msg – The error message to report.
Returns:: Always true.