mirror of
https://github.com/zeek/zeek.git
synced 2025-10-07 17:18:20 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
312 lines
10 KiB
ReStructuredText
312 lines
10 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/bif/reporter.bif.zeek
|
|
==========================
|
|
.. zeek:namespace:: GLOBAL
|
|
.. zeek:namespace:: 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 :doc:`/scripts/base/frameworks/reporter/main.zeek` for a convenient
|
|
reporter message logging framework.
|
|
|
|
:Namespaces: GLOBAL, Reporter
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Functions
|
|
#########
|
|
========================================================================== =========================================================================
|
|
:zeek:id:`Reporter::conn_weird`: :zeek:type:`function` Generates a "conn" weird.
|
|
:zeek:id:`Reporter::error`: :zeek:type:`function` Generates a usually non-fatal error indicative of a definite problem that
|
|
should be addressed.
|
|
:zeek:id:`Reporter::fatal`: :zeek:type:`function` Generates a fatal error on stderr and terminates program execution.
|
|
:zeek:id:`Reporter::fatal_error_with_core`: :zeek:type:`function` Generates a fatal error on stderr and terminates program execution
|
|
after dumping a core file
|
|
:zeek:id:`Reporter::file_weird`: :zeek:type:`function` Generates a "file" weird.
|
|
:zeek:id:`Reporter::flow_weird`: :zeek:type:`function` Generates a "flow" weird.
|
|
:zeek:id:`Reporter::get_weird_sampling_duration`: :zeek:type:`function` Gets the current weird sampling duration.
|
|
:zeek:id:`Reporter::get_weird_sampling_global_list`: :zeek:type:`function` Gets the weird sampling global list
|
|
:zeek:id:`Reporter::get_weird_sampling_rate`: :zeek:type:`function` Gets the current weird sampling rate.
|
|
:zeek:id:`Reporter::get_weird_sampling_threshold`: :zeek:type:`function` Gets the current weird sampling threshold
|
|
:zeek:id:`Reporter::get_weird_sampling_whitelist`: :zeek:type:`function` Gets the weird sampling whitelist
|
|
:zeek:id:`Reporter::info`: :zeek:type:`function` Generates an informational message.
|
|
:zeek:id:`Reporter::net_weird`: :zeek:type:`function` Generates a "net" weird.
|
|
:zeek:id:`Reporter::set_weird_sampling_duration`: :zeek:type:`function` Sets the current weird sampling duration.
|
|
:zeek:id:`Reporter::set_weird_sampling_global_list`: :zeek:type:`function` Sets the weird sampling global list
|
|
:zeek:id:`Reporter::set_weird_sampling_rate`: :zeek:type:`function` Sets the weird sampling rate.
|
|
:zeek:id:`Reporter::set_weird_sampling_threshold`: :zeek:type:`function` Sets the current weird sampling threshold
|
|
:zeek:id:`Reporter::set_weird_sampling_whitelist`: :zeek:type:`function` Sets the weird sampling whitelist
|
|
:zeek:id:`Reporter::warning`: :zeek:type:`function` Generates a message that warns of a potential problem.
|
|
========================================================================== =========================================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Functions
|
|
#########
|
|
.. zeek:id:: Reporter::conn_weird
|
|
:source-code: base/bif/reporter.bif.zeek 96 96
|
|
|
|
:Type: :zeek:type:`function` (name: :zeek:type:`string`, c: :zeek:type:`connection`, addl: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`, source: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`) : :zeek:type:`bool`
|
|
|
|
Generates a "conn" weird.
|
|
|
|
|
|
:param name: the name of the weird.
|
|
|
|
|
|
:param c: the connection associated with the weird.
|
|
|
|
|
|
:param addl: additional information to accompany the weird.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::error
|
|
:source-code: base/bif/reporter.bif.zeek 47 47
|
|
|
|
:Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`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:see:`zeek_init`).
|
|
|
|
|
|
:param msg: The error message to report.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:see:: reporter_error
|
|
|
|
.. zeek:id:: Reporter::fatal
|
|
:source-code: base/bif/reporter.bif.zeek 55 55
|
|
|
|
:Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`bool`
|
|
|
|
Generates a fatal error on stderr and terminates program execution.
|
|
|
|
|
|
:param msg: The error message to report.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::fatal_error_with_core
|
|
:source-code: base/bif/reporter.bif.zeek 64 64
|
|
|
|
:Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`bool`
|
|
|
|
Generates a fatal error on stderr and terminates program execution
|
|
after dumping a core file
|
|
|
|
|
|
:param msg: The error message to report.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::file_weird
|
|
:source-code: base/bif/reporter.bif.zeek 108 108
|
|
|
|
:Type: :zeek:type:`function` (name: :zeek:type:`string`, f: :zeek:type:`fa_file`, addl: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`, source: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`) : :zeek:type:`bool`
|
|
|
|
Generates a "file" weird.
|
|
|
|
|
|
:param name: the name of the weird.
|
|
|
|
|
|
:param f: the file associated with the weird.
|
|
|
|
|
|
:param addl: additional information to accompany the weird.
|
|
|
|
|
|
:returns: true if the file was still valid, else false.
|
|
|
|
.. zeek:id:: Reporter::flow_weird
|
|
:source-code: base/bif/reporter.bif.zeek 84 84
|
|
|
|
:Type: :zeek:type:`function` (name: :zeek:type:`string`, orig: :zeek:type:`addr`, resp: :zeek:type:`addr`, addl: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`, source: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`) : :zeek:type:`bool`
|
|
|
|
Generates a "flow" weird.
|
|
|
|
|
|
:param name: the name of the weird.
|
|
|
|
|
|
:param orig: the originator host associated with the weird.
|
|
|
|
|
|
:param resp: the responder host associated with the weird.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::get_weird_sampling_duration
|
|
:source-code: base/bif/reporter.bif.zeek 171 171
|
|
|
|
:Type: :zeek:type:`function` () : :zeek:type:`interval`
|
|
|
|
Gets the current weird sampling duration.
|
|
|
|
|
|
:returns: weird sampling duration.
|
|
|
|
.. zeek:id:: Reporter::get_weird_sampling_global_list
|
|
:source-code: base/bif/reporter.bif.zeek 128 128
|
|
|
|
:Type: :zeek:type:`function` () : :zeek:type:`string_set`
|
|
|
|
Gets the weird sampling global list
|
|
|
|
|
|
:returns: Current weird sampling global list
|
|
|
|
.. zeek:id:: Reporter::get_weird_sampling_rate
|
|
:source-code: base/bif/reporter.bif.zeek 157 157
|
|
|
|
:Type: :zeek:type:`function` () : :zeek:type:`count`
|
|
|
|
Gets the current weird sampling rate.
|
|
|
|
|
|
:returns: weird sampling rate.
|
|
|
|
.. zeek:id:: Reporter::get_weird_sampling_threshold
|
|
:source-code: base/bif/reporter.bif.zeek 142 142
|
|
|
|
:Type: :zeek:type:`function` () : :zeek:type:`count`
|
|
|
|
Gets the current weird sampling threshold
|
|
|
|
|
|
:returns: current weird sampling threshold.
|
|
|
|
.. zeek:id:: Reporter::get_weird_sampling_whitelist
|
|
:source-code: base/bif/reporter.bif.zeek 114 114
|
|
|
|
:Type: :zeek:type:`function` () : :zeek:type:`string_set`
|
|
|
|
Gets the weird sampling whitelist
|
|
|
|
|
|
:returns: Current weird sampling whitelist
|
|
|
|
.. zeek:id:: Reporter::info
|
|
:source-code: base/bif/reporter.bif.zeek 25 25
|
|
|
|
:Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`bool`
|
|
|
|
Generates an informational message.
|
|
|
|
|
|
:param msg: The informational message to report.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:see:: reporter_info
|
|
|
|
.. zeek:id:: Reporter::net_weird
|
|
:source-code: base/bif/reporter.bif.zeek 72 72
|
|
|
|
:Type: :zeek:type:`function` (name: :zeek:type:`string`, addl: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`, source: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`) : :zeek:type:`bool`
|
|
|
|
Generates a "net" weird.
|
|
|
|
|
|
:param name: the name of the weird.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::set_weird_sampling_duration
|
|
:source-code: base/bif/reporter.bif.zeek 180 180
|
|
|
|
:Type: :zeek:type:`function` (weird_sampling_duration: :zeek:type:`interval`) : :zeek:type:`bool`
|
|
|
|
Sets the current weird sampling duration. Please note that
|
|
this will not delete already running timers.
|
|
|
|
|
|
:param weird_sampling_duration: New weird sampling duration.
|
|
|
|
|
|
:returns: always returns True
|
|
|
|
.. zeek:id:: Reporter::set_weird_sampling_global_list
|
|
:source-code: base/bif/reporter.bif.zeek 136 136
|
|
|
|
:Type: :zeek:type:`function` (weird_sampling_global_list: :zeek:type:`string_set`) : :zeek:type:`bool`
|
|
|
|
Sets the weird sampling global list
|
|
|
|
|
|
:param global_list: New weird sampling rate.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::set_weird_sampling_rate
|
|
:source-code: base/bif/reporter.bif.zeek 165 165
|
|
|
|
:Type: :zeek:type:`function` (weird_sampling_rate: :zeek:type:`count`) : :zeek:type:`bool`
|
|
|
|
Sets the weird sampling rate.
|
|
|
|
|
|
:param weird_sampling_rate: New weird sampling rate.
|
|
|
|
|
|
:returns: Always returns true.
|
|
|
|
.. zeek:id:: Reporter::set_weird_sampling_threshold
|
|
:source-code: base/bif/reporter.bif.zeek 150 150
|
|
|
|
:Type: :zeek:type:`function` (weird_sampling_threshold: :zeek:type:`count`) : :zeek:type:`bool`
|
|
|
|
Sets the current weird sampling threshold
|
|
|
|
|
|
:param threshold: New weird sampling threshold.
|
|
|
|
|
|
:returns: Always returns true;
|
|
|
|
.. zeek:id:: Reporter::set_weird_sampling_whitelist
|
|
:source-code: base/bif/reporter.bif.zeek 122 122
|
|
|
|
:Type: :zeek:type:`function` (weird_sampling_whitelist: :zeek:type:`string_set`) : :zeek:type:`bool`
|
|
|
|
Sets the weird sampling whitelist
|
|
|
|
|
|
:param whitelist: New weird sampling rate.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:id:: Reporter::warning
|
|
:source-code: base/bif/reporter.bif.zeek 35 35
|
|
|
|
:Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`bool`
|
|
|
|
Generates a message that warns of a potential problem.
|
|
|
|
|
|
:param msg: The warning message to report.
|
|
|
|
|
|
:returns: Always true.
|
|
|
|
.. zeek:see:: reporter_warning
|
|
|
|
|